End point: [RemoteTM URL]/email
Send a POST request with these headers:
Include these parameters in a JSON body:
server |
Name or IP of the SMTP server |
port |
Port number in which the SMTP server accepts requests |
user |
User name for the SMTP server |
password |
Password for the SMTP user |
instance |
URL of the RemoteTM server |
from |
Email address used for sending notifications |
authenticate |
Boolean value indicating whether SMTP server requires authentication |
tls |
Boolean value indicating whether SMTP server requires TLS/SSL protocols |
Example:
{
"server": "smtp.mydomain.com",
"port": "465",
"user": "postmaster",
"password": "pass123$",
"instance": "https://tm.mydomain.com:8443/RemoteTM",
"from": "remotetm@mydomain.com",
"authenticate": true,
"tls": false
}
RemoteTM responds with a JSON object.
On success, field 'status' is set to 'OK'. Example:
{
"status": "OK"
}
On error, field 'status' is set to 'Error' and field 'reason' contains the error cause.
Example:
{
"status": "Error",
"reason": "Access denied"
}