This documentation applies to the 8.1 version of Remedy Action Request System, which is in "End of Version Support."

To view the latest version, select the version from the Product version menu.

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 BMC Remedy Email Engine and its subtopics.


Performance and configuration settings for the BMC Remedy Email Engine

Settings

Definitions

Values

Related Functionality

Related Protocol

com.bmc.arsys.emaildaemon.AdditionalMailHeaders

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

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

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

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.ContentTypeWithCharset

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.

  • True (Default)
  • False

Outgoing

All Supported

com.bmc.arsys.emaildaemon.ChunkSize

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

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:
Smith, John and
Cho, Rick
You would need to use semicolons to separate the addresses:
Smith, John; Cho, Rick

  • True (Default)
  • False

Incoming and Outgoing

All Supported

com.bmc.arsys.emaildaemon.Exchange-Wait-Time

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

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.

  • True
  • False (Default)

Incoming and Outgoing

All Supported

com.bmc.arsys.emaildaemon.getReplyToWithFromAddress

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:

  • If no values are provided in the Reply To Address field of the outgoing mailbox configuration form and the Reply To field of the messages form, andthe value of this property is:
    • false (or not provided) — The Reply To field is not included in the outgoing message header.
    • true — The Reply To field is included in the outgoing message header, and its value is the address in the From field of the messages form.
  • If the Reply To Address field of the outgoing mailbox configuration form or the Reply To field of the messages form contains a value, the message header will contain the Reply To header value as set in the message, regardless of value of this property.
  • True (Default)
  • False

Outgoing

All Supported

com.bmc.arsys.emaildaemon.IMAPTimeoutSpecifies 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. 
  • True
  • False (default)
 
 Incoming IMAP
com.bmc.arsys.emaildaemon.IMAPTimeoutPeriodSpecifies 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

Specifies the default number of email messages the email engine receives before the connection is closed and reopened. In the 5.1 and 5.1.1 releases of the 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

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

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.Mailboxes

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

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:

  • true — Consider the polling interval in minutes.
  • false — Consider the polling interval in seconds.

Note: Whatever measure of unit you select applies to all configured mailboxes that are enabled.

  • True (Default)
  • False

Incoming and Outgoing

All Supported

com.bmc.arsys.emaildaemon.MaxAttachSize and com.bmc.arsys.emaildaemon.MaxAttachSizeFileExtensions

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.

Note: If you want the email engine to use these settings, you must add them to EmailDaemon.properties and set their values.

For example, if you want to limit the file size for email attachments with extensions such as .doc, .pdf, and .xls to 1000000 bytes, you must add the following lines in the email daemon properties file:

com.bmc.arsys.emaildaemon.MaxAttachSize=1000000

com.bmc.arsys.emaildaemon.MaxAttachSizeFileExtensions=doc,pdf,xls

Note: These properties must be used together to impose limits on email attachments of specific file types.

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.

  • True
  • False (Default)

Incoming

All Supported

com.bmc.arsys.emaildaemon.MBOXFromLineWith-At-The-Rate-Sign

The email engine interprets the value of this property as follows:

  • true — BMC Remedy Email Engine fetches only those messages that contain the @ sign in the "from line" (from address).
  • false — BMC Remedy Email Engine fetches all the messages.
  • True
  • False (default)

Incoming and Outgoing

MBOX

com.bmc.arsys.emaildaemon.Monitor

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

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.POP3Timeout

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. 

  • True
  • False (default)
Incoming  POP3
com.bmc.arsys.emaildaemon.POP3TimeoutPeriodSpecifies 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. IncomingPOP3 

com.bmc.arsys.emaildaemon.OutgoingMessagesQueueSize

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.RMIPORT = 1100

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

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.

  • True (Default)
  • False

Outgoing

All Supported

com.bmc.arsys.emaildaemon.securityCacheSize

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

Specifies the number of outgoing emails to query at a time.

Default value: 100

Outgoing

All Supported

