zorca / laravel-mailjet
用于处理Mailjet API V3和Laravel Mailjet邮件传输的Laravel包
2.0.1
2019-08-13 05:44 UTC
Requires
- php: >=7.1.3
- laravel/framework: 5.8.*
- laravel/tinker: ~1.0
- mailjet/mailjet-apiv3-php: ^1.2
- mailjet/mailjet-swiftmailer: ^2.0
Requires (Dev)
- fzaninotto/faker: ~1.4
- mockery/mockery: 0.9.*
- orchestra/testbench: 3.6
- phpunit/phpunit: ~7.0
This package is auto-updated.
Last update: 2024-09-13 16:51:09 UTC
README
Laravel包,通过此包装器处理Mailjet API v3:https://github.com/mailjet/mailjet-apiv3-php
它还提供了一个Laravel邮件功能的mailjetTransport
安装
首先,将包包含在你的依赖关系中
composer require mailjet/laravel-mailjet
然后,你需要在你的配置文件中添加一些信息。你可以在这里找到你的Mailjet API密钥/密钥:这里
- 在提供者数组中
'providers' => [ ... Mailjet\LaravelMailjet\MailjetServiceProvider::class, Mailjet\LaravelMailjet\MailjetMailServiceProvider::class, ... ]
- 在别名数组中
'aliases' => [ ... 'Mailjet' => Mailjet\LaravelMailjet\Facades\Mailjet::class, ... ]
- 在services.php文件中
mailjet' => [ 'key' => env('MAILJET_APIKEY'), 'secret' => env('MAILJET_APISECRET'), ]
- 在你的.env文件中
MAILJET_APIKEY=YOUR_APIKEY MAILJET_APISECRET=YOUR_APISECRET
完整配置
'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 ] ] ]
你可以将设置传递给MailjetClient。
transactional
:发送API客户端的设置common
:通过Facade Mailjet可访问的设置
邮件驱动程序配置
为了将Mailjet用作你的邮件驱动程序,你需要更新你的config/mail.php
或你的.env
文件中的邮件驱动程序为MAIL_DRIVER=mailjet
,并确保你使用的是在Mailjet账户上配置的有效和授权的发送电子邮件地址。发送电子邮件地址和域可以在这里管理:这里
有关用法,请参阅Laravel邮件文档
用法
为了使用此包,你首先需要在你的代码中导入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 API文档
所有方法返回Mailjet\Response
或抛出MailjetException
(如果API出错)。
您还可以使用getClient()
方法获取Mailjet API客户端并对其API进行自定义请求。
待办事项
- 添加更多单元测试以增加代码覆盖率。