Envoyer un mail

/mail/send

Request parameters

{
  "from": "adresse mail de l'expéditeur",
  "to": "adresse(s) du/des destinataire(s) (string | array)",
  "subject": "sujet du mail",
  "content": "Contenu du mail",
  "openConfirmation": true|false,
  "priority": true|false,
  "attachments": [
    "url de la pièce jointes",
    {
      "name": "nom de la pièce jointe",
      "url": "url de la pièce jointes"
    }
  ],
  "event": {
    "title": "titre de l'évènement",
    "description": "description de l'évènement",
    "color": "couleur attachée à l'event",
    "start": "d/m/Y H:i",
    "end": "d/m/Y H:i",
    "allDay": true|false
  }
}

Responses

{
  "icon": "success",
  "text": "Le mail a été envoyé"
}

Détails des champs


Champs	from	to	subject	content	openConfirmation	priority	attachments	event
Type	string	string	string	string	boolean	boolean	array	event_format
Obligatoire	Oui	Oui	Oui	Non	Non	Non	Non	Non

Example :

{
  "from": "aros@xelyos.fr",
  "to": [
    "aros@mail-rp.com"
  ],
  "subject": "Mail from API",
  "content": "<p>Hi, this is the content of the mail!</p>",
  "openConfirmation": true,
  "priority": true,
  "attachments": [
    {
      "name": "Logo Mail RP",
      "url": "https://mail-rp.s3.eu-west-3.amazonaws.com/mail-rp/logo_white.png"
    }
  ],
  "event": {
    "title": "Titre de l'évènement",
    "description": "Description de l'évènement",
    "color": "#f2a922",
    "start": "24/01/2024 16:30",
    "end": "24/02/2024 18:30",
    "allDay": false
  }
}

Format possible pour la clé to

{
  "to": "aros@xelyos.fr"
}

{
  "to": [
    "aros@xelyos.fr",
    "aros@mail-rp.com"
  ]
}

Détails des champs pour l'évènement


Champs	title	description	color	start	end	allDay
Type	string	string	string	d/m/Y H:i	d/m/Y H:i	boolean
Obligatoire	Oui	Non	Non	Oui	Oui	Non

Last modified: 02 juin 2024