coconutcraig/laravel-postmark

v2.1.1 2017-07-18 05:29 UTC

README

Looking for Laravel Postmark for Laravel 5.4? Visit the 2.0 tag

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Postmark is the easiest and most reliable way to be sure your important transactional emails get to your customer's inbox.

Install

Via Composer

$ composer require coconutcraig/laravel-postmark

Support

Laravel Laravel Postmark
5.4 <= 2.0
5.5 >= 2.1

Upgrading

Please see UPGRADE for details.

Usage

Update the config/services.php file to hold our Postmark specific config.

return [
    // ...
    
    'postmark' => [
        'secret' => env('POSTMARK_SECRET'),    
    ],
];

Then we can add the server key to our .env file and update our MAIL_DRIVER.

MAIL_DRIVER=postmark

// ...

POSTMARK_SECRET=YOUR-SERVER-KEY-HERE

That's it! The mail system continues to work the exact same way as before and you can switch out Postmark for any of the pre-packaged Laravel mail drivers (smtp, mailgun, log, etc...).

Remember, when using Postmark the sending address used in your emails must be a valid Sender Signature that you have already configured.

Postmark Tags

If you rely on categorizing your outgoing emails using Tags in Postmark, you can simply add a header within your Mailable class's build method.

public function build()
{
    $this->withSwiftMessage(function (\Swift_Message $message) {
        $message->getHeaders()->addTextHeader('tag', 'value');
    });
}

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email craig.paul@coconutcalendar.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.