jonom/silverstripe-postmark-mailer

Postmark mailer class for SilverStripe

v2.0.0 2018-02-13 17:51 UTC

Requires

• php: >=5.5
• silverstripe/framework: ^3.1
• wildbit/postmark-php: ^2.5

BSD-3-Clause

• Jonathon Menz

• mailer
• email
• postmark
• silverstripe

README

This module is for SilverStripe v3 only. SilverStripe 4 supports many email services through configuration only by providing a wrapper for SwiftMailer. Postmark takes some extra work to set up though, because SS4 uses SwiftMailer v5, and the official Postmark adapter for that version is incomplete. Here are a couple of different approaches for working around the issue:

• Use patched fork through composer
• Create custom transport in project

SilverStripe Postmark Mailer

This module lets you send SilverStripe emails through the official Postmark PHP library, falling back to PHP's built-in sendmail() if Postmark is unreachable.

Requirements

• PHP 5.5+
• SilverStripe ^3.1
• Postmark-PHP

Note: an alternative Postmark Mailer class that works with older versions of SilverStripe and PHP is available here.

Installation

Install with Composer. Learn how

composer require "jonom/silverstripe-postmark-mailer:^1.0"

Documentation

You will need to provide a PostmarkAPP API key and at least one verified email address (Sender Signature) that you have set up in your Postmark account. If you try to send an email from a non-verified address, the From address will be changed to the first verified address you provided and a Reply-To field will be set with the original From address.

Example configuration

In your project's _config.php file:

Email::set_mailer(new PostmarkMailer());

or:

// Send email through Postmark in live environment only
if (Director::isLive()) {
	Email::set_mailer(new PostmarkMailer());
}

In your project's _config/config.yml file:

PostmarkMailer:
  api_key: 'your-key-goes-here'
  sender_signatures:
    - '[e-mail]'
    - '[e-mail]'

Maintainer contact

Jono Menz

Sponsorship

If you want to boost morale of the maintainer you're welcome to make a small monthly donation through GitHub, or a one time donation through PayPal. ❤️ Thank you!

Please also feel free to get in touch if you want to hire the maintainer to develop a new feature, or discuss another opportunity.