Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Dynamic system settings for email integrations

Updated on April 6, 2022

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.Note: For optimal configurations, set dynamic system settings to the recommended values. If you do not use the recommended values, Pega Predictive Diagnostic Cloud displays a list of dynamic system settings that do not match the recommended values.

Inbound email settings

The following table provides the dynamic system settings that you can configure for your inbound email service:
Owning rulesetNamePurposeValue typeDefault value
Pega-Engineprconfig/services/emailMaxSize/defaultLimits 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.Note: Changes to this value require a server restart.Integer (kilobytes)-1 (No limit)
Pega-Engineprconfig/initServices/initEmail/defaultControls 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.Note: Changes to this value require a server restart.Booleantrue
Pega-IntegrationEngineemail/exceptionLatencyControls 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.Note: Changes to this value require a listener restart. The system uses this setting only if you do not configure the email/exceptionLatency setting.Integer (seconds)5
Pega-IntegrationEngineemail/initialLatencyTimeSpecifies 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.Note: Changes to this value require a listener restart.Integer (seconds)5
Pega-IntegrationEngineemail/retryIntervalSpecifies the amount of time that passes before the email listener attempts to reprocess messages.Note: The email/retryInterval dynamic setting covers the functionality of the deprecated Email_processing_timeout setting. Recommended value: 120.Integer (minutes)120
Pega-IntegrationEngineemail/maxRetrySpecifies the maximum number of retries after a messaging error occurs.Note: Changes to this value require a listener restart.Integer3
Pega-IntegrationEngineemail/enableAttachmentNamesInEmailBodyControls whether the system enables attachment names in body data mapping.Booleanfalse
Pega-IntSvcsemail/copyBodyNoContentSpecifies whether to copy the email subject into the body if the email has no content.Booleanfalse
Pega-IntegrationEngineEmail/AutoReplySubjectSpecifies the patterns for which the email listener searches in the Auto-Submitted header of the email subjects, in order to detect an autoreply message.StringAutomatic reply,Auto:,Auto Response,Out of Office
Pega-IntegrationEngineEmail_throttling_pattern_regexSpecifies the regular expression pattern that evaluates whether an error message indicates throttling.Note: Changes to this value require a listener restart.String
  • -?Backoff Time: (\\d+) millisecond
  • A3 BAD User

Outbound email settings

The following table provides the dynamic system settings that you can configure for your outbound email service:
Owning rulesetNamePurposeValue typeDefault value
Pega-IntSvcsemail/timeoutControls the connection and read timeouts for the sender and receiver. Returns an exception if the server does not respond.Note: Changes to this value require a listener restart. Recommended value: 50000-180000.Integer (milliseconds)60000
Pega-IntSvcsemail/writeTimeoutControls the write timeout for the sender and receiver. Returns an exception if the server does not respond.Note: Changes to this value require a listener restart. Recommended value: 50000-180000.Integer (milliseconds)50000
Pega-IntSvcsemail/fetchsizeControls the fetch size if the IMAP partial-fetch feature is enabled.Note: Changes to this value require a listener restart. Recommended value: at least 1000000 bytes (1 MB).Integer (bytes)1000000

(1 MB)

Pega-IntSvcsemail/partialfetchControls 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.Note: Changes to this value require a listener restart.Booleantrue
Pega-IntSvcsemail/AddLegacyHeadersControls whether to append the old email headers to the new headers.Booleanfalse
Pega-IntSvcsemail/blockResponseControls whether the email listener sends a response after it receives an email. If true, the listener blocks all responses.Note: Changes to this value require a listener restart.Booleanfalse
Pega-IntSvcsemail/enableTextAttachmentInEmailBodyControls whether text attachments can be embedded in the email body.Booleanfalse
Pega-IntSvcsemail/DisableSecuritySTARTTLSControls whether STARTTLS is disabled for inbound and outbound email connections.Note: Requires a listener restart. Do not use on production systems or with third-party email providers, such as Google Mail.Booleanfalse
Pega-IntSvcsFailOnAddressExceptionControls whether message processing failures are detected. If true, ignores processing failures that are related to the message headers.Note: Changes to this value require a listener restart.Booleanfalse
Pega-IntegrationEnginejavamail/NoAuthMechanismsRetryHelps resolve issues with email API upgrades. If true, reinitiates the connection by reverting to a non-authenticated SMTP mode session.Note: Changes to this value require a listener restart.Booleanfalse
  • Previous topic Ensuring messages are processed before switching your email protocol to Microsoft Graph
  • Next topic Correspondence rules and email

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us