Configure email provider
Create an email provider. The credentials object
requires different properties depending on the email provider (which is specified using the name property):
mandrillrequiresapi_keysendgridrequiresapi_keysparkpostrequiresapi_key. Optionally, setregiontoeuto use the SparkPost service hosted in Western Europe; set tonullto use the SparkPost service hosted in North America.euornullare the only valid values forregion.mailgunrequiresapi_keyanddomain. Optionally, setregiontoeuto use the Mailgun service hosted in Europe; set tonullotherwise.euornullare the only valid values forregion.sesrequiresaccessKeyId,secretAccessKey, andregionsmtprequiressmtp_host,smtp_port,smtp_user, andsmtp_pass
Depending on the type of provider it is possible to specify settings object with different configuration
options, which will be used when sending an email:
smtpprovider,settingsmay containheadersobject.- When using AWS SES SMTP host, you may provide a name of configuration set in
X-SES-Configuration-Setheader. Value must be a string. - When using Sparkpost host, you may provide value for
X-MSYS_APIheader. Value must be an object.
- When using AWS SES SMTP host, you may provide a name of configuration set in
- For
sesprovider,settingsmay containmessageobject, where you can provide a name of configuration set inconfiguration_set_nameproperty. Value must be a string.
POST
TypeScript
Authorizations
Body
Response
Email provider successfully created.