Inbound (POP3) email settings and troubleshooting - EcoSys - Administration & Configuration - Hexagon

EcoSys System Administration

Language
English (United States)
Product
EcoSys
Search by Category
Administration & Configuration
EcoSys Version
9.0

Required settings

The following settings are required if your instance of EcoSys processes inbound email messages.

In a multi-server clustered EcoSys environment, only one of the application servers in the cluster should be configured for POP3 mail polling, while all of them should be configured for outbound SMTP mail sending.

# enable incoming (POP3) mail polling (default is false)

mail.polling.pop3.enabled=true

# host and port number for POP3 mail server

# (host is required, port defaults to 110)

# note: any settings prefixed with "mail.polling.pop3." will be applied to the Java

# mail system as the corresponding "mail.pop3. ..." properties for POP3 connections

mail.pop3.host=myserver.com

# mail.pop3.port=110

# email address for dedicated POP3 mailbox - this address should be valid for all users

# participating in email workflow, and should be specific to this instance of EcoSys EPC

# (required)

mail.system.replyto.address=EcoSysPROD@myserver.com

EcoSys supports connecting to POP3 email using basic authentication or OAuth2. Configure the required settings based on the authentication being used.

Basic Authentication

# credentials (username and password) for accessing the POP3 server (required)

# (supports CIPHERTEXT syntax for encrypted passwords)

mail.polling.pop3.username=myusername

mail.polling.pop3.password=mypassword

OAuth2

OAuth2 Authentication is only supported for Office365, refer to Configuring Office365 for OAuth2 for pre-requisites steps.

EcoSys 9.0.02.108 or greater is required for OAuth2 support.

# Enable OAuth2 (default is false)

mail.polling.pop3.oauth2.enabled=true

# OAuth2 token provider (only supported provider is 'Azure')

mail.polling.pop3.oauth2.provider=Azure

# Azure tenant ID (required) (supports ciphertext)

cloud.azure.tenantId=

# Client ID (supports ciphertext)

mail.polling.pop3.oauth2.clientId=

# Client secret (supports ciphertext)

mail.polling.pop3.oauth2.clientSecret=

# Comma separated scopes (does not support ciphertext)

mail.polling.pop3.oauth2.scopes=https://outlook.office365.com/.default

# Optional (and for Azure): the token endpoint URL (supports ciphertext) - when specified, this endpoint is used to obtain the token

#mail.polling.pop3.oauth2.provider.azure.tokenEndpoint=https://login.microsoftonline.com/[Azure-Tenant-ID]/oauth2/v2.0/token

Optional settings

Use the following settings only if required to accommodate your email system's configuration.

# interval in seconds between polling the incoming POP3 mailbox (default is 120 seconds)

mail.polling.pop3.intervalSeconds=120

# enable STARTTLS for communication with POP3 server

mail.pop3.starttls.enable=true

# protocol for POP3 mail polling (not recommended to change unless different from default pop3/pop3s)

# mail.polling.pop3.protocol=pop3

Troubleshooting

Failure to send an outgoing message via POP3 is logged in the application log. In most cases, the error message provides sufficient information for determining a resolution. If additional detail is needed, you can use the setting below to enable debug messages for the POP3 protocol.

# enables detailed POP3 protocol logging, use only for troubleshooting POP3 connections

mail.polling.pop3.debug.enabled=true

Because this setting produces verbose logging, we do not recommend using it for normal production operation.