The postmark module. This is the entry point for the postmark client.
To send an email:
var postmark = require('postmark');
var client = new postmark.Client('<server key>');
client.sendEmail({ ... }, function(err, response){ ... });Type Definitions
-
postmark(apiKey, defaults) → {Client}
-
Parameters:
Name Type Argument Description apiKeystring The server key used to access the API.
defaultsClientDefaults <optional>
The options to use when creating requests. These defaults are used if you do not specify your own options.
Properties:
Name Type Description defaultsClientDefaults This property specifies the global defaults used when creating all clients. Altering this defaults here will cause new clients to observe the updated values, but existing clients will used the defaults as they were when they were constructed.
ClientClient A Postmark Client Constructor. This is the standard client used to send an recieve email, process stats, and handle bounces. In most cases, this is the Client you should use.
AdminClientAdminClient A Postmark AdminClient constructor. This is the client used to administer "Account-level" modifications. You may add/update Servers, as well as add and update Sender Signatures.
Returns:
- Type
- Client
Postmark.js