Configuring the POP adapter
The validity of installed certificates is checked once every 24 hours. The first check is conducted 24 hours after enabling the adapter. BMC recommends that you do not include unused elements in the adapter configuration because they might cause errors.
Adapter type: ro-adapter-pop_vv.rr.nn
To configure the POP mail adapter, see Configuring base adapters.
The following table describes the adapter configuration elements for the POP mail adapter 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 POP mail adapter
UI label | Element | Description | Required |
---|---|---|---|
Target |
| Specifies the host name or the IP address of the POP3 server Note You can specify an IPv6 address for the | Yes |
Port |
| Specifies the port on which the POP3 server listens | No |
User Name |
| Specifies the user name for the account to be monitored | Yes |
Password |
| Specifies the password that corresponds to the | Yes |
Encryption Type |
| Indicates whether the password specified is encrypted; is an attribute of the | No |
Character Set |
| Specifies the supporting CharSet | No |
Javamail Debug |
| Indicates that debug message logging for JavaMail must be turned on | No |
Email Address |
| Specifies the email address of the account to be monitored | Yes |
Protocol |
| Specifies the email protocol to be used | Yes |
Refresh |
| Specifies the frequency, in seconds, to check for new messages | No |
Mail Timeout |
| Specifies the time, in seconds, to maintain an established connection | No |
Connection Timeout |
| Specifies the time, in seconds, to wait when establishing a connection | No |
Disable Auth Login |
| Prevents the use of non-standard | No |
Disable Auth Plain |
| Prevents the use of | No |
Delete After Read |
| Determines whether a message must be deleted from the server after it is read by the adapter | Conditional; required to use the |
Max Messages Per Connection |
| Specifies the maximum number of messages to be pulled per connection attempt | No |
Ignore Attachments |
| Indicates whether attachments must be ignored and excluded from the adapter event | No |
Expand Htmltext Attachment |
| Specifies whether the HTML data content of a message that is sent as an attachment appears in the | No |
Expand Plaintext Attachment |
| Specifies whether the plain text content of a message that is sent as an attachment appears in the | No |
Create Subdirectory |
| Indicates whether each attachment must be downloaded into a separate directory
| No |
Attachment Download Directory |
| Specifies the path and the directory into which attachments on the monitored email messages are downloaded | No |
Attachment Overwrite Existing |
| Indicates if an attachment with the same file name has already been downloaded and overwrites that file with the current attachment | No |
Attachment Ttl |
| Specifies the time an attachment is permitted to reside in the download directory before being deleted | No |
Max Attachment Size |
| Specifies the maximum file size, in MB, which can be attached to a mail message | No |
Max Pool Threads |
| Specifies the maximum number of threads to be used to download attachments in parallel | No |
Delete Attachments On Exit |
| Deletes all downloaded attachments when the adapter is stopped or disabled | No |
Disk Cleanup Interval |
| Specifies the interval at which the deletion of attachments that have exceeded the | No |
File Name Filter |
| Contains the elements that specify the file name criteria for a file download | Conditional; required if the |
File Name |
| Specifies the criteria for an attached file to be downloaded, based on the file name | No |
File Type Filter |
| Contains the elements that specify the file type criteria for downloading a file attachment | Conditional; required if the |
File Type |
| Specifies the criteria for an attached file to be downloaded, based on the file type
| No |
Use Ssl Certificate |
| Specifies whether SSL certificates are used for authentication. Note Set this element to true, if you want to establish a secure connection with the specified target. | No |
Allow Unsigned Certificate |
| Specifies whether unsigned certificates are permitted for SSL authentication Note You do not need this element, if Set the value of this element to true, if you are using self-signed SSL certificates (a common practice). | No |
Install Certificate |
| Updates the default keystore file, java.Home\jre\lib\security\cacerts with the certificates sent by the target URL during the SSLHandshake Note You do not need this element if <use-ssl-certificate> is false or blank. Set the value of this element to true, if you prefer to have security certificates installed automatically (a common practice). Set the value of this element to false if you prefer to manually export the security certificate from the specified target server and manually import it into the BMC Atrium Orchestrator's local peer's cacerts file (a rare practice). | No |
Passphrase |
| Specifies the password to the keystore file (cacerts) local to the BMC Atrium Orchestrator peer. Note You do not need this element, if This value must match the passphrase in the keystore. You can change the passphrase using keytool. If you make a change, you must update this value to reflect the new passphrase. | No |
Preferred Bodypart Text Format |
| Specifies whether to return the bodypart in the email messages in either of the following formats:
| No |
The following figures show XML templates of the adapter configuration for the POP adapter for a single target.
XML template one of the POP 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>pop3</protocol>
<refresh></refresh>
<mail-timeout></mail-timeout>
<connection-timeout></connection-timeout>
<disable-auth-login></disable-auth-login>
<disable-auth-plain></disable-auth-plain>
<delete-after-read></delete-after-read>
<max-messages-per-connection></max-messages-per-connection>
<create-subdirectory></create-subdirectory>
<ignore-attachments></ignore-attachments>
<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>
<preferred-bodypart-text-format>plain</preferred-bodypart-text-format>
</config>
XML template two of the POP adapter configuration for a single target
<configs>
<config>
..........................
</config>
</configs>
The following figure shows an XML sample of the POP adapter configuration for a single target.
XML sample of the POP adapter configuration for a single target
<config>
<target>pop.gawab.com</target>s
<port>110</port>
<user-name>testname</user-name>
<password encryption-type="Plain">aa</password>
<character-set>UTF-8</character-set>
<javamail-debug>false</javamail-debug>
<email-address>aa@gawab.com</email-address>
<protocol>pop3</protocol>
<refresh>10</refresh>
<mail-timeout/>
<connection-timeout>60</connection-timeout>
<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>
</config>
The following figure shows an XML sample of the POP adapter configuration for multiple targets.
XML sample of the POP adapter configuration for multiple targets
<configs>
<config name="config1">
<target>secure.runbox.com</target>
<port>995</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>pop3</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>
<delete-after-read>false</delete-after-read>
<max-messages-per-connection>10</max-messages-per-connection>
<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>
</config>
<config name="config2">
<target>pop.runbox.com</target>
<port>110</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>pop3</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>
<delete-after-read>false</delete-after-read>
<max-messages-per-connection>10</max-messages-per-connection>
<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>false</use-ssl-certificate>
<allow-unsigned-certificate>false</allow-unsigned-certificate>
<install-certificate>false</install-certificate>
<passphrase>changeit</passphrase>
</config>
</configs>
The following figure shows an XML sample of the POP adapter configuration with attachment download settings.
XML sample of the POP adapter configuration with attachment download settings
<config>
<target>pop.runbox.com</target>
<user-name>user1</user-name>
<password encryption-type="Plain">1234</password>
<refresh>20</refresh>
<protocol>pop3</protocol>
<email-address>user1@runbox.com</email-address>
<ignore-attachments>false</ignore-attachments>
<attachment-download-directory>${CDPMachineTempDir}
</attachment-download-directory>
<max-attachment-size>1</max-attachment-size>
</config>
Comments
Log in or register to comment.