Single Email Send

This request is used to send emails in real time or scheduled.

URL

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

The platform does not send commercial emails between 8 PM and 8 AM on weekdays and on Sundays and public holidays (legal restriction). If a commercial email is sent, the message is paused until the next working day at 8 AM. Not sending commercial emails? Contact us to disable this restriction: [e-mail]

Required Parameters

Name	Value
apiKey	Your API key
subject	Email subject
htmlContent	HTML content of the email. The #READ_ONLINE# tag adds the link "If this email does not display correctly, please use the following link:" The #UNSUBSCRIBE_LINK# tag adds the unsubscribe link
From	Sender email address of the send email: email name (optional): Name
to	You can add up to 500 recipients:

email	Recipient's email
name (optional)	Recipient's name

Optional Parameters

Name	Value
replyTo
variables	You can add up to 8 custom variables containing text only (no HTML). Ex: "variables":{"firstname":"John", "lastname": "Doe"}These variables must be added in the template or in htmlContent like this: #FIRSTNAME# and #LASTNAME#
attachments	3 attachments maximum. 5MB per attachment. base64Content: The content must be Base64-encoded. You must also specify the MIME type and a file name. filename: Attachment name (without extension) contentType : MIME type of the attachment. You can see the official list of MIME types here. For the content, you can find an online Base64 encoder – for example here. Once the file is encoded, use the resulting string as the value of Base64Content. Full JSON example: { "attachments": [ { "base64Content": "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK", "contentType": "text/plain", "filename": "test" } ] }
tag	Lowercase identifier (no spaces) between 3 and 20 characters
scheduledDeliveryDate	Scheduled send date of the email, in dd/mm/YYYY format. Only set this if you want the emails to be sent later.
time	Send time of the email (0-24 format), required if scheduledDeliveryDate is set.
minute	Send minute of the email (0-55 format, in five-minute intervals), required if scheduledDeliveryDate is set.
sandbox	1 for Sandbox mode No email will be sent, and there will be no charge on your account. These emails are automatically removed from your sending lists every day.
_format	json or xml

email	Email
name (optional)	Name

Request

PHP

<?php
        // Prepare data for POST request
        $jsonParams = "{
       "apiKey": "Your API kEY",
       "subject": "My email's subject",
       "sandbox":0,
       "htmlContent": "My first <strong>email</strong>",
       "scheduledDeliveryDate":"25/09/2020",
       "time":"12",
       "minute":"00",
       "from": {
          "name" :"Marie",
          "email": "[e-mail]"    
       },
       "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;
?>

Response

json

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