Loading...

Last updated: May 28 2018

Area: Episerver Campaign Applies to versions: Not applicable

SMTP API

The SMTP API of Episerver Campaign is an interface  which can be used to control the dispatch of your mailings, to ensure high deliverability and control mailing lists, while still using your own software for design, distribution and recipient data management.

Benefits using the SMTP API for dispatch:

  • High email delivery rates.
  • Seamless integration into existing system architecture.
  • Mailing development and recipient management using your current system.
  • Deliverability monitoring by Episerver deliverability experts.
  • Quicker and more reliable distribution, even for large recipient lists.

Response management

By using SMTP API you can also take advantage of response management to ensure that blocked email addresses and email addresses that have exceeded a set limit of hard or soft bounces, will no longer receive mailings. To use bounce management, installation of the SMTP API requires an email address to which returned emails can be forwarded. This forwarding address is mandatory and may not be part of the sending domain.

Undelivered emails may be due to the following:

  1. The server charged with delivery does not recognize the email address (hard bounce) or the mailbox is temporarily unavailable (soft bounce).
  2. The mail server at Episerver is unable to verify the email header or associate it with a mailing.
  3. The recipient's email address is on a blacklist or it exceeded the bounce limit.

Installation

The following is required for an SMTP API installation:

  • A client for use by Episerver Campaign. If you are not an Episerver customer, Episerver support can install this.
  • The the IP addresses you use for sending out emails, to be able to activate the interface.
  • Registration of the email server as SMTP server, together with authentication, in your distribution system. Episerver support will provide this information.
  • A sending domain that corresponds to the host name of the sender address. For example, if you send mailings from "newsletter@news.example.com", then the sending domain is "news.example.com". This domain will be delegated to Episerver.

Standard distribution

The requirements previously described apply for standard distributions. Distribution is handled internally via a mailing ID. Billing for emails sent occurs monthly and is based on this mailing ID.

Distribution through subclients

Agencies sending out mailings for different clients may need to bill each client separately. This can be done by addressing different mailings through a single ID integrated into the email header. Episerver will provide the code and relevant ID, and you simply integrate this code into the email header of the mailings you wish to send out.

What Episerver needs for the installation 

In order for Episerver to install the SMTP API, you need to provide the information below. Complete the PDF form you get to set up your client, and email it to Episerver support.

  • Requested name of your client (or the name of your current Episerver Campaign client).
  • IP address(es), to be used to access the SMTP interface.
  • Sending domain.
  • Email address for bounce management – note that the host name of this address may not be the same as the sending domain name.

What you receive from Episerver

Once your client and SMTP API has been set up and configured, you will get the following:

  • Name of the SMTP server.
  • SMTP authentication.
  • An email header code for distribution via several mailings.

What you need to do in your system

Do the following to configure your dispatch system using the data you received from Episerver:

  1. Delegate the sending domain to Episerver. Instructions can be found here.
  2. Add the name of the SMTP server smtpapi.campaign.episerver.net, the SMTP authentication and the Port 25 to your dispatch software. To ensure that the authentication data is transmitted encrypted, TLS encryption must be enabled. The certificate Thawte SSL CA of the certification authority Thawte must be known as a trusted certificate in your dispatch software.
  3. If you are sending via several mailings, include the email header code in the header of the mailings.
  4. Once this is completed, you can then begin sending out mailings via the SMTP API.

Rule specifications

When submitting emails for dispatch to Episerver Campaign, apply the rules below.

Note: It is important that you apply these rules, otherwise the dispatch will be aborted.

  • The size of each email must not exceed 300 KB.
  • A message ID header must be set and must have the pattern <32hhr34-42hkjh42@example.com>.
  • The email must contain exactly one "to" header with a valid email address.
  • The email must contain exactly one "from" header with a valid email address. The domain of this address must be identical with the sending domain configured in your client.
  • Do not set a cc or bcc header.
  • The subject must not be empty.
  • A maximum of one "reply-to" header must be set.
  • If you use an email header code (X-bm-mailing) from Episerver to address a specific mailing, this code must be valid.
  • Envelope "sender" and "from" header must be identical.
  • The domain of the sending address must be identical with the sending domain configured in your client.
  • The organizational part of the Return-Path header (envelope-from) must match the organizational part of the From header.
    • Example domain in Return-Path header: Steps 1 to 4 as described here.
    • Example domain in From header: Step 5 as described here.
  • Do not set a return-path.

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/