Overview
Create a new OutboundEmail configuration to use to send emails over SMTP.
Summary
Each configuration that is created is validated first by attempting to connect to the server.
Request Arguments
| Name |
Type |
Description |
Required |
|
name
|
String
|
The display name of the configuration.
|
True
|
|
mail_sendtype
|
String
|
Only SMTP is supported. This field is defaulted to smtp.
|
False
|
|
mail_smtptype
|
String
|
The email provider through which emails are sent. This is merely a convenience which allows for
prepopulating data in the UI. Possible values are: google, exchange, outlook, other. other is the
default.
|
False
|
|
mail_smtpserver
|
String
|
The address of the SMTP server.
|
True
|
|
mail_smtpport
|
Integer
|
The port on which to connect to the SMTP server. The default is 465, which assumes you are using
SSL.
|
False
|
|
mail_smtpuser
|
String
|
The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
|
False
|
|
mail_smtppass
|
String
|
The password for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
|
False
|
|
mail_smtpauth_req
|
Boolean
|
Indicates whether or not the SMTP server requires authentication. The default is false.
|
False
|
|
mail_smtpssl
|
String
|
The encryption protocol used for connecting to the SMTP server. "0" represents no encryption.
"1" represents SSL. "2" represents TLS. The default is SSL.
|
False
|
Request
{
"name": "My Exchange Account",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 465,
"mail_smtpuser": "foo@example.com",
"mail_smtppass": "P@55w0rd",
"mail_smtpauth_req": true,
"mail_smtpssl": "1"
}
Response Arguments
| Name |
Type |
Description |
|
name
|
String
|
The display name of the configuration.
|
|
type
|
String
|
Only user configuration may be created using this endpoint, so user will always be
returned. system and system-override configurations are always created by the application.
|
|
user_id
|
String
|
The current user's ID. The current user may only create configurations for himself or herself.
|
|
mail_sendtype
|
String
|
Only SMTP is supported, so smtp will always be returned.
|
|
mail_smtptype
|
String
|
The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.
|
|
mail_smtpserver
|
String
|
The address of the SMTP server.
|
|
mail_smtpport
|
Integer
|
The port on which to connect to the SMTP server.
|
|
mail_smtpuser
|
String
|
The username for authenticating with the SMTP server.
|
|
mail_smtppass
|
Boolean
|
Indicates whether or not a password exists. true is returned for this field when a password does
exist. This field is not included in the response when a password does not exist.
|
|
mail_smtpauth_req
|
Boolean
|
Indicates whether or not the SMTP server requires authentication.
|
|
mail_smtpssl
|
String
|
The encryption protocol used for connecting to the SMTP server.
|
Response
{
"id": "e04ce998-960e-11e6-8628-3c15c2d582c6",
"name": "My Exchange Account",
"type": "user",
"user_id": "e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"mail_sendtype": "smtp",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 465,
"mail_smtpuser": "foo@example.com",
"mail_smtppass": true,
"mail_smtpauth_req": true,
"mail_smtpssl": "1",
"deleted": false,
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "OutboundEmail"
}
Change Log
| Version |
Change |
|
v10
|
Added /OutboundEmail POST endpoint.
|