Embarke SMTP Configuration

Using the Embarke SMTP server
To send your transactional email through Embarke, you’ll need to change your SMTP configuration to use Embarke’s gateway.

The server information as well as your Account ID (username) and Account Key (password) is shown in the Dashboard under the Settings page (click the “Configure SMTP Emails” link).

The X-EMBARKEAPI header
In addtion to the basic SMTP relay functionality, you can add tags to your messages, as well as control how Embarke schedules and time optimizes your messages.

Using a special SMTP header, “X-EMBARKEAPI”, with a JSON encoded format, you can specify a date/time to schedule a message, a delivery window that we can optimize in (from 0 hours to 7 days), and tag the message (for reporting purposes). The format is as follows:

   X-EMBARKEAPI:{ "sendDate": "2013-05-26T18:00Z", 
                  "maxSendHours": 24, 
                  "campaignId": "My Campaign",
                  "mailAccount": "esp-account-username",
                  "tags": ["My custom tag1", "My tag 2", ...] }

sendDate is the scheduled time to start in ISO8601 format (e.g. 2013-10-06T11:30Z)

maxSendHours is the longest window within which Embarke can try to optimize the message. To send without optimizing, just use a maxSendHours value of 0. 0 – 168 hours is the valid range (up to 7 days), 24 hours is the default.

campaignId (optional) – use this to group a set of messages into a single campaign mailing for reporting.

mailAccount (optional) – used when you have more than one account configured with your ESP. This parameter lets you specify which account should be used to deliver the email. The value is the account name/ID from your ESP.

tags (optional) is one or more identifiers for the type of message (used for reporting), such as “Newsletter”, “Promotion”, “Welcome mail”, etc.

If using SendGrid, we also support pass-through of the SendGrid SMTPAPI header.