craftcms/postmark

Postmark adapter for Craft CMS

Maintainers

Details

github.com/craftcms/postmark

Source

Issues

Documentation

Installs: 145 097

Dependents: 2

Suggesters: 0

Security: 0

Stars: 20

Watchers: 7

Forks: 5

Open Issues: 4

Type:craft-plugin

3.1.0 2024-03-19 21:01 UTC

Requires

Requires (Dev)

MIT 05d7098b2a64c30e92e64ff8119b30c0f3f54c7d

mailercmspostmarkyii2craftcms

This package is auto-updated.

Last update: 2024-10-27 21:47:05 UTC

README

Postmark icon

Postmark for Craft CMS

This plugin provides a Postmark integration for Craft CMS.

Requirements

This plugin requires Craft CMS 4.0.0+ or 5.0.0+.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “Postmark”. Then click on the “Install” button in its modal window.

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require craftcms/postmark

# tell Craft to install the plugin
./craft plugin/install postmark

Setup

Once Postmark is installed:

  1. Go to Settings → Email.
  2. Change the Transport Type setting to Postmark. Also, ensure that your System Email Address in your Craft Email Settings matches your confirmed Sender Signature email address in Postmark.
  3. Enter your Server Token (which you can get from your server page under “API Tokens”).
  4. If you wish to send mail using a custom Message Stream, set the Message Stream ID. (The default transactional Message Stream will be used if this is left blank.)
  5. Click Save.

Tip: The Server Token and Message Stream ID settings can be set using environment variables. See Environmental Configuration in the Craft docs to learn more about that.