Skip to main content

POST | Envoyer un mail

Envoyer un mail avec l'API

https://mail-rp.com/api/v1/{api-key}/send
Parameters
Nom Description
api-key Valeur de votre clé API

Request Body
{
  "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
  }
}
Détails des champs
Champs from to subject content openConfirmation priority attachments event
Type string string|array string string boolean boolean array event_format
Obligatoire Oui Oui Oui Non Non Non Non Non
Exemple 
{
  "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
  }
}

Exemple des formats :

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

 

Champ : attachments 
{
    "attachments": ["url de la pièce jointe", "url de la pièce jointe"]
}
{
    "attachments": [
        {
            "name": "nom de la pièce jointe",
            "url": "url de la pièce jointe"
        },
        {
            "name": "nom de la pièce jointe",
            "url": "url de la pièce jointe"
        }
    ]
}
{
    "attachments": [
        {
            "name": "nom de la pièce jointe",
            "url": "url de la pièce jointe"
        },
        "url de la pièce jointe",
        ...
    ]
}

 

Format de l'évènement :

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
Responses
{
	"icon": "success",
	"text": "Le mail a été envoyé"
}


Back to top