Sending Emails with Mailjet

Python |Java |Node.js |Go |Ruby |PHP |.NET

Mailjet is a third-party global email service that offers App Engine users a free tier with 25,000 emails each month. In addition, Mailjet also offers:

• European data privacy compliance.
• Email and deliverability features such as customizable priority settings and automated throttle management.
• A comprehensive API resource library in Go, PHP, Nodejs, Java, Python, Ruby to manage sub-accounts, authentication, contacts, campaigns, custom payloads, statistics, real time events and parsing through the Event API.
• 24/7 follow-the-sun support in 4+ languages.
• Ability to send emails from domains other than gmail.com.

Note: Mailjet is a third-party company whose services are not covered by the Google App Engine Service Level Agreement.

Before you begin

Before you send mail with Mailjet:

1. Create a Mailjet account. As an App Engine developer, you can start with 25,000 free emails per month.

2. In Mailjet, add and verify the sender email address.

3. Note your API key and secret from your Mailjet SMTP Settings.

4. Select or create a new GCP project in the Google Cloud Platform Console and then ensure an App Engine application exists and billing is enabled:

   Go to App Engine

   The Dashboard opens if an App Engine application already exists in your project and billing is enabled. Otherwise, follow the prompts for choosing a region and enabling billing.

5. Add your MailJet API key and secret as environment variables to your app.yaml file.

   1. Add the required jersey REST client modules to your application. For example, if you use Maven, add to the project's pom.xml:

      flexible/mailjet/pom.xml

      View on GitHub

      <dependency>
        <groupId>com.mailjet</groupId>
        <artifactId>mailjet-client</artifactId>
        <version>${mailjet-version}</version>
      </dependency>

   2. Configure your Mailjet settings, such as the API key and domain name in your app.yaml file:

      flexible/mailjet/src/main/appengine/app.yaml

      View on GitHub

      env_variables:
        MAILJET_API_KEY: YOUR-MAILJET-API-KEY
        MAILJET_SECRET_KEY: YOUR-MAILJET-SECRET-KEY

   3. Import the Mailjet library in your application code:

      flexible/mailjet/src/main/java/com/example/mailjet/MailjetServlet.java

      View on GitHub

      package com.example.mailjet;
      
      import com.mailjet.client.ClientOptions;
      import com.mailjet.client.MailjetClient;
      import com.mailjet.client.MailjetRequest;
      import com.mailjet.client.MailjetResponse;
      import com.mailjet.client.errors.MailjetException;
      import com.mailjet.client.errors.MailjetSocketTimeoutException;
      import com.mailjet.client.resource.Emailv31;
      import java.io.IOException;
      import javax.servlet.ServletException;
      import javax.servlet.annotation.WebServlet;
      import javax.servlet.http.HttpServlet;
      import javax.servlet.http.HttpServletRequest;
      import javax.servlet.http.HttpServletResponse;
      import org.json.JSONArray;
      import org.json.JSONObject;
      

   Sending mail

   To send a message in your application code:

   1. Create a new Mailjet client.

   2. Specify the details and contents of the message, including the sender email and name, subject, message body, and recipients.

   3. Retrieve the server response to check the message status.

   For example:

   flexible/mailjet/src/main/java/com/example/mailjet/MailjetServlet.java

   View on GitHub

   @SuppressWarnings("serial")
   @WebServlet(name = "mailjet", value = "/send/email")
   public class MailjetServlet extends HttpServlet {
     private static final String MAILJET_API_KEY = System.getenv("MAILJET_API_KEY");
     private static final String MAILJET_SECRET_KEY = System.getenv("MAILJET_SECRET_KEY");
     private MailjetClient client =
         new MailjetClient(MAILJET_API_KEY, MAILJET_SECRET_KEY, new ClientOptions("v3.1"));
   
     @Override
     public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException,
         ServletException {
       String recipient = req.getParameter("to");
       String sender = req.getParameter("from");
   
       MailjetRequest email = new MailjetRequest(Emailv31.resource)
           .property(Emailv31.MESSAGES, new JSONArray()
           .put(new JSONObject()
             .put(Emailv31.Message.FROM, new JSONObject()
               .put("Email", sender)
               .put("Name", "Mailjet Pilot"))
             .put(Emailv31.Message.TO, new JSONArray()
               .put(new JSONObject()
                 .put("Email", recipient)))
             .put(Emailv31.Message.SUBJECT, "Your email flight plan!")
             .put(Emailv31.Message.TEXTPART,
                 "Dear passenger, welcome to Mailjet! May the delivery force be with you!")
             .put(Emailv31.Message.HTMLPART,
                 "<h3>Dear passenger, welcome to Mailjet!</h3><br />"
                     + "May the delivery force be with you!")));
   
       try {
         // trigger the API call
         MailjetResponse response = client.post(email);
         // Read the response data and status
         resp.getWriter().print(response.getStatus());
         resp.getWriter().print(response.getData());
       } catch (MailjetException e) {
         throw new ServletException("Mailjet Exception", e);
       } catch (MailjetSocketTimeoutException e) {
         throw new ServletException("Mailjet socket timed out", e);
       }
     }
   }

   Statistics

   The response payload of a Mailjet Send API call provides a MessageID. You can use the MessageID to access information and statistics about the message.

   Use the GET operation on /message to get basic information about a message such as the sender, recipient, and message size. To learn more about message statistics, including sample API responses, refer to the Mailjet API guide.

   Event API

   The Mailjet Event API offers real-time notification through HTTP requests (webhooks) on any events related to the messages you sent, such as when messages are sent or opened. This event notification works for all kind of messages, from transactional to marketing campaigns.

   Use the Event API to achieve specific actions efficiently, such as logging the marketing messages sent to your customers, or updating the unsubscribed contacts in your customer relationship management (CRM) system. Instead of polling the Mailjet API a few times a day, data is pushed as events happen, in near real-time.

   You can also group events together, which is useful when sending larger volumes. For further instructions, see the Mailjet documentation.

   Parse API for inbound emails

   You can also receive and parse emails with Mailjet and have the content delivered to a webhook. Mailjet organizes all the information so you can save it to your CRM or database.

   Like the Event API, the Parse API notifies in near real-time to a defined webhook that sends data back to your application when a new message matches a predefined route. Emails are sent to your application structured as a JSON packet with all the useful information you need, such as the sender, recipient, subject, body and headers.

   For more information, including additional fields sent with every email, and instructions for DNS setup and usage, see Mailjet’s Parse API documentation.