craigpaul / laravel-postmark by craigpaul

Laravel package for sending mail via the Postmark API
1,305,251
199
5
Package Data
Maintainer Username: craigpaul
Maintainer Contact: craig.paul@coconutsoftware.com (Craig Paul)
Package Create Date: 2017-01-29
Package Last Update: 2024-02-19
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2024-04-24 03:03:32
Package Statistics
Total Downloads: 1,305,251
Monthly Downloads: 60,706
Daily Downloads: 2,453
Total Stars: 199
Total Watchers: 5
Total Forks: 24
Total Open Issues: 2

Laravel Postmark

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.

Upgrading

Please see UPGRADE for details.

Installation

You can install the package via composer:

$ composer require coconutcraig/laravel-postmark

The package will automatically register itself.

You can optionally publish the config file with:

php artisan vendor:publish --provider="Coconuts\Mail\PostmarkServiceProvider" --tag="config"

Usage

Update your .env file by adding your server key and set your mail driver to postmark.

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.