trueapps/boldem-swiftmailer

Swift Transport implementation for boldem.cz API.

v0.0.4 2024-06-26 13:12 UTC

Requires

• php: >=7.1
• guzzlehttp/guzzle: ^7.7.0
• swiftmailer/swiftmailer: ^6.0

Requires (Dev)

• phpunit/phpunit: 6.*

MIT

• Tomas Hnilica

README

An Swiftmailer Transport for Boldem.

Send mail through Boldem from your favorite PHP frameworks!

1. Include this package in your project:

composer require trueapps/boldem-swiftmailer

2. Use the transport to send a message:

<?php
//import the transport from the standard composer directory:
require_once('./vendor/autoload.php');

$transport = new \Boldem\Transport('<CLIENT_ID>','<SECRET_CLIENT_KEY>');
$mailer = new Swift_Mailer($transport);

//Instantiate the message you want to send.
$message = (new Swift_Message('Hello from Boldem!'))
  ->setFrom(['[e-mail]' => 'John Doe'])
  ->setTo(['[e-mail]'])
  ->setBody('<b>A really important message from our partners.</b>', 'text/html')
  ->addPart('Another important message from our partners.','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 Boldem api errors:

$transport = new \Boldem\Transport('<BASE_CRYPT>','<APIKEY>');
$transport->registerPlugin(new \Boldem\ThrowExceptionOnFailurePlugin());

$message = new Swift_Message('Hello from Boldem!');
$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-MK-Tag' => 'my-tag'];

$transport = new \Boldem\Transport('<BASE_CRYPT>','<APIKEY>', $defaultHeaders);

$message = new Swift_Message('Hello from Boldem!');

// Overwriting default headers
$message->getHeaders()->addTextHeader('X-MK-Tag', 'custom-tag');

Notes:

• The Transport uses the Boldem API internally to send mail, via the /transactional-emails endpoint.