Configuring the IMAP mail adapter

The validity of installed certificates is checked once every 24 hours. The first check is conducted 24 hours after the adapter is enabled.

Adapter type: ro-adapter-imap_vv.rr.nn

To configure the IMAP mail adapter, see Configuring base adapters.

The following table describes the IMAP mail adapter configuration elements that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the UI label column.


 Configuration node elements for the IMAP mail adapter

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.

These parameters are available with supported adapter versions. See your adapter documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.

  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

The following figures show XML templates of the adapter configuration for the IMAP adapter for a single target.

XML template one of the IMAP adapter configuration for a single target

<config>
 <target></target>
 <port></port>
 <user-name></user-name>
 <password encryption-type=""></password>
 <character-set></character-set>
 <javamail-debug></javamail-debug>
 <email-address></email-address>
 <protocol>imap</protocol>
 <refresh></refresh>
 <mail-timeout></mail-timeout>
 <connection-timeout></connection-timeout>
 <process-all-unread-mails></process-all-unread-mails>
 <disable-auth-login></disable-auth-login>
 <disable-auth-plain></disable-auth-plain>
 <ignore-attachments></ignore-attachments>
 <create-subdirectory></create-subdirectory>
 <attachment-download-directory></attachment-download-directory>
 <attachment-overwrite-existing></attachment-overwrite-existing>
 <attachment-ttl></attachment-ttl>
 <max-attachment-size></max-attachment-size>
 <max-pool-threads></max-pool-threads>
 <delete-attachments-on-exit></delete-attachments-on-exit>
 <disk-cleanup-interval></disk-cleanup-interval>
 <file-name-filter>
   <file-name></file-name>
 </file-name-filter>
 <file-type-filter>
   <file-type></file-type>
 </file-type-filter>
 <use-ssl-certificate></use-ssl-certificate>
 <allow-unsigned-certificate></allow-unsigned-certificate>
 <install-certificate></install-certificate>
 <passphrase></passphrase>
 <ignore-peer-name-in-attachment></ignore-peer-name-in-attachment>
 <expand-plaintext-attachment></expand-plaintext-attachment>
 <expand-htmltext-attachment></expand-htmltext-attachment>
 <preferred-bodypart-text-format>Plain</preferred-bodypart-text-format>
</config>

XML template two of the IMAP adapter configuration for a single target

<configs>
     <config>
      ..........................
     </config>
</configs>

The following figure shows an XML sample of the IMAP adapter configuration for a single target.

XML sample of the IMAP adapter configuration for a single target

<config>
   <target>imap.runbox.com</target>
   <port>993</port>
   <user-name>testname</user-name>
   <password encryption-type="Plain">test</password>
   <character-set>UTF-8</character-set>
   <javamail-debug>false</javamail-debug>
   <email-address>test@runbox.com</email-address>
   <protocol>imap</protocol>
   <refresh>10</refresh>
   <mail-timeout/>
   <connection-timeout>60</connection-timeout>
   <process-all-unread-mails>false</process-all-unread-mails>
   <disable-auth-login>false</disable-auth-login>
   <disable-auth-plain>false</disable-auth-plain>
   <delete-after-read>false</delete-after-read>
   <max-messages-per-connection>20000</max-messages-per-connection>
   <expand-plaintext-attachment>true</expand-plaintext-attachment>
   <expand-htmltext-attachment>true</expand-htmltext-attachment>
   <ignore-peer-name-in-attachment>true</ignore-peer-name-in-attachment >
   <ignore-peer-name-in-attachment>true</ignore-peer-name-in-attachment>
</config>

The following figure shows an XML sample of the IMAP adapter configuration for multiple targets.

XML sample of the IMAP adapter configuration for multiple targets

<configs>
     <config name="config1">
           <target>secure.runbox.com</target>
           <port>993</port>
           <user-name>sample_name</user-name>
           <password>sample_password</password>
           <javamail-debug>false</javamail-debug>
           <email-address>sample_name@runbox.com</email-address>
           <protocol>imap</protocol>
           <refresh>20</refresh>
           <mail-timeout>10</mail-timeout>
           <connection-timeout>30</connection-timeout>
           <disable-auth-login>false</disable-auth-login>
           <disable-auth-plain>false</disable-auth-plain>
           <ignore-attachments>false</ignore-attachments>
           <create-subdirectory>true</create-subdirectory>
           <attachment-download-directory>C:\\DownloadAttachments\</attachment-download-directory>
           <attachment-overwrite-existing>true</attachment-overwrite-existing>
           <attachment-ttl>1d</attachment-ttl>
           <max-attachment-size>5</max-attachment-size>
           <max-pool-threads>3</max-pool-threads>
           <delete-attachments-on-exit>false</delete-attachments-on-exit>
           <disk-cleanup-interval>10m</disk-cleanup-interval>
           <file-name-filter>
                 <file-name>a*</file-name>
           </file-name-filter>
           <file-type-filter>
                 <file-type>pdf</file-type>
           </file-type-filter>
           <use-ssl-certificate>true</use-ssl-certificate>
           <allow-unsigned-certificate>true</allow-unsigned-certificate>
           <install-certificate>false</install-certificate>
           <passphrase>changeit</passphrase>
           <ignore-peer-name-in-attachment>false</ignore-peer-name-in-attachment>
     </config>
     <config name="config2">
           <target>imap.runbox.com</target>
           <port>143</port>
           <user-name>imap_test</user-name>
           <password>password</password>
           <javamail-debug>true</javamail-debug>
           <email-address>imap_test@runbox.com</email-address>
           <protocol>imap</protocol>
           <refresh>30</refresh>
           <mail-timeout>30</mail-timeout>
           <connection-timeout>60</connection-timeout>
           <disable-auth-login>true</disable-auth-login>
           <disable-auth-plain>true</disable-auth-plain>
           <ignore-attachments>false</ignore-attachments>
           <create-subdirectory>false</create-subdirectory>
           <attachment-download-directory>C:\Attachments\</attachment-download-directory>
           <attachment-overwrite-existing>true</attachment-overwrite-existing>
           <attachment-ttl>1d</attachment-ttl>
           <max-attachment-size>8</max-attachment-size>
           <max-pool-threads>1</max-pool-threads>
           <delete-attachments-on-exit>true</delete-attachments-on-exit>
           <disk-cleanup-interval>5m</disk-cleanup-interval>
           <file-name-filter>
                 <file-name>T*</file-name>
           </file-name-filter>
           <file-type-filter>
                 <file-type>html</file-type>
           </file-type-filter>
           <use-ssl-certificate>false</use-ssl-certificate>
           <allow-unsigned-certificate>false</allow-unsigned-certificate>
           <install-certificate>false</install-certificate>
           <passphrase></passphrase>
           <ignore-peer-name-in-attachment>true</ignore-peer-name-in-attachment>
     </config>
</configs>

The following figure shows an XML sample of the IMAP adapter configuration with expand plain text or HTML settings.

XML sample of the IMAP adapter configuration with expand plain text or HTML settings

<config>
  <target>imap.runbox.com</target>
 <user-name>user1</user-name>
 <password encryption-type="Plain">1234</password>
 <refresh>20</refresh>
 <protocol>imap</protocol>
 <email-address>user1@runbox.com</email-address>
 <ignore-attachments>false</ignore-attachments>
 <expand-plaintext-attachment>true</expand-plaintext-attachment>
 <expand-htmltext-attachment>true</expand-htmltext-attachment>
 <attachment-download-directory>C:\download_directory</attachment-download-directory>
 <create-subdirectory>true</create-subdirectory>
</config>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*