Envoyer des mails

Cette requête est utilisée pour envoyer des mails en temps réel ou en différé.

URL

POST http://api.mailpartner.fr/v1/send

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

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 : help@mailpartner.fr

apiKey Clé API de votre compte. Vous l’obtenez dans votre compte Mail Partner.

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

Vous pouvez ajouter jusqu’a 500 destinataires

email	Email du destinataire
name (optionnel)	Nom du destinataire

Paramètres optionnels

replyTo

email	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 `"attachments": [{ "base64Content":"VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK", "contentType":"text/plain", "filename":"test" }]`
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.

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

Pour tester l’envoi de mail, vous pouvez utiliser le paramètre sandbox:

1 pour activer le mode bac à sable

Aucun mail ne sera envoyé, et il n’y aura aucun débit sur votre compte.
Ces mails seront supprimés de vos listes d’envois automatiquement tous les jours.

_format Format de la réponse. Vous pouvez choisir entre JSON ou XML. Par défaut, le format de réponse est JSON.

Requête

Exemple de requête :

- PHP

<?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",
       "params": 
        {
         "to": [
         {
          "email": "email1", "name":"email1"
         },
         {
          "email": "email2", "name":"email2"
         },
         {
          "email": "email3"
         }
        ]
       }
       }"
 
        $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;
?>

<?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",

"params":

{

"to": [

{

"email": "email1", "name":"email1"

{

"email": "email2", "name":"email2"

{

"email": "email3"

}

]

}

$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;

Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.mailpartner.fr/v1/"
    Dim apiKey As String = "VOTRE_APIKEY"
 
    #send sms
    url = base_url & "send"
    #note : utiliser une librairie JSON en production, par exemple :
    #https//www.nuget.org/packages/Newtonsoft.Json/
    Dim parameters As String = String.Format(
        "{{""apiKey"":""{0}"",""phoneNumbers"":""{1}"",""message"":""{2}""}}",
        apiKey,
        "+33XXXXXXXXX",
        "message de test")
    Console.Write(parameters)
    apiRequest("POST", url, parameters)
 
  End Sub
 
  Function apiRequest(method As String, url As String, parameters As String) As String
 
    Dim request As HttpWebRequest
    request = WebRequest.Create(url)
    request.Method = method
    request.Timeout = 10000   # timeout in ms
    request.ContentType = "application/json; charset=utf-8"
    request.ContentLength = 0
 
    #set POST data
    If Not String.IsNullOrEmpty(parameters) Then
      request.ContentLength = parameters.Length
      Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())
        reqStream.Write(parameters)
      End Using
    End If
 
    #get response
    Dim returnValue As String = Nothing
    Using response As HttpWebResponse = request.GetResponse()
      If response.StatusCode = HttpStatusCode.OK Then
        Using resStream = response.GetResponseStream()
          If resStream IsNot Nothing Then
            Using reader As New StreamReader(resStream)
              returnValue = reader.ReadToEnd()
            End Using
          End If
        End Using
      End If
    End Using
    apiRequest = returnValue
 
  End Function
 
End Module

Imports System.IO

Imports System.Net

Module Module1

Sub Main()

Dim base_url As String = "http://api.mailpartner.fr/v1/"

Dim apiKey As String = "VOTRE_APIKEY"

#send sms

url = base_url & "send"

#note : utiliser une librairie JSON en production, par exemple :

#https//www.nuget.org/packages/Newtonsoft.Json/

Dim parameters As String = String.Format(

"{{""apiKey"":""{0}"",""phoneNumbers"":""{1}"",""message"":""{2}""}}",

apiKey,

"+33XXXXXXXXX",

"message de test")

Console.Write(parameters)

apiRequest("POST", url, parameters)

End Sub

Function apiRequest(method As String, url As String, parameters As String) As String

Dim request As HttpWebRequest

request = WebRequest.Create(url)

request.Method = method

request.Timeout = 10000 # timeout in ms

request.ContentType = "application/json; charset=utf-8"

request.ContentLength = 0

#set POST data

If Not String.IsNullOrEmpty(parameters) Then

request.ContentLength = parameters.Length

Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())

reqStream.Write(parameters)

End Using

End If

#get response

Dim returnValue As String = Nothing

Using response As HttpWebResponse = request.GetResponse()

If response.StatusCode = HttpStatusCode.OK Then

Using resStream = response.GetResponseStream()

If resStream IsNot Nothing Then

Using reader As New StreamReader(resStream)

returnValue = reader.ReadToEnd()

End Using

End If

End Using

End If

End Using

apiRequest = returnValue

End Function

End Module

# std
import logging
import json
from collections import OrderedDict
 
# 3p
import requests
 
API_KEY = "MY API KEY"
URL = "http://api.mailpartner.fr/v1"
 
class SMSPartner():
    def send_sms(self,phone_numbers, msg, sender = "SMSPartner"):
		#sender = "DEMOSMS"
		print(phone_numbers)
 
		data = OrderedDict([
			("apiKey", API_KEY),
			("phoneNumbers", phone_numbers),
			("message", msg),
			("sender", sender)
		])
 
		url = URL + "/send"
		r = requests.post(url, data=json.dumps(data), verify=False)
 
		r_json = r.json()
		if r_json.get("success") == True:
			print(r_json)
			status = True
		else:
			print("SMS msg {} not delivered to {}".format(msg, phone_numbers))
			status = False
		return status

# std

import logging

import json

from collections import OrderedDict

# 3p

import requests

API_KEY = "MY API KEY"

URL = "http://api.mailpartner.fr/v1"

class SMSPartner():

def send_sms(self,phone_numbers, msg, sender = "SMSPartner"):

#sender = "DEMOSMS"

print(phone_numbers)

data = OrderedDict([

("apiKey", API_KEY),

("phoneNumbers", phone_numbers),

("message", msg),

("sender", sender)

])

url = URL + "/send"

r = requests.post(url, data=json.dumps(data), verify=False)

r_json = r.json()

if r_json.get("success") == True:

print(r_json)

status = True

else:

print("SMS msg {} not delivered to {}".format(msg, phone_numbers))

status = False

return status

curl -H  "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","message":"test","sender":"mycompany"}' https://api.smspartner.fr/v1/send

1	curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","message":"test","sender":"mycompany"}' https://api.smspartner.fr/v1/send

Réponses

- JSON

{
    "success": true,
    "code": 200,
    "messageId": "xxx",
    "nbMail": 1,
    "cost": 1,
    "currency": "EUR",
    "scheduledDeliveryDate": "2020-09-25 12:00:00"
}

{

"success": true,

"code": 200,

"messageId": "xxx",

"nbMail": 1,

"cost": 1,

"currency": "EUR",

"scheduledDeliveryDate": "2020-09-25 12:00:00"

}

<?xml version='1.0' encoding='UTF-8'?>
<result>
  <entry>true</entry>
  <entry>200</entry>
  <entry>306</entry>
  <entry>1</entry>
  <entry>0.038</entry>
  <entry>
        <![CDATA[EUR]]>
  </entry>
</result>

<?xml version='1.0' encoding='UTF-8'?>

<entry>

<![CDATA[EUR]]>

</entry>

</result>

Envoi unitaire de mail

Envoyer des mails

URL

POST http://api.mailpartner.fr/v1/send

Paramètres

Requête

Réponses