/
REST Objects SMTP Provider

REST Objects SMTP Provider

5.0.0

The SMTP Provider object is part of the overall ServiceBroker Configuration object, in the following location:

An SMTP Provider object is used within the context of a REST Objects Providers (itself part of an REST Objects Configuration) to represent the details of how ServiceBroker is to be integrated with an SMTP provider for the relevant tenant.

ServiceBroker currently only supports the sending of email via the Amazon Web Services Simple Email Service.

As a result, the likely headers which will need to be set will include:

  • X-SES-SOURCE-ARN
  • X-SES-FROM-ARN
  • X-SES-RETURN-PATH-ARN

Please see the AWS SES documentation for further details.

 


SMTP Provider Object Format

JSON Format
{
	"Headers": {
		"HEADER-1-NAME": "",
		"HEADER-2-NAME": "",
		...
	}
}

SMTP Provider Object Properties

PropertyTypeRequired?Description
HEADER-1-NAMEstringNoThe name/value pair of the first desired header to be included when sending SMTP messages.
HEADER-2-NAMEstringNoThe name/value pair of the second desired header to be included when sending SMTP messages.