Properties and command line options

You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options.

The following table describes the properties and command line options specific to this probe. For more information about generic Netcool/OMNIbus properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options
Property name	Command line option	Description
AuthType `string`	-authapop (This is equivalent to AuthType with a value of apop.) -authuserpass (This is equivalent to AuthType with a value of userpass.)	Use this property to specify the authentication method that the probe uses to log in to POP3 email accounts. This property takes the following values: apop: The probe uses APOP authentication. userpass: The probe uses a user name and password combination to authenticate the connection. The default is userpass. Note: The AuthType property is used only for non-TLS POP3 and IMAP connections.
DeleteEmails `boolean`	-deleteemails (This is equivalent to DeleteEmails with a value of true.) -nodeleteemails (This is equivalent to DeleteEmails with a value of false.)	Use this property to specify whether or not the probe deletes emails from the mail server after retrieving them. This property takes the following values: false: The probe leaves the emails on the mail server after retrieval. true: The probe deletes the emails from the mail server after retrieval. The default is true.
EmailSocketTimeOut `integer`	-emailsockettimeout `integer`	Use this property to specify the maximum amount of time (in seconds) that the probe will wait for a response from the email server during connection attempts. The specified value also serves as the maximum amount of time to complete reading messages from the server before timing out. The default is 10.
Filter `string`	-filter `string`	Use this property to specify the search criterion that the probe uses to select messages for retrieval. The default is #NETCOOL. Note: Setting this property to .* (a period followed by an asterisk) retrieves all the emails from the mail server, ignoring the value specified for the FilterField property.
FilterField `string`	-filterfield `string`	Use this property to specify the name of the email field that the probe uses, in conjunction with the Filter property, to select emails for retrieval. The default is Subject. Note: If this property is left empty, the search criterion specified by the Filter property is matched against all fields in the email.
FlushBufferInterval `integer`	-flushbufferinterval `integer`	Use this property to specify how often (in seconds) the probe flushes all alerts in the buffer to the ObjectServer. The default is 0 (which instructs the probe to never flush the alerts to the ObjectServer).
Forgetpop3TopHeader `boolean`	-forgetpop3topheader (This is equivalent to Forgetpop3TopHeader with a value of true.) -noforgetpop3topheader (This is equivalent to Forgetpop3TopHeader with a value of false.)	Use this property to specify whether or not the probe forgets headers that have been retrieved by the POP3 `TOP` command and uses those retrieved by the `RETR` command instead. For details, see Retrieving POP3 headers. This property takes the following values: false: POP3 `TOP` headers are used. true: POP3 `TOP` headers are forgotten and `RETR` headers are used instead. The default is false.
Hostname `string`	-hostname `string`	Use this property to specify the host name of the mail server. The default is mailhost.
KeyStoreFile `string`	-keystorefile `string`	Use this property to specify the location of the keystore file. The default is "". Note: A keystore file is required for TLS connections only.
KeyStorePassword `string`	-keystorepassword `string`	Use this property to specify a password for the keystore file. The default is "". Note: The password must be encrypted. For details, see Specifying a keystore file.
MaxBodyLength `integer`	-maxbodylength `integer`	Use this property to specify the maximum length allowed for the `Body` element. The default is 4096.
MaxHeaderLength `integer`	-maxheaderlength `integer`	Use this property to specify the maximum length allowed for the `Header` element. The default is 4096.
MaxLineCount `integer`	-maxlinecount `integer`	Use this property to specify the maximum number of `Body_nn` elements. The default is 4096.
MaxLineSize `integer`	-maxlinesize `integer`	Use this property to specify the maximum length allowed for the each `Body_nn` element. The default is 1024.
MimeContentType `string`	-mimecontenttype `string`	Use this property to specify which MIME parts of an email the probe parses. This property enables the probe to parse multiple email attachments without creating duplicate data. For example, if you set this property to "text/plain", the probe will only parse the plain text attachment. The default is "" (which instructs the probe to parse all the MIME parts).
MultiLineFormat `string`	-multilineformat `string`	Use this property to specify the line format that the probe uses to uses to build the multi-line elements `$Header` and `$Body`. The default is %s_%d. For details, see Formatting multi-line elements.
ParseTextAttachment `string`	-parsetextattachment `string`	Use this property to specify whether or not the probe parses text-based inline attachments as part of the email body. The default is false. Note: An inline attachment is an attachment that can be seen directly within the email message body. Typical inline attachments are images or text-based content which can be viewed when reading email without the need to first download the attachments to a file storage.
Password `string`	-password `string`	Use this property to specify the password for the target email account. The default is netcool. Note: The password must be encrypted. For details, see Encrypting the email account password.
PollInterval `integer`	-pollinterval `integer`	Use this property to specify the frequency (in seconds) with which the probe checks the mail server for new email. The default is 600.
Port `integer`	-port `integer`	Use this property to specify the port on the mail server to which the probe connects. The following default values apply, depending on the protocol used: POP3: The default is 110 IMAP: The default is 143 POP3 over TLS: The default is 995 IMAP over TLS: The default is 993
Protocol `string`	-protocol `string`	Use this property to specify the protocol that the probe uses to retrieve email messages. This property takes the following values: imap: The probe connects to an IMAP mail server. imaps: The probe connects to an IMAP mail server over a TLS connection. pop3: The probe connects to a POP3 mail server. pop3s: The probe connects to a POP3 mail server over a TLS connection. The default is pop3.
Retry `boolean`	-retry (This is equivalent to Retry with a value of true.) -noretry (This is equivalent to Retry with a value of false.)	Use this property to specify whether or not the probe attempts to reconnect with the mail server after losing the connection. This property takes the following values: false: The probe remains disconnected. true: The probe tries to reconnect with the mail server. The default is false.
TrustStoreFile `string`	-truststorefile `string`	Use this property to specify the location of the truststore file. The preferred method of doing this is to specify the location of the keystore file. For details, see Specifying a keystore file. The default is "". Note: A truststore file is required for TLS connections only.
TrustStorePassword `string`	-truststorepassword `string`	Use this property to specify a password for the truststore file. The default is "". Note: If you have specified the location of the keystore file as the value of the TrustStoreFile property, you can use the keystore password as the value of the TrustStorePassword property also. The password must be encrypted. For details, see Specifying a keystore file.
UseCurrentTime `integer`	-usecurrenttime `integer`	Use this property to specify whether or not the probe uses the current time when setting the `$FirstOccurrence` and `$LastOccurrence` elements. The default is 0.
Username `string`	-username `string`	Use this property to specify the user name for the email account that the probe logs in to. The default is omnibus.