Envoi unitaire de mail
Cette requête est utilisée pour envoyer des mails en temps réel ou en différé.
URL
POST
https://api.mailpartner.fr/v1/send
La plateforme n’envoie pas de mails commerciaux entre 20h et 8h en semaine et les dimanches et jours fériés (restriction légale). Si un message mail est envoyé, le message est en pause jusqu’au prochain jour ouvrable à 8h. Vous n’envoyez pas de mails commerciaux ? Contactez nous pour désactiver cette restriction : [email protected]
Paramètres obligatoires
apiKey
subject
Sujet du mail
htmlContent
Contenu du mail en HTML.
Le tag #READ_ONLINE#
ajoute le lien “Si cet e-mail ne s’affiche pas correctement, veuillez utiliser le lien suivant :”
Le tag #UNSUBSCRIBE_LINK#
ajoute le lien de désinscription
From
Adresse email émetteur de l'envoi email: email name (optionnel) : Nom
to
Vous pouvez ajouter jusqu’a 500 destinataires :
email
Email du destinataire
name
(optionnel)
Nom du destinataire
Paramètres optionnels
replyTo
email
name
(optionnel)
Nom
variables
Vous pouvez ajouter jusqu’a 8 variables personnalisées contenant uniquement du texte (pas de html).
Ex:
"variables":{"firstname":"John", "lastname": "Doe"}
Ces variables doivent être ajoutés dans le template ou dans htmlContent de cette manière: #FIRSTNAME# et #LASTNAME#
attachments
3 pièces jointes Maximum. 5Mo par pièce jointe.
base64Content
: Le contenu doit être encodé en Base64. Vous devez également spécifier le type MIME et un nom de fichier.
filename
: Nom de la pièce jointe (sans extension)
contentType
: Type mime de la pièce jointe.
Vous pouvez voir la liste officielle des types MIME ici. Pour le contenu, vous pouvez trouver un encodeur Base64 en ligne – par exemple ici. Une fois le fichier encodé, utilisez la chaîne de caractères résultante comme valeur du contenu Base64Content.
Exemple JSON complet :
{
"attachments": [
{
"base64Content": "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK",
"contentType": "text/plain",
"filename": "test"
}
]
}
tag
Identifiant en minuscule (sans espace) entre 3 et 20 caractères
scheduledDeliveryDate
Date d’envoi du mail, au format dd/mm/YYYY
. A définir uniquement si vous souhaitez que les mails soient envoyés en différé.
time
Heure d’envoi du mail (format 0-24), obligatoire si scheduledDeliveryDate
est défini.
minute
Minute d’envoi du mail (format 0-55, par intervalle de cinq minutes), obligatoire si scheduledDeliveryDate
est défini.
sandbox
1
pour le mode Bac à Sable
_format
json
ou xml
Requête
<?php
// Prepare data for POST request
$jsonParams = "{
"apiKey": "Your API kEY",
"subject": "Sujet de mon email",
"sandbox":0,
"htmlContent": "Mon premier <strong>email</strong>",
"scheduledDeliveryDate":"25/09/2020",
"time":"12",
"minute":"00",
"from": {
"name" :"Marie",
"email": "[email protected]"
},
"to": [
{
"email": "email1"
},
{
"emai": "email2"
}
]
}"
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL,'http://api.mailpartner.fr/v1/send');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 10);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $jsonParams);
$result = curl_exec($curl);
curl_close($curl);
// Process your response here
echo $result;
?>
Réponse
{
"success": true,
"code": 200,
"messageId": "xxx",
"nbMail": 1,
"cost": 1,
"currency": "EUR",
"scheduledDeliveryDate": "2020-09-25 12:00:00"
}
Dernière mise à jour