smtpProtocol

The smtpProtocol data type describes the smtp resource for HCPnamespaces.

Properties

The table below describes the properties included in the smtpProtocol data type.

PropertyData typeDescriptionNotes
emailFormatString

Specifies the format for email objects added through the SMTP protocol. Valid values are:

  • .eml
  • .mbox

The default is .eml.

emailLocationString

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.
enabledBoolean

Specifies whether the SMTP protocol is enabled for the namespace. Valid values are:

  • true

    SMTP is enabled.

  • false

    SMTP is disabled.

The default is false.

ipSettingsipSettingsSpecifies which IP addresses can and cannot access the namespace through the SMTP protocol.
separateAttachmentsBoolean

Specifies whether HCP should store attachments separately from the email they accompany. Valid values are:

  • true

    Store attachments separately.

  • false

    Do not store attachments separately.

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>