@packmate/mail v0.5.0

@packmate/mail

Send emails from Node.js (via SendGrid) with optional test runs.

Installation

npm install @packmate/mail

The Configuration Function

Usage

const configureSend = require('@packmate/mail')

Syntax

configureSend(options)

Arguments

Returns

Exceptions

Throws a standard Error if:

• The configure options object does not contain all required properties.
• The sender object in the configure options object does not contain all required properties.

The ConfigureOptions Object

The Sender Object

The Send Function

Syntax

send(type, messages, options)

Arguments

Returns

Exceptions

Throws a standard Error if:

• No type is present.
• No message is present.
• The message object does not contain all required properties.
• The options object does not contain all required properties.

Effects

• Mail will be sent via the SendGrid mail implementation.
• Information will be logged using log function provided to the mailer.

During a live run:

• The default sender will be BCC'd on all messages.

During a dry run:

• All mail will be redirected to the default sender.
• Debugging information including the original recipient(s) will be added to the template data.

The Message Object

The Attachment Object

The Person Object

The Options Object

The Log Function

A function for logging information.

The function should include an .error() property for logging errors.

Example Syntax

function log(value) {
  console.log(value)
}

log.error = (error) => {
  console.error(error)
}