prspace/mailjet

用于 Laravel 的 Mailjet 驱动程序

v1.0.1 2015-11-20 11:45 UTC

This package is not auto-updated.

Last update: 2024-09-12 00:04:04 UTC


README

此包扩展了 Laravel 4 MailService,以便实现基于 Mailjet API v3 的 Mailjet 集成。

安装

首先,您需要将此包包含在您的 composer.json 文件中。

"require": {
    "prspace/mailjet" : "1.0.*"
}

现在您可以通过 composer 进行更新或安装。

composer update

接下来,打开 app/config/app.php 并将 MailServiceProvider 替换为

'Prspace\Mailjet\MailjetServiceProvider'

注意 替换默认的服务提供者非常重要,以避免冲突。您不会丢失任何关于邮件驱动程序的原始功能,它们仍然可用。

配置很简单:将以下条目添加到您的 config/services.php 中

'mailjet' => [
    'key' => 'APIKEY',
    'secret' => 'APISECRET',
],

并将值替换为您的相应 API 密钥和密钥。

接下来,将您的 config/mail.php 或 .env 文件中的邮件驱动程序更改为 'mailjet',并确保您已配置了有效的授权发件人地址。

这样就全部完成了。关于用法,请参阅 Laravel 4 邮件文档

##API 访问##

我还集成了对 Mailjet API 的直接访问,基于他们的 示例代码

要安装,请将别名添加到 config/app.php 中

'Mailjet'   => 'Prspace\Mailjet\Facades\Mailjet',

示例

基于 https://github.com/mailjet/mailjet-apiv3-php-simple/blob/master/README.md

SendAPI

  • 一个用于发送电子邮件的函数
