Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mailjet/mailjetswiftmailer
A SwiftMailer transport implementation for Mailjet
https://github.com/mailjet/mailjetswiftmailer
mailjet mailjet-api packagist php swiftmailer swiftmailer-transport symfony
Last synced: about 1 month ago
JSON representation
A SwiftMailer transport implementation for Mailjet
- Host: GitHub
- URL: https://github.com/mailjet/mailjetswiftmailer
- Owner: mailjet
- License: mit
- Created: 2017-06-05T09:36:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-12T12:13:51.000Z (over 3 years ago)
- Last Synced: 2024-11-14T12:09:26.714Z (about 1 month ago)
- Topics: mailjet, mailjet-api, packagist, php, swiftmailer, swiftmailer-transport, symfony
- Language: PHP
- Size: 56.6 KB
- Stars: 26
- Watchers: 11
- Forks: 24
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# MailjetSwiftMailer
[](https://travis-ci.org/mailjet/MailjetSwiftMailer)
[](https://packagist.org/packages/mailjet/mailjet-swiftmailer)
[](https://packagist.org/packages/mailjet/mailjet-swiftmailer)
[](https://github.com/mailjet/MailjetSwiftMailer/blob/master/LICENSE.md)
A SwiftMailer transport implementation for Mailjet
([NEW] we now support send API v3.1 )
[Mailjet Send API v3.1](https://dev.mailjet.com/guides/#send-api-v3-1-beta)
*Compatible Mailjet send API V3 and V3.1*
If you found any problem, feel free to open an issue!
## TODO
* Adding URL tags
* Sandbox Mode
* Improve unit-tests (lots of code duplications)
## Installation
Require the package with composer
```bash
composer require mailjet/mailjet-swiftmailer
```
## Usage Example
```php
$transport = new MailjetTransport($dispatchEvent, $apiKey, $apiSecret);
$transport->setClientOptions(['url' => "api.mailjet.com", 'version' => 'v3.1', 'call' => true]);
$transport->send($message);
```
(Send API v3 is selected by default)
## Mailjet client custom configuration
You can pass an array in transport's constructor or use `setClientOptions` function:
```php
$clientOptions = ['url' => "api.mailjet.com", 'version' => 'v3.1', 'call' => false];
$transport = new MailjetTransport($dispatchEvent, $apiKey, $apiSecret, $clientOptions);
or
$transport->setClientOptions(['url' => "api.mailjet.com", 'version' => 'v3.1', 'call' => true]);
```
Properties of $options:
* url (Default: api.mailjet.com) : domain name of the API
* version (Default: v3) : API version (only working for Mailjet API V3 +)
* call (Default: true) : turns on(true) / off the call to the API
* secured (Default: true) : turns on(true) / off the use of 'https'
## Mailjet custom headers
It is possible to set specific Mailjet headers or custom user-defined headers, through SwiftMailer.
For example:
```php
$headers = $message->getHeaders();
$headers->addTextHeader('X-MJ-TemplateID', $templateId);
$headers->addTextHeader('X-MJ-TemplateLanguage', true);
$vars = array("myFirstVar" => "foo", "mySecondVar" => "bar");
$headers->addTextHeader('X-MJ-Vars', json_encode($vars));
```
Note: You need to `json_encode`your array of variables in order to be compatible with SMTP transport.
* [Mailjet Email Headers documentation v3](https://dev.mailjet.com/guides/#send-api-json-properties)
* [Mailjet Email Headers documentation v3.1](https://dev.mailjet.com/guides/#adding-email-headers)
## Mailjet bulk sending
```php
$emails = ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]', ...]
$messages = [];
foreach ($emails as $email) {
$message = new \Swift_Message('Test Subject', '
Foo bar
', 'text/html');
$message
->addTo($email)
->addFrom('[email protected]', 'From Name')
->addReplyTo('[email protected]', 'Reply To Name')
;
array_push($messages, $message);
}
$transport = new MailjetTransport($dispatchEvent, $apiKey, $apiSecret);
$result = $transport->bulkSend($messages);
```
Note: does not work with Spool (SwiftMailer removed bulkSend from its API).
## Integration in Symfony
If you want to use MailjetTransport in your Symfony project follow these small steps:
1. `composer require mailjet/mailjet-swiftmailer`
2. Into your `services.yml`, register MailjetTransport:
```yaml
swiftmailer.mailer.transport.mailjet:
class: Mailjet\MailjetSwiftMailer\SwiftMailer\MailjetTransport
arguments:
- "@swiftmailer.transport.eventdispatcher.mailjet"
- "%mailjet.api_key%"
- "%mailjet.secret_key%"
```
Note: We set `mailjet.api_key` and `mailjet.secret_key` into parameters.yml
3. Finally, configure SwiftMailer in your `config.yml`:
```yaml
# Swiftmailer Configuration
swiftmailer:
transport: mailjet
```
Note: You can also inject your own `Mailjet\Client`:
```yaml
mailjet.transactionnal.client:
class: "%mailjet.client.class%"
arguments:
- "%mailjet.api_key%"
- "%mailjet.secret_key%"
- %mailjet.transactionnal.call%
- %mailjet.transactionnal.options%
swiftmailer.transport.eventdispatcher.mailjet:
class: Swift_Events_SimpleEventDispatcher
swiftmailer.mailer.transport.mailjet:
class: Mailjet\MailjetSwiftMailer\SwiftMailer\MailjetTransport
arguments:
- "@swiftmailer.transport.eventdispatcher.mailjet"
- "%mailjet.api_key%"
- "%mailjet.secret_key%"
- %mailjet.transactionnal.call%
- %mailjet.transactionnal.options%
calls:
- method: setExternalMailjetClient
arguments:
- '@mailjet.transactionnal.client'
```
## Mailjet references
* [Mailjet PHP Wrapper](https://github.com/mailjet/mailjet-apiv3-php)
* [Mailjet documentation v3: send transactional email](https://dev.mailjet.com/guides/#send-transactional-email)
* [Mailjet documentation v3.1: send transactional email](https://dev.mailjet.com/beta/#send-transactional-email)
## Execute Tests
```bash
vendor/bin/phpunit -c .
```
## Contributing
If you want to contribute to this project, look at [over here](CONTRIBUTING.md)