com.bmc.arsys.emaildaemon.serverName.Authentication

Specifies a string if your AR System server requires authentication information before handling requests.

com.bmc.arsys.emaildaemon.serverName.Interval

Specifies the interval in minutes after which to check with the server for the following:

  • Configuration updates (for example, if you modified records in the BMC Remedy AR System Email Mailbox Configuration form)
  • Updates to the templates (for example, if you modified templates in the BMC Remedy AR System Email Templates form)
  • Any changes done to the forms on the server (for example, if you added or deleted any field on any form)

Default value: 30

com.bmc.arsys.emaildaemon.serverName.Language

Specifies the language that the email engine must use.

Default value: en_US

com.bmc.arsys.emaildaemon.serverName.PasswordSpecifies an encrypted password for the Remedy application service user


com.bmc.arsys.emaildaemon.serverName.RPC

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.serverName.TCP

Specifies the TCP port number that the AR System server uses if it is not using the BMC Remedy AR System portmapper.

com.bmc.arsys.emaildaemon.Servers

Specifies the name of the AR System server that the email engine interacts with.

com.bmc.arsys.emaildaemon.SMTPTimeout

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.

Note: If you use the email engine properties com.bmc.arsys.emaildaemon.SMTPTimeout and com.bmc.arsys.emaildaemon.SMTPTimeoutPeriod, you might encounter issues with outgoing e-mail messages.
After a timed-out connection is restored, messages marked as Error (in the Send Message field) are not sent consistently---some messages are sent successfully, while others are not. This seems to be a JavaMail issue for which no workaround is available.

If you use these properties, BMC recommends the following SMTPTimeoutPeriod values to avoid encountering this issue:

  • 40000 messages — 30 seconds
  • 70000 messages — 60 seconds
  • 100000 messages — 90 seconds
    These settings can work correctly with the maximum permissible number (20) of Sender threads. However, BMC recommends using a value that is optimum for your configuration.
  • True
  • False (Default)

Outgoing

SMTP

com.bmc.arsys.emaildaemon.SMTPTimeoutPeriod

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
If you use these properties, BMC recommends the following SMTPTimeoutPeriod values to avoid encountering this issue:

  • 40000 messages — 30 seconds
  • 70000 messages — 60 seconds
  • 100000 messages — 90 seconds
    These settings can work correctly with the maximum permissible number (20) of Sender threads. However, BMC recommends using a value that is optimum for your configuration.

Outgoing

SMTP

com.bmc.arsys.emaildaemon.SortMessages

Specifies whether to process messages with a higher priority setting first.

  • True
  • False (Default)

Outgoing

All Supported

com.bmc.arsys.emaildaemon.StoreInstructions

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.

  • True
  • False (Default)

Incoming

All supported

com.bmc.arsys.emaildaemon.SynchronizedLoggingMode

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.

  • True
  • False (Default)

Incoming and Outgoing

All Supported

com.bmc.arsys.emaildaemon.templateCacheSize

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

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.

  • True (Default)
  • False

Outgoing

All Supported

com.bmc.arsys.emaildaemon.UseNameIfNoEmailAddress

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.

  • True (Default)
  • False

Outgoing

All Supported

com.bmc.arsys.emaildaemon.UserChunkSize

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

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

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.
In EmailDaemon.properties, set the value as, com.bmc.arsys.emaildaemon.ModifyKeyCharacter=@@.

