Mailjet API 的非官方封装器

Rust 对 Mailjet API 的封装

Mailjet 是一家提供发送电子邮件和短信服务的提供商，有关更多信息，请访问 https://www.mailjet.com/。

警告：此封装器不是官方的，Mailjet 不会提供任何支持。

入门

第一步是使用您的 API 密钥实例化一个 Mailjet 结构。

use mailjet_api_wrapper::Mailjet;

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

现在，API 中的每个路由都对应于您的 mailjet 对象中的一个函数，例如使用 message 路由。

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();

这些函数具有显式的名称，您可以在完整文档或直接在您的 IDE 中轻松找到它们。在多个路由具有相同名称的情况下，函数将使用动词作为前缀，如 _create 或 _update。

简单路由

这些路由在 URL 中只有几个变量，没有参数，在 API 参考中看起来像 /message/{message_ID}。在这种情况下，函数名将以 _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();

复杂路由

这些路由在 URL 末尾附加参数或具有 JSON 主体（例如 /message 或 /send）。在这种情况下，您需要在将请求对象传递给函数之前构建请求对象。您可以在 requests 模块中找到它们。

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();

混合路由

这些路由同时具有 URL 变量和 URL 参数或主体（例如 /contact（PUT）），在这种情况下，函数接受 2+ 个参数，前一个是 URL 变量，最后一个参数是请求对象。

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("[email protected]".to_string()),
        &request,
    )
    .unwrap_or_default();

响应

每个返回 JSON 的路由都会构建一个响应对象。您可以在 responses 模块中找到它们。

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

数据结构

请求和响应结构与 Mailjet 的 JSONs 相同，并且参数名称已从 PascalCase 字段名称转换为 rust 所要求的 snake_case 格式。每个 JSON 请求和响应都可以使用 serde 序列化和反序列化，因此您可以使用 serde_json 轻松构建具有 JSON 格式的对象。

有关 JSON 结构和参数的完整信息，请阅读 https://dev.mailjet.com/email/reference/。

示例：发送基本电子邮件

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("[email protected]");
let from = EmailAddress::from_email_and_name("[email protected]", "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();

特性