Settings in the EmailDaemon.properties file
The email engine internally uses most configuration settings with their default values. The EmailDaemon.properties file lets you specify values other than the defaults for these settings.
The following table lists the properties and their permissible values that you can specify in EmailDaemon.properties to adjust the performance of the email engine. After adding or altering these settings, you must stop and restart the email engine for the changes to take effect.
For specific troubleshooting issues, see Troubleshooting Remedy Email Engine and its subtopics.
Best practice
We recommend that you use the AR System Configuration Generic UI form (not the EmailDaemon.properties file) to modify the centralized configuration settings. For more information on the email engine centralized configuration settings, see Configuration settings C-D.
For the settings that are not centralized, use the EmailDaemon.properties file to modify these settings.
Performance and configuration settings for the BMC Remedy Email Engine
Settings | Centralized configuration setting | Definitions | Values | Related Functionality | Related Protocol |
---|---|---|---|---|---|
com.bmc.arsys.emaildaemon.AdditionalMailHeaders | Yes | Specifies additional email headers. Separate the additional email headers with commas. See Adding extra custom headers to outgoing SMTP emails. | Default value: X-Loop-Detect | Outgoing | SMTP |
com.bmc.arsys.emaildaemon.ARDATE | Yes | Specifies the date and time format that the BMC Remedy Email Engine uses for parsing date and time strings given in the incoming mails. MMMMM dd, yyyy HH:mm:ss z is equivalent to December 21, 2009 12:08:56 PDT. | Incoming | All Supported | |
com.bmc.arsys.emaildaemon.ARDATEONLY | Yes | Specifies the date format that BMC Remedy Email Engine uses for parsing date strings given in incoming mails. MMMMM dd, yyyy is equivalent to December 21, 2009. | Incoming | All Supported | |
com.bmc.arsys.emaildaemon.ARTIMEONLY | Yes | This setting lets you specify the time format used by BMC Remedy Email Engine for parsing time strings given in incoming mails. HH:mm:ss z is equivalent to 12:08:56 PDT. | Incoming | All Supported | |
com.bmc.arsys.emaildaemon. ARSystemHandler.level | Yes | Specifies the log level for email engine based on which the logs are saved in the AR System Email Error Logs form. Valid values:
| Incoming and Outgoing | All Supported | |
com.bmc.arsys.emaildaemon.ContentTypeWithCharset | Yes | This setting indicates whether to send the charset property in the Content-Type header of an outgoing message. If you do not want the charset string to be present in the Content-Type header, set this property to False. |
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.ChunkSize | Yes | Specifies the number of entries to return when the BMC Remedy Email Engine makes a call to the AR System server. | Default value: 100 Note: The maximum value is also 100. | Outgoing | All Supported |
com.bmc.arsys.emaildaemon.CommaValidAddressSeparator | Yes | Specifies whether you can use a comma as a separator when entering multiple addresses in the To and CC fields. If user names in the mail server contain commas, set this property to false (usually needed only when using the MAPI protocol). For example, if names are stored on the mail server as: |
| Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.companionServername | Yes | The companion server name in the emaildaemon.properties file (com.bmc.arsys.emaildaemon.companionServername) uniquely identifies the Email Engine host. The companion server name is the fully qualified domain name (FQDN) of the host and is the same as the Server-Connect-Name for ARServer only when the email engine is deployed along with AR System. If the email engine is deployed as a separate service, then the companion server name may be different. | FQDN of the host | Incoming and outgoing | All supported |
com.bmc.arsys.emaildaemon.Exchange-Wait-Time | Yes | Specifies the amount of time in milliseconds for which the BMC Remedy Email Engine waits before processing the next incoming message, when there are more messages residing on the Exchange Server. | Default value: 1 | Incoming | All supported |
com.bmc.arsys.emaildaemon.FetchUserGroupInfoOnDemand | Yes | Specifies whether to fetch the user and group information about demand as opposed to loading all users and groups at startup. If there are many users or groups, you might want to set this property to true to reduce the startup time for email. |
| Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.getReplyToWithFromAddress | Yes | Determines whether the outgoing message header should contain the Reply To field and what its value should be.getReplyToWithFromAddress is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to true. If you add the property but do not specify a value, it is considered as false. The effect of using this property is as follows:
|
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.IMAPTimeout | Yes | Specifies whether to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an IMAP timeout, the email engine waits for the timeout interval and then marks the queued message as erroneous. IMAPTimeout is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to true. |
| Incoming | IMAP |
com.bmc.arsys.emaildaemon.IMAPTimeoutPeriod | Yes | Specifies the duration in number of seconds to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an IMAP timeout, the email engine waits for this interval and then marks the queued message as an erroneous. IMAPTimeoutPeriod is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to any positive integer. | Incoming | IMAP | |
com.bmc.arsys.emaildaemon.IncomingConnectionRecycleSize | Yes | Specifies the default number of email messages the email engine receives before the connection is closed and reopened. In email engine, the connection with the mail server was closed only after reading all incoming messages. Consequently, if the email engine crashed or hung before the connection was closed, it was possible that messages marked for deletion would not be deleted from the mail server. This property helps you avoid that situation. | Default value: 100 | Incoming | All Supported |
com.bmc.arsys.emaildaemon.IncomingMessagesQueueSize | Yes | Specifies the message queue size (number of emails). The Receiver module writes messages to the queue, and the Execution module reads messages from this queue to parse and execute. The Receiver module still writes messages to the server in AR System Email Messages form, but the Execution module reads the message from the message queue instead of from the server. This reduces the traffic to the AR System server and improves the performance. | Default value: 100 | Incoming | All Supported |
com.bmc.arsys.emaildaemon.instructionCacheSize | Yes | Specifies the number of instructions to be stored in the cache, which is used to improve performance. If the value of this property is set to 15, the cache already contains 15 instructions, and another instruction is to be added, then the oldest instruction is removed to accommodate the newest one. Note: If any changes are made to the BMC Remedy AR System Email Instructions form, the instruction cache is flushed based on the setting of the serverName.Interval property. | Default value: 20 | Incoming | All Supported |
com.bmc.arsys.emaildaemon.level | Yes | Specifies the log level for email engine based on which the logs are generated in the email.log file. Valid values:
| Incoming and Outgoing | All Supported | |
com.bmc.arsys.emaildaemon.logfileName | Enables users to specify the log file path Note: Once the user specifies a file path, email engine logs that user defined file only when it connects to AR server. if any error occurred before connecting to Centralized configuration form then logs will be stored into default log file path. | Default value: emailEngineInstallDir/AREmail/Logs/email.log | |||
com.bmc.arsys.emaildaemon.logfilesize | Specifies the maximum size of the log file in bytes If the file size exceeds this limit, a new file is created. | Default value: Unlimited | |||
com.bmc.arsys.emaildaemon.Mailboxes | Yes | If you run multiple instances of the email engine on a single server, this property specifies which mailboxes should the email engine process. The value of this property should contain comma-separated mailbox names; the email engine only processes these mailboxes. If you do not specify a value, the email engine processes all of the mailboxes configured for the server. | Incoming and Outgoing | All Supported | |
com.bmc.arsys.emaildaemon.MailboxPollingUnitIsMinutes | Yes | Specifies whether the polling interval is to be considered in minutes (as configured in AR System Email Configuration) or seconds. The email engine interprets the value of this property as follows:
Note: Whatever measure of unit you select applies to all configured mailboxes that are enabled. |
| Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.MaxAttachSize and com.bmc.arsys.emaildaemon.MaxAttachSizeFileExtensions | Yes | Specifies the attachment types that you want to permit in an email message and the maximum size of each attachment.MaxAttachSize specifies the maximum size limit for attachments, whereas MaxAttachSizeFileExtensions specifies the file types by using comma-separated extensions. These properties must be used together to impose limits on email attachments of specific file types. For example, to set the maximum size of .doc, .pdf, and .xls attachments to 1000000 bytes (1 MB), use the following syntax: com.bmc.arsys.emaildaemon.MaxAttachSize=1000000 com.bmc.arsys.emaildaemon. MaxAttachSizeFileExtensions=doc,pdf,xls The size limit is not imposed on files whose extensions are not specified by using MaxAttachSizeFileExtensions. Email messages with attachments that exceed this limit are logged to the AR System Email Error Logs form. Optionally, you can create workflow for this form to process such messages separately. |
| Incoming | All Supported |
com.bmc.arsys.emaildaemon.MBOXFromLineWith-At-The-Rate-Sign | Yes | The email engine interprets the value of this property as follows:
|
| Incoming and Outgoing | MBOX |
com.bmc.arsys.emaildaemon.Monitor | Yes | Specifies the interval in minutes between checks to see if all the threads are functioning properly. Note: If the monitoring system detects that a thread has failed, it restarts the thread. | Default value: 30 minutes | Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.NumberOfSenderThreads | Yes | Specifies the number of sender threads that the email daemon uses for each outgoing mailbox. The optimum number of threads depends on many factors including the number of mailboxes, the hardware configuration, and so on. | Permissible range of values: 1 through 20 Default value: 4 | Outgoing | All Supported |
com.bmc.arsys.emaildaemon.OutgoingMessagesQueueSize | No | Specifies the size of the queue that the email daemon maintains for outgoing messages. The optimum number of message queue size to be specified depends on the load on the email daemon. Note: This value is used to determine when to query the database. If you set a very high value, the database is queried too often, which might reduce the performance. | Default value: 100 | Outgoing | All Supported |
com.bmc.arsys.emaildaemon.POP3Timeout | Yes | Specifies whether to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an POP3 timeout, the email engine waits for the timeout interval and then marks the queued message as erroneous. POP3Timeout is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to true. When you set POP3Timeout to true, the POP3TimeoutPeriod property is used. |
| Incoming | POP3 |
com.bmc.arsys.emaildaemon.POP3TimeoutPeriod | Yes | Specifies the duration in number of seconds to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an POP3 timeout, the email engine waits for this interval and then marks the queued message as an erroneous. POP3TimeoutPeriod is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to any positive integer. | Incoming | POP3 | |
com.bmc.arsys.emaildaemon.RMIPORT = 1100 | No | Specifies the port number for remote method invocation (RMI). This feature is used with the EmailAdminAgent.jar file to stop, suspend, resume, or change logging level of the email engine at runtime. | Default value: 1100 | Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.SaveSentItem | Yes | Specifies whether to retain messages in the Email Messages form after sending. To delete sent messages from the Email Messages form, set this property to False. |
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.securityCacheSize | Yes | Specifies the number of security keys to be stored in the cache. If the value of this property is set to 15, the cache already contains 15 security keys, and another key is to be added, then the oldest key is removed to accommodate the newest one. Note: If any changes are made to the BMC Remedy AR System Email Security form, the security cache is flushed based on the setting of the serverName.Interval property. | Default value: 20 | Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.SendEmailSetSize | Yes | Specifies the number of outgoing emails to query at a time. | Default value: 100 | Outgoing | All Supported |
com.bmc.arsys.emaildaemon.serverName.Authentication | No | Specifies a string if your AR System server requires authentication information before handling requests. For example, com.bmc.arsys.emaildaemon.myRemedyServer.Authentication=myAuthenticationString | |||
com.bmc.arsys.emaildaemon.serverName.Interval | No | Specifies the interval in minutes after which to check with the server for the following:
For example, om.bmc.arsys.emaildaemon.myRemedyServer.Interval=30 | Default value: 30 | ||
com.bmc.arsys.emaildaemon.serverName.Language | No | Specifies the language that the email engine must use. For example, com.bmc.arsys.emaildaemon.myRemedyServer.Language=en_US | Default value: en_US | ||
com.bmc.arsys.emaildaemon.serverName.Password | Yes | Specifies an encrypted password for the Remedy application service user. For example, com.bmc.arsys.emaildaemon.myRemedyServer.Password=myP@$$w0RD | |||
com.bmc.arsys.emaildaemon.serverName.RPC | No | Specifies the RPC port number that the AR System server uses if you have configured a private server to be used with the email engine. com.bmc.arsys.emaildaemon.myRemedServer.RPC=0 | |||
com.bmc.arsys.emaildaemon.serverName.TCP | No | Specifies the TCP port number that the AR System server uses if it is not using the BMC Remedy AR System portmapper. For example, com.bmc.arsys.emaildaemon.myRemedyServer.TCP=9100. | |||
com.bmc.arsys.emaildaemon.Servers | No | Specifies the name of the AR System server that the email engine interacts with. | |||
com.bmc.arsys.emaildaemon.SMTPTimeout | Yes | Specifies whether to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an SMTP timeout, the email engine waits for the timeout interval and then marks the queued message as erroneous.SMTPTimeout is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to true. If you add the property but do not specify a value, it is considered as false. If you use these properties, BMC recommends the following
|
| Outgoing | SMTP |
com.bmc.arsys.emaildaemon.SMTPTimeoutPeriod | Yes | Specifies the duration in number of seconds to wait before cancelling an attempt to connect to the mail server and generating an error. In case of an SMTP timeout, the email engine waits for this interval and then marks the queued message as an erroneous.SMTPTimeoutPeriod is not used by default. If you want the email engine to use this property, you must add it to EmailDaemon.properties and set its value to any positive integer (upper limit depends on the platform). If you add the property but do not specify a value, it is considered as half the polling interval that is set for outgoing mailboxes. Note:SMTPTimeoutPeriod is dependent on SMTPTimeout ; it works only when SMTPTimeout is set to true. Recommendation for using the SMTP timeout properties
| Outgoing | SMTP | |
com.bmc.arsys.emaildaemon.SortMessages | Yes | Specifies whether to process messages with a higher priority setting first. |
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.StoreInstructions | Yes | Specifies whether to store instructions and instruction parameters in the AR System server. If set to true, the email engine retains data in the Email Instructions and Instruction Parameters forms for troubleshooting. Then, you must delete this data explicitly. The Execution module in the BMC Remedy Email Engine handles both the parsing and execution of messages. There will be one message queue created for each Incoming mailbox. By default, instructions are not stored in the server. |
| Incoming | All supported |
com.bmc.arsys.emaildaemon.SynchronizedLoggingMode | Yes | This property is not available by default. You can add it if required. If this property is not present in EmailDaemon.properties, or if it is present but set to false, the bulk API logging mode is used. If this property is present in EmailDaemon.properties and its value set to true, then the synchronized logging mode is used. Note: The email engine's performance might degrade when synchronized logging is enabled, because all the email engine threads are suspended while processing the synchronized logs. Synchronized logging continues to occur periodically, and control is restored to the threads only after the logging is over. |
| Incoming and Outgoing | All Supported |
com.bmc.arsys.emaildaemon.templateCacheSize | Yes | Specifies the number of email templates to be stored in the cache to improve the performance. If the value of this property is set to 15, the cache already contains 15 templates, and another template is to be added, then the oldest template is removed to accommodate the newest one. Note: If any changes are made to the BMC Remedy AR System Email Templates form, the templates cache is flushed based on the setting of the serverName.Interval property. | Default value: 20 | Incoming | All Supported |
com.bmc.arsys.emaildaemon.URLWithHrefTag | Yes | Specifies whether an <a href> tag is placed around a URL in an HTML message. If the setting is true, the <a href> tag is used. If the setting is false, the URL is not enclosed in an <a href> tag. |
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.UseNameIfNoEmailAddress | Yes | Specifies whether to retain display names that do not have email addresses associated with them in the To, CC, or BCC fields. If the setting is true, the display names are not removed from the To, CC, or BCC fields. If the setting is false, the display names are removed from the To, CC, or BCC fields. Note: The email engine checks for email addresses associated with display names only on the User form and not on the Exchange server. |
| Outgoing | All Supported |
com.bmc.arsys.emaildaemon.UserChunkSize | Yes | Specifies the number of users (records from the User form) to retrieve from the AR System server at one time. This setting can be used to tune the email engine's performance. | Default value: 5000 | Outgoing | All Supported |
com.bmc.arsys.emaildaemon.AdminAddresses | Yes | Specifies the email address of the administrator. If a database transaction fails while storing an incoming message, the email engine forwards the original mail to this email address, so that it is retained. An example of a transaction failure could be when the database is full and cannot save anymore incoming email messages. You can specify multiple addresses separated by commas. Note: This property can be used only when the BMC Remedy Email Engine does not capture the error out incoming email messages in the BMC Remedy AR System Email Error Messages Form. | Default value is set to the administrator address specified during installation. | Incoming | All Supported |
com.bmc.arsys.emaildaemon.ModifyKeyCharacter | No | The modify key is recognized by ## special characters. This setting allows you to configure MODIFY_KEY by allowing configuration of special characters to @@ by using ModifyKeyCharacter parameter. | If ModifyKeyCharacter not configured then default value is ##. | Email Based approvals | NA |
Related topic
Debugging options for the BMC Remedy Email Engine
Comments
Log in or register to comment.