/OutboundEmail/:record PUT
Overview
Update an OutboundEmail configuration.
Summary
Each configuration that is saved is validated first by attempting to connect to the server.
Request Arguments
| Name |
Type |
Description |
Required |
|---|
|
name
|
String
|
The display name of the configuration.
|
False
|
|
mail_sendtype
|
String
|
Only SMTP is supported. It is recommended that you do not change this from 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.
|
False
|
|
mail_smtpserver
|
String
|
The address of the SMTP server.
|
False
|
|
mail_smtpport
|
Integer
|
The port on which to connect to the SMTP server.
|
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.
|
False
|
|
mail_smtpssl
|
String
|
The encryption protocol used for connecting to the SMTP server. "0" represents no encryption.
"1" represents SSL. "2" represents TLS.
|
False
|
Request
{
"mail_smtpport": 587,
"mail_smtpssl": "2"
}
Response Arguments
| Name |
Type |
Description |
|---|
|
name
|
String
|
The display name of the configuration.
|
|
type
|
String
|
Possible values are: user, system, system-override. Only the administrator may update the system
configuration. This field may never change.
|
|
user_id
|
String
|
The current user's ID. The current user may only update configurations that he or she owns.
|
|
mail_sendtype
|
String
|
Only SMTP is supported, 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": 587,
"mail_smtpuser": "foo@example.com",
"mail_smtppass": true,
"mail_smtpauth_req": true,
"mail_smtpssl": "2",
"deleted": false,
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "OutboundEmail"
}
Change Log
| Version |
Change |
|---|
|
v10
|
Added /OutboundEmail/:record PUT endpoint.
|