POST | Envoyer un mail
DescriptionEnvoyer un mail avec l'API
https://mail-rp.com/api/v1/{api-key}/sendParameters
| 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,
"attachments": [
"url de la pièce jointes",
{
"name": "nom de la pièce jointe",
"url": "url de la pièce jointes"
}
]
}
Détails des champs |
||||||
| Champs | from | to | subject | content | openConfirmation | attachments |
| Type | string | string|array | string | string | boolean | array |
| Obligatoire | Oui | Oui | Oui | 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,
"attachments": [
{
"name": "Logo Mail RP",
"url": "https://mail-rp.s3.eu-west-3.amazonaws.com/mail-rp/logo_white.png"
}
]
}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",
...
]
}
Responses
{
"icon": "success",
"text": "Le mail a été envoyé"
}