0.0.5 • Published 7 years ago

ultimail-provider-postmark v0.0.5

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

Ultimail-Provider-Postmark

Provider middleware for Ultimail that adds support for sending emails via Postmark.

Quick Start

You need to configure this middleware as an Ultimail "provider" using the mailer.configure() method:

const Ultimail = require(`ultimail`);
const ultimailProviderPostmark = require(`ultimail-provider-postmark`);

const mailer = new Ultimail({
	from: `some@email.com`,
	styles: true,
});

mailer.configure(`provider`, ultimailProviderPostmark({
	apiKey: `my-postmark-server-api-key`,
}));

Configuration

You can pass the following config options to this middleware:

OptionDefault ValueDescription
apiKeyThe API server key that Postmark assigns to your server.
throwOnFailuretrueSet false to just return the Postmark response when an email fails to send, instead of throwing an error.

Response Object

The shape of the response object returned by Postmark can be found in the Postmark API documentation. If you want to get access to the response object even when an email fails to send (instead of an error being thrown), you will need to set the "throwOnFailure" config option to a falsy value.

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago