Configuring the BMC Remedyforce monitor adapter

Target

Specifies the host name or the IP address of the POP3 or IMAP mail server

Example: imap.gmail.com

Yes

Port

Specifies the port on which the POP3 or IMAP server listens for events

Default value: 110

No

User Name

Specifies the user name for the account to be monitored

Yes

Password

Specifies the password that corresponds to the <user-name>

The <password> element can contain an encryption-type attribute.

Yes

Encryption Type

Indicates whether the password specified is encrypted

 Valid values: Base64, Plain (default)

No

Javamail Debug

Specifies whether to turn on the debug message logging for JavaMail

Valid values: true, false (default)

No

Email Address

Specifies the email-address of the account to be monitored 

Yes

Protocol

Specifies the email protocol to be used   

Valid values: pop3 (default), imap

Yes

Refresh

Specifies the interval, in seconds, to check for new messages 

Default value: 300 seconds (5 minutes)

No

Mail Timeout

Specifies the time, in seconds, to maintain an established connection 

Default value: 60 seconds (1 minute)

No

Connection Timeout

Specifies the time, in seconds, after which the session expires

Default value: 30 seconds

No

Process all unread mails

Specifies whether to read the unread messages   

Valid values: true, false (default)

No

Disable Auth Login

Prevents the use of non-standard AUTHENTICATE LOGIN command with the POP servers 

Valid values: true, false (default)

No

Disable Auth Plain

Prevents the use of AUTHENTICATE PLAIN command with the POP servers 

Valid values: true, false (default)

No

Delete After Read

Determines whether a message must be deleted from the server after it is read by the adapter 

You must not use the <delete-after-read> element if you configure multiple POP mail monitor adapters to monitor the same email address. Exceptions are generated in the grid.log file and messages might be deleted before all the adapters read the message. 

Valid values: true, false (default)

Conditional; required to use the <max-messages-per-connection> element

Max Messages Per Connection

Specifies the maximum number of messages to be pulled per connection attempt 

If there are more messages on the server than the number specified, they are retrieved during the next polling. Use the <max-messages-per-connection> element only when the value of the <delete-after-read> element is true. 

Default value: 20

No

Ignore Attachments

Indicates whether the attachments must be ignored and excluded from the adapter event 

Valid values: true, false (default) (attachments permitted)

No

Create Subdirectory

Indicates whether each attachment must be downloaded into a separate directory 

Valid values: true, false (default) (download all the attachments into a single directory)

Subdirectory name format:  attachment-download-directory/ <email-address>/message ID/ timestamp of download in epoch time{_} 

Sample subdirectory value: /mail/downloads/user@company.com/ Message1/1196967357

No

Attachment Download Directory

Specifies the path and the directory where the attachments on the monitored email messages are downloaded 

This directory must exist on each peer on which the adapter is enabled. If this directory is not available, the configuration is considered invalid, and the adapter is not enabled. 

Default value: Java temp directory

No

Attachment Overwrite Existing

Indicates whether an attachment with the same file name has already been downloaded and overwrites that file with the current attachment 

If the value of the <create-subdirectory> element is true, the attachments are downloaded, ignoring the <attachment-overwrite-existing> element. 

Valid values: true, false (default) (preserves the original file)

No

Attachment Ttl

Specifies the period for which an attachment is permitted to reside in the download directory before being deleted 

You can specify a numeric value followed by a time designator   

Valid values for time designators:

• m - minutes
• h - hours
• d - days   
  Default value: 10d

No

Max Attachment Size

Specifies the maximum file size, in MB, which can be attached to a mail message 

The maximum file size is defined per attachment; the total value of all the files can be greater, provided each file is less than or equal to the default value. 

Default value: 10 MB

No

Max Pool Threads

Specifies the maximum number of threads that can be used to download the attachments simultaneously 

Default value: 1

No

Delete Attachments On Exit

Deletes all downloaded attachments when the adapter is stopped or disabled

Valid values: true, false (default)

No

Disk Cleanup Interval

Specifies the interval after which the attachments that have exceeded the <attachment-ttl> period must be deleted

You can specify a numeric value followed by a time designator. 

Valid values for time designators:

• m - minutes 
• h - hours 
• d - days 
  Default value: 10m

No

File Name Filter

Contains the elements that specify the file name criteria for downloading a file 

You can download only those files that satisfy the filter criteria.

Conditional; required if the <file-name> element is present

File Type Filter

Contains the elements that specify the file type criteria for downloading an attachment 

You can download only those files that satisfy the filter criteria.

Conditional; required if the <file-type> element is present

Use Ssl Certificate

Specifies whether SSL certificates are used for authentication   

Valid values: true, false (default)

No

Allow Unsigned Certificate

Specifies whether unsigned certificates are permitted for SSL authentication

Valid values: true, false (default)

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 

If the certificate is not verified, it is not installed. To install certificates successfully, the user who installs the peer that executes the request must have read or write access on the keystore file. 

Certificates are uninstalled when the adapter is disabled on a peer. If a BMC Atrium Orchestrator peer is uninstalled without disabling this adapter, any certificates installed by the adapter continue to exist. 

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

Valid values: true, false (default)

No

Passphrase

Specifies the password to the keystore file (cacerts) local to the BMC Atrium Orchestrator peer 

This value must match the passphrase in the keystore. You can change the passphrase using a keytool. If you make a change, you must update this value to reflect the new passphrase. 

Default value: changeit

No

Expand Plaintext Attachment

Specifies whether the plain text content of a message that is sent as an attachment appears in the <bodypart> element in an adapter event 

Valid values: true, false (default) 

If the value of <expand-plaintext-attachment> element is set to  true, the plain text content of the message appears inside the <bodypart>  element in an adapter event. Otherwise, the plain text content of the message appears inside the  <attachment> element in an adapter event.

No

Expand Htmltext Attachment

Specifies whether the HTML data content of a message that is sent as an attachment appears in an adapter event 

Valid values: true, false (default) 

If the value of the <expand-htmltext-attachment> element is set to true, the HTML data content of the message appears inside the <bodypart> element in an adapter event. Otherwise, the HTML data content of the message appears inside the <attachment> element in an adapter event.

No

Character Set

Specifies the supporting CharSet 

The character set includes identifiers describing a series of universal characters.

If you do not provide the <character-set> element in the configuration, then the email message is parsed based on the CharSet returned in the Content-Type of the email.

No

None

Specifies whether to return the bodypart in the email messages in either of the following formats:

• Plain (default)
• HTML

Note: This element is not available in the Form View. You can add it by switching to the XML view.

No