wildbit / swiftmailer-postmark
A Swiftmailer Transport for Postmark.
Installs: 2 444 489
Dependents: 10
Suggesters: 19
Security: 0
Stars: 53
Watchers: 15
Forks: 28
Open Issues: 8
Requires
- guzzlehttp/guzzle: ^6.0|^7.0
- swiftmailer/swiftmailer: ^6.0.0
Requires (Dev)
- phpunit/phpunit: ^6.0.0
This package is auto-updated.
Last update: 2024-11-05 13:17:41 UTC
README
An official Swiftmailer Transport for Postmark.
Send mail through Postmark from your favorite PHP frameworks!
Usage
1. Include this package in your project:
composer require wildbit/swiftmailer-postmark
2. Use the transport to send a message:
<?php //import the transport from the standard composer directory: require_once('./vendor/autoload.php'); $transport = new \Postmark\Transport('<SERVER_TOKEN>'); $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('<b>A really important message from our sponsors.</b>', '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:
$transport = new \Postmark\Transport('<SERVER_TOKEN>'); $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.
$defaultHeaders = ['X-PM-Tag' => 'my-tag']; $transport = new \Postmark\Transport('<SERVER_TOKEN>', $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.
// Change the default stream for every message via Default Headers $transport = new \Postmark\Transport('<SERVER_TOKEN>', ['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.
$transport = new \Postmark\Transport('<SERVER_TOKEN>', $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. To publish a new version, simply create a new release on GitHub tagged with the version number.
Notes:
- The Transport uses the Postmark API internally to send mail, via the /email endpoint. Other sending features such as Batch sending or sending via Templates are currently not supported by this library.