https://github.com/activecampaign/swiftmailer-postmark
The Official Swiftmailer Transport for Postmark.
https://github.com/activecampaign/swiftmailer-postmark
email mail postmark postmark-integrations
Last synced: about 1 year ago
JSON representation
The Official Swiftmailer Transport for Postmark.
- Host: GitHub
- URL: https://github.com/activecampaign/swiftmailer-postmark
- Owner: ActiveCampaign
- Created: 2015-02-26T17:51:27.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2022-09-05T08:52:27.000Z (almost 4 years ago)
- Last Synced: 2025-03-30T13:09:59.483Z (about 1 year ago)
- Topics: email, mail, postmark, postmark-integrations
- Language: PHP
- Homepage: https://postmarkapp.com
- Size: 81.1 KB
- Stars: 52
- Watchers: 14
- Forks: 28
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swiftmailer-postmark
[](https://circleci.com/gh/ActiveCampaign/swiftmailer-postmark)
An official Swiftmailer Transport for Postmark.
Send mail through Postmark from your favorite PHP frameworks!
## Usage
### 1. Include this package in your project:
```bash
composer require wildbit/swiftmailer-postmark
```
### 2. Use the transport to send a message:
```php
');
$mailer = new Swift_Mailer($transport);
//Instantiate the message you want to send.
$message = (new Swift_Message('Hello from Postmark!'))
->setFrom(['john@example.com' => 'John Doe'])
->setTo(['jane@example.com'])
->setBody('A really important message from our sponsors.', 'text/html')
->addPart('Another important message from our sponsors.','text/plain');
//Add some attachment data:
$attachmentData = 'Some attachment data.';
$attachment = new Swift_Attachment($attachmentData, 'my-file.txt', 'application/octet-stream');
$message->attach($attachment);
//Send the message!
$mailer->send($message);
?>
```
### 3. Throw exceptions on Postmark api errors:
```php
$transport = new \Postmark\Transport('');
$transport->registerPlugin(new \Postmark\ThrowExceptionOnFailurePlugin());
$message = new Swift_Message('Hello from Postmark!');
$mailer->send($message); // Exception is throw when response !== 200
```
### 4. Use default headers:
You can set default headers at Transport-level, to be set on every message, unless overwritten.
```php
$defaultHeaders = ['X-PM-Tag' => 'my-tag'];
$transport = new \Postmark\Transport('', $defaultHeaders);
$message = new Swift_Message('Hello from Postmark!');
// Overwriting default headers
$message->getHeaders()->addTextHeader('X-PM-Tag', 'custom-tag');
```
### 5. Setting the Message Stream:
By default, the "outbound" transactional stream will be used when sending messages.
```php
// Change the default stream for every message via Default Headers
$transport = new \Postmark\Transport('', ['X-PM-Message-Stream' => 'your-custom-stream']);
$message = new Swift_Message('Hello from Postmark!');
// Overwrite the default stream for a specific message by setting the header
$message->getHeaders()->addTextHeader('X-PM-Message-Stream', 'another-stream');
```
### 6. Getting the Postmark Message ID after sending
After sending the mail to Postmark, it is possible to get the Postmark ID.
```php
$transport = new \Postmark\Transport('', $defaultHeaders);
$mailer = new Swift_Mailer($transport);
$message = new Swift_Message('Hello from Postmark!');
$mailer->send($message);
$postmarkID = $message->getHeaders()->get('X-PM-Message-Id')->getValue();
```
## Releasing a new version
Swiftmailer Transport uses [packagist](https://packagist.org/packages/wildbit/swiftmailer-postmark).
To publish a new version, simply create a new release on GitHub tagged with the version number.
## Notes:
- The Transport uses the [Postmark API](https://postmarkapp.com/developer) internally to send mail, via the [/email endpoint](https://postmarkapp.com/developer/api/email-api#send-a-single-email). Other sending features such as Batch sending or sending via Templates are currently not supported by this library.