function sendEmail() {
    $params = [
        "method" => "POST",
        "from" => "ms.mailjet@example.com",
        "to" => "mr.mailjet@example.com",
        "subject" => "Hello World!",
        "text" => "Greetings from Mailjet."
    ];

    $result = Mailjet::sendEmail($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - email sent";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于发送带附件的电子邮件的函数(您的计算机上的绝对路径)
function sendEmailWithAttachments() {
    $params = [
        "method" => "POST",
        "from" => "ms.mailjet@example.com",
        "to" => "mr.mailjet@example.com",
        "subject" => "Hello World!",
        "text" => "Greetings from Mailjet.",
        "attachment" => ["@/path/to/first/file.txt", "@/path/to/second/file.txt"]
    ];

    $result = Mailjet::sendEmail($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - email sent";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于发送带内联附件的电子邮件的函数(您的计算机上的绝对路径)
function sendEmailWithInlineAttachments() {
    
    $params = [
        "method" => "POST",
        "from" => "ms.mailjet@example.com",
        "to" => "mr.mailjet@example.com",
        "subject" => "Hello World!",
        "html" => "<html>Greetings from Mailjet <img src=\"cid:photo1.jpg\"><img src=\"cid:photo2.jpg\"></html>",
    "inlineattachment" => ["@/path/to/photo1.jpg", "@/path/to/photo2.jpg"]
    ];

    $result = Mailjet::sendEmail($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - email sent";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}

账户设置

  • 一个用于获取您的配置文件信息的函数
function viewProfileInfo() {
    
    $result = Mailjet::myprofile();

    if (Mailjet::getResponseCode() == 200)
       echo "success - got profile information";
    else
       echo "error - ".Mailjet::getResponseCode();
}
  • 一个用于更新您的配置文件中 AddressCity 字段的函数
function updateProfileInfo() {
    
    $params = [
        "method" => "PUT",
        "AddressCity" => "New York"
    ];

    $result = Mailjet::myprofile($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - field AddressCity changed";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}

联系人列表

  • 一个用于打印您的联系人列表的函数
function listContacts()
{
    
    $result = Mailjet::contact();

    if (Mailjet::getResponseCode() == 200)
       echo "success - listed contacts";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于使用数组更新 ID 为 $id 的 contactData 资源的函数
function updateContactData($id) {
    
    $data = [
        ['Name' => 'lastname', 'Value' => 'Jet'], 
        ['Name' => 'firstname', 'Value' => 'Mail']
    ];
    $params = [
        'ID' => $id,
        'Data' => $data,
        'method' => 'PUT'
    ];

    $result = Mailjet::contactdata($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - data changed";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于创建名为 $Lname 的列表的函数
function createList($Lname) {
    
    $params = [
        "method" => "POST",
        "Name" => $Lname
    ];

    $result = Mailjet::contactslist($params);

    if (Mailjet::getResponseCode() == 201)
       echo "success - created list ".$Lname;
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于获取 ID 为 $listID 的列表的函数
function getList($listID) {
    
    $params = [
        "method" => "VIEW",
        "ID" => $listID
    ];

    $result = Mailjet::contactslist($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - got list ".$listID;
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}

注意:您可以使用资源的不同字段而不是 ID,例如,在您的 params 数组中使用 "unique" => "test@gmail.com" 来实现此示例

  • 一个用于创建具有电子邮件 $Cemail 的联系人的函数
function createContact($Cemail) {
    
    $params = [
        "method" => "POST",
        "Email" => $Cemail
    ];

    $result = Mailjet::contact($params);

    if (Mailjet::getResponseCode() == 201)
       echo "success - created contact ".$Cname;
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于将 ID 为 $contactID 的联系人添加到 ID 为 $listID 的列表中的函数
function addContactToList($contactID, $listID) {
    
    $params = [
        "method" => "POST",
        "ContactID" => $contactID,
        "ListID" => $listID,
        "IsActive" => "True"
    ];

    $result = Mailjet::listrecipient($params);

    if (Mailjet::getResponseCode() == 201)
       echo "success - contact ".$contactID." added to the list ".$listID;
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于删除 ID 为 $listID 的列表的函数
function deleteList($listID) {
    
    $params = [
        "method" => "DELETE",
        "ID" => $listID
    ];

    $result = Mailjet::contactslist($params);

    if (Mailjet::getResponseCode() == 204)
       echo "success - deleted list";
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}
  • 一个用于获取 ID 为 $listID 的列表中的未订阅联系人(们)的函数
function getUnsubscribedContactsFromList($listID) {
	
	
	$params = [
		"method" => "GET",
		"ContactsList" => $listID,
		"Unsub" => true
	];
	
	$result = Mailjet::listrecipient($params);
	
    if (Mailjet::getResponseCode() == 200)
       echo "success - got unsubscribed contact(s) ";
    else
       echo "error - ".Mailjet::getResponseCode();
   
	return $result;   
}
  • 一个用于获取 ID 为 $contactID 的联系人的函数
function getContact($contactID) {
    
    $params = [
        "method" => "VIEW",
        "ID" => $contactID
    ];

    $result = Mailjet::contact($params);

    if (Mailjet::getResponseCode() == 200)
       echo "success - got contact ".$contactID;
    else
       echo "error - ".Mailjet::getResponseCode();

    return $result;
}

注意:您可以使用资源的不同字段而不是 ID,例如,在您的 params 数组中使用 "unique" => "test@gmail.com" 来实现此示例

新闻通讯

您可以使用 DetailContent 动作来管理新闻通讯的内容,在文本和 Html 中。它有两个属性:Text-partHtml-part。您可以在该动作上使用 GETPOSTPUTDELETE 请求

  • GET:您获取新闻通讯的 Text-partHtml-part 属性
  • POST:更新 Text-partHtml-part 的内容。如果您指定了其中一个,则另一个将被清空
  • PUT:更新 Text-partHtml-part 的内容。您可以指定其中一个,它不会清空另一个
  • DELETE:更新 Text-partHtml-part 的内容,并将它们都清空

以下是对 DetailContentGET 请求的示例

function getNewsletterDetailcontent($newsletter_id) {
    $params = [
        "method" => "GET",
        "ID" => $newsletter_id
    ];

    $result = Mailjet::newsletterDetailContent($params);

    if (Mailjet::getResponseCode() == 200)
        echo "success - got content for the newsletter ". $newsletter_id;
    else
        echo "error - ".Mailjet::getResponseCode();
    
    return $result;
}

使用schedule动作来稍后发送新闻简报。您只需要执行一个POST请求来安排新的发送,并将date属性填充为ISO 8601时间戳格式:http://www.iso.org/iso/home/standards/iso8601.htm 您也可以在这里DELETE一个计划。以下是一个示例:

function scheduleNewsletter($newsletter_id) {
    $params = [
        "method" => "POST",
        "ID" => $newsletter_id,
        "date" => "2014-11-25T10:12:59Z"
    );

    $result = Mailjet::newsletterSchedule($params);

    if (Mailjet::getResponseCode() == 201)
        echo "success - schedule done for the newsletter ". $newsletter_id;
    else
        echo "error - ".Mailjet::getResponseCode();
    
    return $result;
}

要立即发送新闻简报,您有两种选择:

  • 使用时间戳为NOW的新的POST计划。
  • 使用send(只支持POST)对于第二种情况,以下是一个示例:
function sendNewsletter($newsletter_id) {
    
    $params = [
        "method" => "POST",
        "ID" => $newsletter_id
    ];

    $result = Mailjet::newsletterSend($params);

    if (Mailjet::getResponseCode() == 201)
        echo "success - newsletter ". $newsletter_id . " has been sent";
    else
        echo "error - ".Mailjet::getResponseCode();
    
    return $result;
}

在真正发送之前,您还可以通过将新闻简报发送到一些指定的收件人来测试它。为此,您需要对带有test动作的新闻简报执行一个POST请求,如下面的示例所示:

function testNewsletter($newsletter_id) {
    
    $recipients = [
        ['Email' => 'mailjet@example.org', 'Name' => 'Mailjet']
    ];
    $params = [
        "method" => "POST",
        "ID" => $newsletter_id,
        "Recipients" => $recipients
    ];

    $result = Mailjet::newsletterTest($params);

    if (Mailjet::getResponseCode() == 201)
        echo "success - newsletter ". $newsletter_id . " has been sent";
    else
        echo "error - ".Mailjet::getResponseCode();
    
    return $result;
}