thedoctor0/laravel-mailjet-driver

用于Mailjet的Laravel邮件驱动包及其API的封装器

2.0.2 2024-03-02 09:21 UTC

This package is auto-updated.

Last update: 2024-09-12 08:26:01 UTC


README

Build Status Packagist Packagist License

Laravel邮件驱动包,用于Mailjet。它还作为Mailjet API v3的封装器。

安装

适用于Laravel 9.x和10.x,还需要Symfony Mailer

composer require thedoctor0/laravel-mailjet-driver symfony/http-client

其他情况

composer require thedoctor0/laravel-mailjet-driver:1.0.4

配置

您可以在这里找到您的Mailjet API密钥/秘密。

修改默认邮件驱动并在您的.env文件中添加新变量

MAIL_DRIVER=mailjet

MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET

config/services.php文件添加部分

'mailjet' => [
    'key' => env('MAILJET_APIKEY'),
    'secret' => env('MAILJET_APISECRET'),
],

确保在config/mail.php中,作为邮件发送地址,您使用的是在您的Mailjet账户上配置的授权电子邮件地址。

您可管理的Mailjet电子邮件地址和域名可以在这里管理。

对于Laravel 7+,您还需要在config/mail.php中指定新的可用邮件驱动

'mailers' => [
    ...

    'mailjet' => [
        'transport' => 'mailjet',
    ],
],

可选配置

您可以将MailjetClient的完整配置添加到config/services.php文件中。

  • transactional:发送API客户端的设置
  • common:通过Facade Mailjet可访问的设置
  • v4:用于某些DataProvider的设置
'mailjet' => [
    'key' => env('MAILJET_APIKEY'),
    'secret' => env('MAILJET_APISECRET'),
    'transactional' => [
        'call' => true,
        'options' => [
            'url' => 'api.mailjet.com',
            'version' => 'v3.1',
            'call' => true,
            'secured' => true
        ],
    ],
    'common' => [
        'call' => true,
        'options' => [
            'url' => 'api.mailjet.com',
            'version' => 'v3',
            'call' => true,
            'secured' => true
        ],
    ],
    'v4' => [
        'call' => true,
        'options' => [
            'url' => 'api.mailjet.com',
            'version' => 'v4',
            'call' => true,
            'secured' => true
        ]
    ],
],

API封装器使用

要从本包中使用API封装器,您首先需要在您的代码中导入Mailjet Facade

use Mailjet\LaravelMailjet\Facades\Mailjet;

然后您可以使用在MailjetServices类中可用的方法之一。

低级API方法

  • Mailjet::get($resource, $args, $options)
  • Mailjet::post($resource, $args, $options)
  • Mailjet::put($resource, $args, $options)
  • Mailjet::delete($resource, $args, $options)

高级API方法

  • Mailjet::getAllLists($filters)
  • Mailjet::createList($body)
  • Mailjet::getListRecipients($filters)
  • Mailjet::getSingleContact($id)
  • Mailjet::createContact($body)
  • Mailjet::createListRecipient($body)
  • Mailjet::editListrecipient($id, $body)

所有方法返回Mailjet\Response或抛出MailjetException以处理任何API错误。

您还可以使用getClient()方法获取Mailjet API客户端,并自行向Mailjet API发送自定义请求。

有关更多信息,请参阅官方的Mailjet API文档