Automatic Response Settings

The automatic response settings are specified for each mail account by the list of autoresponder objects. An autoresponder object is a collection of conditions (events) on which the automatic response message is sent back. In addition, this object specifies the text of this response and the attachment (a file stored in the a mail box repository). Finally, it can specify how this automatic response will act.

The list of autoresponders is specified in the autoresponders node nested within the mailname parent node and structured as follows:

• The enabled node is optional. It enables/disables the feature on the mail account. Data type: boolean. Default value: false.
• The autoresponder node is optional. It specifies an autoresponder object. Data type: none. See the structure of this node below.

The autoresponder node does not have a special data type. It is structured within the autoresponders node as follows:

• The name node is required. It specifies the name of the autoresponder. Data type: string.
• The enabled node is optional. It enables/disables the use of the autoresponder object. Data type: boolean. Default value: false.
• The keystr node is optional. It specifies the key string in the incoming message that will enable this autoresponder sending back its message. Data type: string.
• The key_where node is optional. It specifies the part of an incoming message (body, subject) where the key string should be searched. Data type: string. Allowed values: subj | no | body.
• The subject node is optional. It specifies the subject field in the incoming message header that will enable this autoresponder sending its message back. Data type: string.
• The reply_to node is optional. It specifies the Reply to field in an incoming message header that will enable the autoresponder sending back its message. Data type: string.
• The content_type node is optional. It specifies the Content type field in the incoming message header that will enable the autoresponder sending back its message. Data type: string. Allowed values: text/html | text/plain.
• The charset node is optional. It specifies the charset field in the incoming message header that will enable the autoresponder sending back its message. Data type: string.
• The text node is optional. It specifies the text of the automatic response message. Data type: string.
• The ans_freq node is optional. It specifies the maximum number of automatic replies that can be sent back to the mail address. Data type: integer.
• The mem_limit node is optional. It specifies the maximum number of unique email addresses that can be stored. Data type: integer.
• The attachment node is optional. It specifies the name of the file to be attached to the response message. Data type: string.
• The forward node is optional. It specifies the email address to which the original message will be forwarded. Data type: string.

The following sample packet creates a mail account and specifies autorespoder settings for it:

<packet version="1.4.2.0">

<mail>

<create>

   <filter>

      <domain_id>123</domain_id>

      <mailname>

          <name>bfischer</name>

          <autoresponders>

              <enabled>true</enabled>

              <autoresponder>

                 <name>motorola</name>

                 <subject>Regarding controllers</subject>

                 <text>Your answer will be processed in the nearest 10 days. Thank you.</text>

                 <forward>techdept@technolux.co.uk</forward>

              </autoresponder>

          </autoresponders>

      </mailname>

   </filter>

</create>

</mail>

</packet>