coconutcraig/laravel-postmark

Laravel package for sending mail via the Postmark API

v2.5.0 2019-07-26 16:30 UTC

README

Postmark

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 Templates

Postmark offers a fantastic templating service for you to utilize instead of maintaining your templates within your Laravel application. If you would like to take advantage of that, this package offers an extension on the base MailMessage provided out of the box with Laravel. Within a Laravel notification, you can do the following to start taking advantage of Postmark templates.

public function toMail($notifiable)
{
    return (new \Coconuts\Mail\MailMessage)
        ->identifier(8675309)
        ->include([
            'name' => 'Customer Name',
            'action_url' => 'https://example.com/login',
        ]);
}

You may also utilize an alias instead of the template identifier by using the ->alias() method.

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');
    });
}

Postmark Metadata

Similar to tags, you can also include metadata by adding a header. Metadata headers should be prefixed with metadata- where the string that follows is the metadata key.

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

In this case, the following object will be sent to Postmark as metadata.

{
    "field": "value",
    "another-field", "another 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.