Unoficial wrapper for Mailjet API

Rust wrapper for Mailjet's API

Mailjet is a service provider for sending emails and SMS, visit https://www.mailjet.com/ for more information.

WARNING: This wrapper is not official, Mailjet won't provide any support for it.

Getting Started

The first step is to instantiate a Mailjet structure with your API keys:

use mailjet_api_wrapper::Mailjet;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");

Now, each route in the API correspond to a function in your mailjet object, for example with message route:

use mailjet_api_wrapper::Mailjet;
use mailjet_api_wrapper::requests::MessageRequest;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");
let res = mailjet.message(&MessageRequest::default()).unwrap_or_default();

Those functions have an explicit name, you'll find them easily in the complete documentation or directly in your IDE. In the case of multiple routes having the same name, the functions will be prefixed by an action verb like _create or _update.

Simple routes

Those routes only have a few variables in the url and have no parameters, they appear in the API reference like /message/{message_ID}. In this case, the function name will be suffixed by _from_*.

use mailjet_api_wrapper::Mailjet;
use mailjet_api_wrapper::requests::MessageRequest;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");
let res = mailjet.message_from_id(123456789).unwrap_or_default();

Complex routes

Those routes have parameters to append at the end of the URL or a JSON body like /message or /send. In this case, you need to build a request object before passing it to the function. You can find them in the requests module.

use mailjet_api_wrapper::Mailjet;
use mailjet_api_wrapper::requests::MessageInformationRequest;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");

let request = MessageInformationRequest {
    campaign_id: Some(544678796), // Corresponds to parameter CampaignID
    ..Default::default()
};

let res = mailjet.message_information(&request).unwrap_or_default();

Hybrid routes

Those routes have both a URL variable and a body/URL parameters like /contact (PUT), in this case, the function takes 2+ arguments, the first ones are the URL variables and the last one, the request object

use mailjet_api_wrapper::Mailjet;
use mailjet_api_wrapper::requests::ContactRequest;
use mailjet_api_wrapper::data::ContactIdentifier;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");

let request = ContactRequest {
    name: Some("New Name".to_string()), // Corresponds to parameter CampaignID
    ..Default::default()
};

let response = mailjet
    .contact_update(
        &ContactIdentifier::ContactEmail("passenger1@mailjet.com".to_string()),
        &request,
    )
    .unwrap_or_default();

Response

Every route returning a JSON will build a response object. You can find them in the responses module.

use mailjet_api_wrapper::Mailjet;
use mailjet_api_wrapper::requests::MessageRequest;

let mailjet = Mailjet::from_api_keys("your_api_key", "your_api_secret");
let res = mailjet.message(&MessageRequest::default()).unwrap_or_default();
let obj = res.object.unwrap_or_default();

let count = obj.count; // Corresponds to Count response field
let data = obj.data; // Corresponds to Data response field

The data structures

The request and response structures are the same as mailjet's JSONs and parameters' names with PascalCase field names converted into snake_case format as asked by rust. Every JSON request and response is serializable/deserializable with serde, so you can easily build objects with JSON formats with serde_json.

For complete information on JSON structures and parameters, go read https://dev.mailjet.com/email/reference/

Example: send a basic email

use mailjet_api_wrapper::{
    data::{EmailAddress, Message},
    requests::SendRequest,
    Mailjet,
};

// Create mailjet client
let mailjet = Mailjet::from_api_keys("your_key", "your_secret");

// Create recipients
let to = EmailAddress::from_email("passenger1@mailjet.com");
let from = EmailAddress::from_email_and_name("pilot@mailjet.com", "Mailjet Pilot");

// Create message
let mut message = Message::default();
message.to.push(to);
message.from = from;
message.html_part = "<h3>Dear passenger 1, welcome to <a href=\"https://www.mailjet.com/\">Mailjet</a>!</h3><br />May the delivery force be with you!".to_string();
message.text_part = "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!".to_string();
message.subject = "Your email flight plan!".to_string();

// Create send request
let mut send_request = SendRequest::default();
send_request.sandbox_mode = Some(true); // You can remove this when sending for real
send_request.messages.push(message);

// Send emails
let response = mailjet.send(&send_request).unwrap_or_default();

Features