README

Mailjet API 客户端，兼容旧版 PHP 5.3。Mailjet

请查看官方文档中的所有资源和所有 PHP 代码示例：Maijlet Documentation

要求

PHP >= 5.3

安装

composer require AMOSoft/mailjet-apiv3-php

入门 !

抓取并保存您的 Mailjet API 凭据。它将通过 getenv 函数在您的代码中创建一些变量。

export MJ_APIKEY_PUBLIC='your api key'
export MJ_APIKEY_PRIVATE='your api secret'

初始化您的 Mailjet 客户端

<?php

use \Mailjet\Resources;

// getenv will allow us to get the MJ_APIKEY_PUBLIC/PRIVATE variables we created before
$apikey = getenv('MJ_APIKEY_PUBLIC');
$apisecret = getenv('MJ_APIKEY_PRIVATE');

// or

$apikey = 'my api key';
$apisecret = 'my api secrret';

$mj = new \Mailjet\Client($apikey, $apisecret);
?>

只需 1、2、3 步！

进行第一次调用

<?php
require 'vendor/autoload.php';

use \Mailjet\Resources;

// use your saved credentials
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));

// Resources are all located in the Resources class
$response = $mj->get(Resources::$Contact);

/*
  Read the response
*/
if ($response->success())
  var_dump($response->getData());
else
  var_dump($response->getStatus());

过滤资源

Mailjet API 提供了一组通用过滤器，可以应用于每个资源的 GET 请求。除了这些通用过滤器之外，每个 API 资源都有自己的过滤器，可以在执行 GET 时使用。

<?php

$filters = ['Limit' => '150'];

$response = $mj->get(Resources::$Contact, ['filters' => $filters]);

发送事务性电子邮件

<?php

$body = [
    '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"]]
];

$response = $mj->post(Resources::$Email, ['body' => $body]);

发送营销活动

要发送第一份新闻简报，您需要在“发送者域名和地址”部分至少有一个活动的发送者地址。

<?php

$body = [
    'Recipients' => [
        [
            'Email' => "mailjet@example.org",
            'Name' => "Mailjet"
        ]
    ]
];

$response = $mj->post(Resources::$NewsletterTest, ['id' => $id, 'body' => $body]);

?>

事件 API - 实时通知

事件 API 通过 http 请求实时通知与您发送的消息相关的任何事件。主要支持的事件包括打开、点击、退订、垃圾邮件、阻止、取消订阅和发送。此事件通知适用于事务性和营销电子邮件。

端点是我们的服务器将调用以处理每个事件的 URL（可能导致大量请求！）。您可以使用 API 通过 /eventcallbackurl 资源设置新端点。或者，您可以在账户偏好设置中的事件跟踪部分配置此设置。

<?php

$body = [
    'EventType' => "open",
    'Url' => "https://mydomain.com/event_handler"
];

$response = $mj->post(Resources::$Eventcallbackurl, ['body' => $body]);

统计信息

Mailjet API 提供资源来提取您发送的每条消息的信息。您还可以通过消息统计信息进行筛选，以查看您的消息的特定指标。

<?php

$response = $mj->get(Resources::$Message, ['id' => $id]);

解析 API - 入站电子邮件

解析 API 允许您将入站电子邮件解析并将其内容发送到您选择的 webhook。要开始接收 webhook 的电子邮件，请通过在 /parseroute 资源上执行 POST 请求创建解析 API 的新实例。

<?php

$body = [
    'Url' => 'https://www.mydomain.com/mj_parse.php'
];

$response = $mj->post(Resources::$Parseroute, ['body' => $body]);

发送拉取请求

• 分支项目。
• 创建主题分支。
• 实现您的功能或错误修复。
• 为您的功能或错误修复添加文档。
• 为您的功能或错误修复添加规范。
• 提交更改并推送。
• 提交拉取请求。请勿包含对 gemspec 或版本文件的更改。