Email Outbox
Jan 1 2022 at 12:00 AM
The Email Outbox service is responsible for sending emails within the system. Unlike SMS messages, email messages can be of any length. It can also be sent from within any service within the system.
Email messages are added to a DAPI queue, and in the event of an error, for example, a communication error occurs on the first attempt, the system retries to send the email to the configured maximum attempts.
Additionally, the user has the ability to query the status of a queued message.
Prerequisites
To use this service you will first need to create a user in portal and link their email address.
APIs within Email Outbox
EmailOutbox
API Calls
QueueEmail
Permission
email:send
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutbox/QueueEmail
URL Params
None
Data Params
Example:
{
"sendWithServer": "string",
"sendTo": "string",
"sendCc": "string",
"sendBcc": "string",
"subject": "string",
"message": "string",
"linkedResources": "IEnumerable< LinkedResource :{"StreamArray":byte,"ContentId":"string"}>"
}
sendWithServer : string
sendTo : string
sendCc : string
sendBcc : string
subject : string
message : string
linkedResources: IEnumerable
(optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetEmailStatus
Permission
No permission check
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutbox/GetEmailStatus
URL Params
None
Data Params
{
"emailId": "string"
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetVersion
Permission
No permission check
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutbox/GetVersion
URL Params
None
Data Params
None
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetServerNames
Permission
No permission check
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutbox/GetServerNames
URL Params
None
Data Params
None
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
EmailOutboxConfig
API Calls
GetMailServers
Permission
email.config: get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutboxConfig/GetMailServers
URL Params
None
Data Params
None
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetMailServer
Permission
email.config: get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutboxConfig/GetMailServer
URL Params
None
Data Params
{
"serverName": string
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SetMailServer
Permission
email.config:set
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutboxConfig/SetMailServer
URL Params
None
Data Params
Example:
{
"mailServer": {
"ServerName": "string",
"DomainName": "string",
"Port": "int",
"Username": "string",
"Password": "string",
"PasswordSet": "bool",
"DisplayName": "string",
"EnableSsl": "bool",
"Default": "bool"
}
}
- mailServer: MailServerDto
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
RemoveMailServer
Permission
email.config:set
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EmailOutboxConfig/RemoveMailServer
URL Params
None
Data Params
{
"serverName": "string"
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None