Messages Calls

This is a key part of both APIs, since it is from here that you will be able to trigger transactional email. The key Mailjet API resources in that section are /send/message and /message.

Mailjet's Send API allows you to send transactional emails using our HTTP API, using POST requests. This solution is aimed at users needing a programmatically way to send messages.

Send API allows you to send single messages but also to mutualise the calls by leveraging templating and personalization of the content.

The API will return a simple response indicating if the message is ready to be processed by the Mailjet system. This makes the error management on your side simple and efficient.

Our Send API offers templating features, similar to the Mandrill one. Please refer to our dedicated API guide here.

from mailjet import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
	'FromEmail': 'pilot@mailjet.com',
	'FromName': 'Mailjet Pilot',
	'Subject': 'Your email flight plan!',
	'Text-part': 'Dear passenger, welcome to Mailjet! May the delivery force be with you!',
	'Html-part': '<h3>Dear passenger, welcome to Mailjet!</h3><br />May the delivery force be with you!',
	'Recipients': [{'Email':'passenger@mailjet.com'}]
}
result = mailjet.send.create(data=data)
print result.status_code
print result.json()

{
  "Sent": [
    {
      "Email": "passenger@mailjet.com",
      "MessageID": 111111111111111
    }
  ]
}

Here are the Mailjet Send API properties definitions, along with samples in all the languages we support through our official libraries.

package MyClass;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetClient;
import com.mailjet.client.errors.MailjetRequest;
import com.mailjet.client.errors.MailjetResponse;
import com.mailjet.client.resource.Email;
public class MyClass {
    /**
     * This calls sends an email to one recipient.
     */
    public static void main(String[] args) throws MailjetException {
      MailjetClient client;
      MailjetRequest request;
      MailjetResponse response;
      client = new MailjetClient("api key", "api secret");
      request = new MailjetRequest(Email.resource)
						.property(Email.FROMEMAIL, "pilot@mailjet.com")
						.property(Email.FROMNAME, "Mailjet Pilot")
						.property(Email.MJTEMPLATEID, 1)
						.property(Email.MJTEMPLATELANGUAGE, true)
						.property(Email.SUBJECT, "Your email flight plan!")
						.property(Email.RECIPIENTS, new JSONArray()
                .put(new JSONObject()
                    .put("Email", "passenger@mailjet.com")))
						.property(Email.MJEVENTPAYLOAD, "Eticket,1234,row,15,seat,B");
      response = client.post(request);
      System.out.println(response.getStatus());
      System.out.println(response.getData());
    }
}

{
  "Sent": [
    {
      "Email": "passenger@mailjet.com",
      "MessageID": 111111111111111
    }
  ]
}

First, please visit our Templates dedicated section to learn how to create and store templates with the Mailjet API.

Use the Mj-TemplateID property in your Send API payload to specify the ID of the the template you created.

You must set the Mj-TemplateLanguage property in the payload at true to have the templating language interpreted.

Mailjet offers a templating language to customize the content of your messages, based on conditions and loops. Please visit our dedicated API guide section to learn more.

The response payload of a Send API call will provide you with the MessageID of your messages. You can use this MessageID to access information and statistics about the message.

<?php
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$response = $mj->get(Resources::$Message, ['id' => $id]);
$response->success() && var_dump($response->getData());
?>

{
  "Count": 1,
  "Data": [
    {
      "ArrivedAt": "2015-07-06T07:10:24Z",
      "AttachmentCount": "0",
      "AttemptCount": "0",
      "CampaignID": "51",
      "ContactID": "45",
      "Delay": "0",
      "DestinationID": "14",
      "FilterTime": "61",
      "FromID": "1",
      "ID": "16888509234525280",
      "IsClickTracked": "false",
      "IsHTMLPartIncluded": "false",
      "IsOpenTracked": "false",
      "IsTextPartIncluded": "false",
      "IsUnsubTracked": "false",
      "MessageSize": "20248",
      "SpamassassinScore": "0",
      "SpamassRules": "",
      "StateID": "0",
      "StatePermanent": "false",
      "Status": "sent"
    }
  ],
  "Total": 1
}

Perform a GET on [/message](/docs/api-reference/email-api/categories/messages/) to get basic information about a message, such as the contact it was sent to, who it was sent by, if there were any attachments and how large the message was.

The StateID property shows the current status the messages are in.

Leveraging the FromTs and ToTs query filters of the message API resource, you can find messages matching the period. These filters expect UNIX epoch timestamp.

You can find all the messages associated to a given custom ID (limited to 1 per message at the moment) through the CustomID query filter of the messagesentstatistics resource.

You can filter all the messages sent from a given domain using the FromID query filter of the messagesentstatistics resource. The ID refers to a valid sender resource

<?php
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$response = $mj->get(Resources::$Message, ['id' => $id]);
$response->success() && var_dump($response->getData());
?>

{
  "Count": 1,
  "Data": [
    {
      "ArrivedAt": "2015-07-06T07:10:24Z",
      "AttachmentCount": "0",
      "AttemptCount": "0",
      "CampaignID": "51",
      "ContactID": "45",
      "Delay": "0",
      "DestinationID": "14",
      "FilterTime": "61",
      "FromID": "1",
      "ID": "16888509234525280",
      "IsClickTracked": "false",
      "IsHTMLPartIncluded": "false",
      "IsOpenTracked": "false",
      "IsTextPartIncluded": "false",
      "IsUnsubTracked": "false",
      "MessageSize": "20248",
      "SpamassassinScore": "0",
      "SpamassRules": "",
      "StateID": "0",
      "StatePermanent": "false",
      "Status": "sent"
    }
  ],
  "Total": 1
}

Issue a GET request to message containing the ID which was returned by our Send API