emailGatewayDTO
A DTO for email notification channel gateways.
XML
Elements
| name (type) |
min/max
occurs |
description |
|
host (string)
|
0/1 |
The IP or host name of an SMTP server.
|
|
port (int)
|
1/1 |
The port of the SMTP server, must be between 1 and 65535.
|
|
authRequired (boolean)
|
1/1 |
Whether authentication is required for the SMTP server.
|
|
user (string)
|
0/1 |
The user name to use when authenticating with the SMTP server.
|
|
pass (string)
|
0/1 |
The password to use when authenticating with the SMTP server.
|
|
from (string)
|
0/1 |
The sender address for emails sent through this gateway.
|
|
encryption (encryptionTypeDTO)
|
0/1 |
The type of encryption to use when connecting to the SMTP server. May be NONE, SSL or TLS.
|
|
tries (int)
|
1/1 |
The number of times to try sending an email notification through this gateway before giving up.
|
|
interval (int)
|
1/1 |
The time to wait between retries in seconds.
|
|
orderNumber (int)
|
1/1 |
Get the order number.
|
JSON
| property |
type |
description |
| host |
host (string)
|
The IP or host name of an SMTP server.
|
| port |
port (int)
|
The port of the SMTP server, must be between 1 and 65535.
|
| authRequired |
authRequired (boolean)
|
Whether authentication is required for the SMTP server.
|
| user |
user (string)
|
The user name to use when authenticating with the SMTP server.
|
| pass |
pass (string)
|
The password to use when authenticating with the SMTP server.
|
| from |
from (string)
|
The sender address for emails sent through this gateway.
|
| encryption |
encryption (encryptionTypeDTO)
|
The type of encryption to use when connecting to the SMTP server. May be NONE, SSL or TLS.
|
| tries |
tries (int)
|
The number of times to try sending an email notification through this gateway before giving up.
|
| interval |
interval (int)
|
The time to wait between retries in seconds.
|
| orderNumber |
orderNumber (int)
|
Get the order number.
|