If the ModifyKeyCharacter not configured then the default value is ##.Email based approvalsNA

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments

  1. Lj Longwing

    What about

    com.bmc.arsys.emaildaemon.OutgoingConnectionRecycleSize

    ?

    Apr 23, 2013 02:36
  2. Lisa Greene

    Thanks, LJ.  I'll research your question with our developers.

    Apr 23, 2013 05:00
  3. Aparna Saxena

    Hi LJ, thanks for your comment.

    This property is no longer in use, and so has been removed from the EmailDaemon.properties file.

    Thanks,

    Aparna

     

    Apr 24, 2013 01:36
  4. Jose Maldonado

    The link under both the com.bmc.arsys.emaildaemon.SMTPTimeout and the com.bmc.arsys.emaildaemon.SMTPTimeoutPeriod sections does not work.  See 'Recommendation for using the SMTP timeout properties' loops back to the same URL and never takes you to the right URL

    Jun 06, 2014 10:16
    1. Prachi Kalyani

      Hello Jose,

      Sorry for the delay. I have updated the documentation to include information about Recommendations for using the SMTP timeout properties.

      Thanks,

      Prachi

      May 15, 2015 03:49
  5. Maheshwari L

    Do the parameters 'com.bmc.arsys.emaildaemon.MaxAttachSize' and 'com.bmc.arsys.emaildaemon.MaxAttachSizeFileExtensions' have any default values?

    My test environment does not have these entries in the email daemon properties file.

    Jan 13, 2015 11:51
    1. Sujata Pawar

      Hello Maheshwari,

      Thank you for your comment. I will verify this with the concerned SME and get back to you as soon as possible.

      Regards,

      Sujata

      Jan 14, 2015 12:20
      1. Sujata Pawar

        Hello Maheshwari,

        The properties, com.bmc.arsys.emaildaemon.MaxAttachSize and com.bmc.arsys.emaildaemon.MaxAttachSizeFileExtensions, are not present in the EmailDaemon.properties file by default. If you want the email engine to use these settings, you must add them to EmailDaemon.properties and set their values.

        Thanks,

        Sujata

        Jan 15, 2015 01:13
        1. Maheshwari L

          Hi Sujata,

          Thanks, I was wondering if the variables, when left undefined, would have any default values?

          Jan 15, 2015 05:58
  6. Sujata Pawar

    Hi Maheshwari,

    The variables, when left undefined, would be considered to have the values as false.

    Regards,

    Sujata

    Jan 16, 2015 04:28
  7. Nikolay Fedoseyenko

    Is there:

    com.bmc.arsys.emaildaemon.POP3Timeout
    com.bmc.arsys.emaildaemon.POP3TimeoutPeriod

    ?

    Aug 28, 2015 12:48
    1. Poonam Morti

      Hi Nikolay,

      I am checking this with the SME and will update the topic.

      Thanks,

      Poonam

      Aug 31, 2015 06:11
    1. Poonam Morti

      Hi Nikolay,

      I have updated the topic with com.bmc.arsys.emaildaemon.POP3Timeout and com.bmc.arsys.emaildaemon.POP3TimeoutPeriod settings.

      Thanks,

      Poonam

      Sep 01, 2015 11:31
  8. Vaclav Kucera

    Hi all,

    I am looking for parameter information com.bmc.arsys.emaildaemon.ModifyKeyCharacter...
    Could you please add this parameter in to list?

    Regards,
    Vaclav

    May 30, 2016 06:01
  9. Anagha Deshpande

    Hello Vaclav,

    I will discuss this with SME and will write back to you.

     

    Regards,

    Anagha

    May 30, 2016 11:07
    1. Anagha Deshpande

      Hello Vaclav,

      I have added information for the com.bmc.arsys.emaildaemon.ModifyKeyCharacter parameter.

       

      Regards,

      Anagha

      Jun 01, 2016 04:23
  10. Brian Gillock

    Do spaces matter around the equals sign?

    I.e. .SortMessages=false is the same as .SortMessages = false


    Thank you,

    Brian

    May 02, 2018 09:44
    1. Anagha Deshpande

      Hello Brian,

      I will check this with the SME and will respond back.

      Regards,

      Anagha

      May 02, 2018 10:35
      1. Anagha Deshpande

        Hello Brian,

        Sorry for responding late.

        Regarding your query:

        Space does not matter around the equal sign. But as a good practice to use the space.

        Regards,

        Anagha

        Jun 21, 2018 02:21