SparkPost Email

SparkPost is a third-party email execution engine used by RPI to deliver interaction emails.

The following channel-specific fields are shown for SparkPost email channels:

      Re-subscribe contacts: as per Salesforce Marketing Cloud email channel.

      Recipient email: as per Salesforce Marketing Cloud email channel.

      Service Credentials section:

API service URL: this mandatory text field allows you to specify the URL used to connect to the SparkPost API service.  It accepts a maximum length of 100 characters, and defaults to ‘https://api.sparkpost.com/api/v1/’.

Sending domain: this mandatory text field represents the domain from which emails are to be sent.  It supports a maximum value length of 100 characters.

Tracking domain: this mandatory text field represents the domain to be used to track opens and clicks.  It supports a maximum value length of 100 characters.

API key: this mandatory text field represents the API key to be used to authenticate when connecting to the SparkPost service.  It supports a maximum value length of 100 characters.

Unsubscribe URL: this mandatory text field represents the URL to be used to manage unsubscribes.  It supports a maximum value length of 1000 characters.

      Suppressions section

Auto-suppress: as per Salesforce Marketing Cloud email channel.

Custom suppression table: as per Salesforce Marketing Cloud email channel.

Suppression table name: as per Salesforce Marketing Cloud email channel.

      Miscellaneous section:

IP Pool: this optional property allows you to specify a dedicated IP pool from which emails will be sent when the channel is used.  It is initially presented as a Choose IP pool button.  It is enabled when the channel has been saved.  Clicking the button displays the Choose IP Pool dialog.  The dialog lists all IP pools configured at the SparkPost account.  You can select a single IP pool, and click OK to confirm your choice.  A Cancel button is also provided.

Having selected an IP pool, a Clear button is shown.  Clicking it clears the selected IP pool.

Campaign ID: this optional property allows you to specify the name of a SparkPost campaign to be used when executing an email offer using the channel.  It is initially presented as a Click here to design the format button.  Clicking the button displays the Design Campaign ID format dialog.  You can use the following text parts can be used to build the campaign ID:

String

Date part

Interaction name

Trigger name

Activity name

Offer name

Channel name

Offer channel name

Execution ID

Workflow ID

Audience ID

Test indicator

Note that a campaign ID can be a maximum of 50 characters in length; any characters beyond this limit will be truncated.

Subaccount: this optional property allows you to specify the name of a SparkPost subaccount from which emails will be sent when the channel is used.  It is initially presented as a Choose subaccount button.  It is enabled when the channel has been saved.  Clicking the button displays the Choose Subaccount.  The dialog lists all subaccounts configured at the SparkPost account.  You can select a single subaccount and click OK to confirm your choice.  A Cancel button is also provided.

Having selected a subaccount, a Clear button is shown.  Clicking it clears the selected subaccount.

Remove default text footer: as per Salesforce Marketing Cloud email channel.

BCC email address: as per Salesforce Marketing Cloud email channel.

API request limit: this numeric property represents the number of API requests that can be made per minute.  It defaults to 6.

Event request count: this numeric property specifies the number of records to request when processing message events.  It defaults to 5000.

Save event files: this checkbox, which is unchecked by default, allows you stipulate that SparkPost event files will be moved to the ‘C:\temp\RPI\SparkPost\TENANT_ID\Processed’ folder after email offer execution.

Note that, if this option is selected, there is the potential for the persistence of PII data on the RPI Server.  Accordingly, a warning is shown when this option is checked:

Content templates shared folder: as per CheetahMail email channel.

The following properties are exposed at the Advanced tab:

      External folder: as per Acoustic email channel.

      Enable trace: as per SendGrid email channel.

      Move hashtags to end of URL: as per Salesforce Marketing Cloud email channel.

Note that Web Adapters are supported at the channel.

A Validate channels job is created and executed on saving a new SparkPost email channel, or on saving following a change to an existing SparkPost email channel's Recipient email field.  Full details are as per the Salesforce Marketing Cloud email channel documentation.