smtpProtocol
The smtpProtocol
data type describes the smtp resource for HCPnamespaces.
Properties
The table below describes the properties included in the smtpProtocol
data type.
Property | Data type | Description | Notes |
emailFormat | String |
Specifies the format for email objects added through the SMTP protocol. Valid values are:
The default is .eml. | |
emailLocation | String |
Specifies the path for the directory in which to store email objects added through the SMTP protocol. This is the path relative to the root of the namespace (that is, rest, data, or fcfs_data). Start and end the path with a forward slash (/), like this: /email/company_all/ The default is /email/. Directory names are case sensitive. | If the specified directory does not exist, HCP creates it. |
enabled | Boolean |
Specifies whether the SMTP protocol is enabled for the namespace. Valid values are:
The default is false. | |
ipSettings | ipSettings | Specifies which IP addresses can and cannot access the namespace through the SMTP protocol. | |
separateAttachments | Boolean |
Specifies whether HCP should store attachments separately from the email they accompany. Valid values are:
The default is false. |
Example
Here’s an XML example of the smtpProtocol
data type:
<smtpProtocol> <emailFormat>.eml</emailFormat> <emailLocation>/finance/email/<emailLocation> <enabled>true</enabled> <ipSettings> <allowAddresses> <ipAddress>192.168.45.213</ipAddress> </allowAddresses> <denyAddresses/> </ipSettings> <separateAttachments>false</separateAttachments> </smtpProtocol>