Overview
Send a test email over SMTP with a User's system override OutboundEmail configuration
Summary
This endpoint will use the configuration that is currently stored for the
given User's system override email account, but allows for optional
parameters to be passed in to override certain values for testing.
Request Arguments
Name |
Type |
Description |
Required |
user_id
|
String
|
The ID of the User whose configuration is being tested
|
True
|
to_address
|
String
|
The recipient email address to use in the test email
|
True
|
from_address
|
String
|
The From email address to use in the test email. Defaults to the
User's primary email address
|
False
|
name
|
String
|
The sender's name to use in the test email headers. Defaults to the
existing saved User's name
|
False
|
mail_smtpuser
|
String
|
The username to use in SMTP server authentication credentials
during the test. Defaults to the existing saved username
|
False
|
mail_smtppass
|
String
|
The password to use in SMTP server authentication credentials
during the test. Only used when the system email account is configured
to use basic authentication. Defaults to the existing saved password
|
False
|
eapm_id
|
String
|
The ID of the EAPM record to use in SMTP server authentication
credentials. Only used when the system email account is configured
to use OAuth2 authentication. Defaults to the existing saved EAPM ID
|
False
|
Request
{
"user_id": "3924dbae-9556-11ee-8de4-acde48001122",
"name": "Test User",
"from_address": "testFrom@example.com",
"to_address": "testTo@example.com",
"mail_smtpuser": "testuser@gmail.com",
"eapm_id": "ce17d082-95f0-11ee-af40-acde48001122"
}
Response Arguments
Name |
Type |
Description |
status
|
Boolean
|
True if the test email was successfully sent, false otherwise
|
errorMessage
|
String
|
An error message associated with the test email if a failure occurred
|
Response
{
"status": false,
"errorMessage": "Error:The outbound mail server selected for the mail account you are using is invalid. Check the settings or select a different mail server for the mail account."
}
Change Log
Version |
Change |
v11.23
|
Added /OutboundEmail/testUserOverride POST endpoint.
|