Dynamic system settings for email integrations
Pega Platform provides dynamic system settings that you can use to modify email processing in your system. For example, you can limit the size of an email message that your application accepts, or allow text attachments in the email body.
For more information about updating dynamic system settings, see Editing a dynamic system setting.
Inbound email settings
The following table provides the dynamic system settings that you can configure for your inbound email service:Owning ruleset | Name | Purpose | Value type | Default value |
Pega-Engine | prconfig/services/emailMaxSize/default | Limits the maximum size of an email message. You can use this
setting to override the value of the Maximum email size
(KB) field on the Process tab
of the email listener form. | Integer (kilobytes) | -1 (No limit) |
Pega-Engine | prconfig/initServices/initEmail/default | Controls whether the system initializes the email service at
startup. In a multinode system, you can use this setting to control
whether the email service is available on individual
nodes. | Boolean | true |
Pega-IntegrationEngine | email/exceptionLatency | Controls how long the email listener waits before it
automatically retries after encountering an error. You can use this
setting to define a fixed sleep interval for the listener before it
retries after an error or exception occurs in the inbound email
processing. | Integer (seconds) | 5 |
Pega-IntegrationEngine | email/initialLatencyTime | Specifies the delay for the startup of the email listener. You
can use this setting to define a cumulative sleep interval for the
listener before it retries after an error or exception occurs in the
inbound email processing. Multiplication of the value of this
setting by the number of retries determines the blackout period
after an exception occurs. | Integer (seconds) | 5 |
Pega-IntegrationEngine | email/retryInterval | Specifies the amount of time that passes before the email
listener attempts to reprocess messages. | Integer (minutes) | 120 |
Pega-IntegrationEngine | email/maxRetry | Specifies the maximum number of retries after a messaging error
occurs. | Integer | 3 |
Pega-IntegrationEngine | email/enableAttachmentNamesInEmailBody | Controls whether the system enables attachment names in body data mapping. | Boolean | false |
Pega-IntSvcs | email/copyBodyNoContent | Specifies whether to copy the email subject into the body if the email has no content. | Boolean | false |
Pega-IntegrationEngine | Email/AutoReplySubject | Specifies the patterns for which the email listener searches in the Auto-Submitted header of the email subjects, in order to detect an autoreply message. | String | Automatic reply,Auto:,Auto Response,Out of Office |
Pega-IntegrationEngine | Email_throttling_pattern_regex | Specifies the regular expression pattern that evaluates whether
an error message indicates throttling. | String |
|
Outbound email settings
The following table provides the dynamic system settings that you can configure for your outbound email service:Owning ruleset | Name | Purpose | Value type | Default value |
Pega-IntSvcs | email/timeout | Controls the connection and read timeouts for the sender and
receiver. Returns an exception if the server does not
respond. | Integer (milliseconds) | 60000 |
Pega-IntSvcs | email/writeTimeout | Controls the write timeout for the sender and receiver. Returns
an exception if the server does not respond. | Integer (milliseconds) | 50000 |
Pega-IntSvcs | email/fetchsize | Controls the fetch size if the IMAP partial-fetch feature is
enabled. | Integer (bytes) | 1000000 (1 MB) |
Pega-IntSvcs | email/partialfetch | Controls whether to use the IMAP partial-fetch feature. Resetting
this value forces the listener to read the entire message at once,
which might lead to potential memory problems with large
emails. | Boolean | true |
Pega-IntSvcs | email/AddLegacyHeaders | Controls whether to append the old email headers to the new headers. | Boolean | false |
Pega-IntSvcs | email/blockResponse | Controls whether the email listener sends a response after it
receives an email. If true, the listener
blocks all responses. | Boolean | false |
Pega-IntSvcs | email/enableTextAttachmentInEmailBody | Controls whether text attachments can be embedded in the email body. | Boolean | false |
Pega-IntSvcs | email/DisableSecuritySTARTTLS | Controls whether STARTTLS is disabled for inbound and outbound
email connections. | Boolean | false |
Pega-IntSvcs | FailOnAddressException | Controls whether message processing failures are detected. If
true, ignores processing failures that
are related to the message headers. | Boolean | false |
Pega-IntegrationEngine | javamail/NoAuthMechanismsRetry | Helps resolve issues with email API upgrades. If
true, reinitiates the connection by
reverting to a non-authenticated SMTP mode session. | Boolean | false |
Previous topic Ensuring messages are processed before switching your email protocol to Microsoft Graph Next topic Correspondence rules and email