Package Exports

node-ses

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-ses) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

#node-ses

A simple and reliable Node.js mail for sending mail through Amazon SES.

Benefits

Does only one thing and does it well. Only the SendEmail API method is implemented.
Good error handling:
- Only "2xx" and "3xx" resposnes from Amazon are considered successful.
- Amazon's XML format errors are converted to JavaScript options for easy handling.
- Support for the debug module is included if deep innspection is needed.
Tested and reliable. Includes test suite. Sending email to SES since 2012.

Synopsis

This module implements the SendEmail action only. What more do you need? ;)

var ses = require('node-ses')
  , client = ses.createClient({ key: 'key', secret: 'secret' });

client.sendemail({
   to: 'aaron.heckmann+github@gmail.com'
 , from: 'somewhereOverTheR@inbow.com'
 , cc: 'theWickedWitch@nerds.net'
 , bcc: ['canAlsoBe@nArray.com', 'forrealz@.org']
 , subject: 'greetings'
 , message: 'your <b>message</b> goes here'
 , altText: 'plain text'
}, function (err, data, res) {
 // ...
});

Installation

npm install node-ses

The module has one primary export:

##createClient()

You'll probably only be using this method. It takes an options object with the following properties:

`key` - (required) your AWS SES key
`secret` - (required) your AWS SES secret
`algorithm` - [optional] the AWS algorithm you are using. defaults to SHA1.
`amazon` - [optional] the amazon end-point uri. defaults to `https://email.us-west-2.amazonaws.com`

Not all AWS regions support SES. Check SES region support to be sure the region you are in is supported.

var ses = require('node-ses')
  , client = ses.createClient({ key: 'key', secret: 'secret' });

client.sendemail(options, function (err, data, res))

The client created has one method, sendemail. This method receives an options object with the following properties:

`from` - email address from which to send (required)
`subject` - string (required). Must be encoded as UTF-8
`message` - can be html (required). Must be encoded as UTF-8.
`altText` - plain text version of message. Must be encoded as UTF-8.
`to` - email address or array of addresses
`cc` - email address or array of addresses
`bcc` - email address or array of addresses
`replyTo` - email address

At least one of to, cc or bcc is required.

Optional properties (overrides the values set in createClient):

`key` - AWS key
`secret` - AWS secret
`algorithm` - AWS algorithm to use
`amazon` - AWS end point

The sendmail method transports your message to the AWS SES service. If Amazon returns an HTTP status code that's less than 200 or greater than or equal to 400, we will callback with an err object that is a direct translation of the XML error Amazon provides. Check for errors returned since a 400 status is not uncommon.

The data returned in the callback is the HTTP body returned by Amazon as XML. See the SES API Response docs for details.

The res returned by the callback represents the HTTP response to calling the SES REST API as the request module returns it.

Running the Tests

make test

Licence

MIT

node-ses