POP3 Mail Configuration

An identifier to uniquely identify this Configuration.

This should describe the Configuration.

Active or Inactive. Configurations cannot be used in a processing sequence while they are in inactive status – supplied activities will end in error if they attempt to use a configuration that has inactive status.

This is the IP address of your mail server. If this value is not provided in this Configuration, it must be specified in the LANSA Integrator POP3MailService properties file.

This is the user profile to be used to connect to your mail server. If this value is not provided in this Configuration, it must be specified in the LANSA Integrator POP3MailService properties file.

This is the password that is used with the user profile to connect to your mail server. If this value is not provided in this Configuration, it must be specified in the LANSA Integrator POP3MailService properties file.

This value is optional. The default value is 110 (or 995 for a secure connection using Implicit SSL/TLS).

Specifies whether to use a secure connection to the specified POP3 mail server.  You can choose one of the following:
Explicit SSL/TLS attempts to establish a secure connection in explicit mode. This initially connects in unsecured mode (typically on port 110), then negotiates a change to a SSL/TLS connection using the STLS POP3 protocol command.
Implicit SSL/TLS requires a secure control channel directly to SSL/TLS POP3 mail server using a port (usually 995) allocated specifically for such secure connections.
No will result in an unsecured connection being attempted (some servers may refuse or limit such a connection).

This value is optional. It may be used to decrypt secure messages that have been encrypted with the recipient's public key. This value is used to access the appropriate private key store in the LANSA Integrator POP3 service properties.

This value is optional. It is used with the Public key name as the password component.

Yes or No. If Yes is specified, the text of the emails is to be saved to the directory specified in the Save directory.

Yes or No. If Yes is specified, the email attachments are to be saved to the directory specified in the Save directory.

This must be specified if the mail text or mail attachments are to be saved.  You can click the prompt button to browse for a folder location on the LANSA Composer server.

Yes or No. If No is specified, then the emails that are read are left on the email server. This means that a subsequent connection to the email server and read will retrieve the same emails. It is usual to remove emails from the server after they have been read and the text and attachments saved.

OAUTH2 – Token-based authentication.
SASL – Simple Authentication and Security Layer.

The client_id is a public identifier for apps. Even though it’s public, it’s best that it isn’t guessable by third parties, so many implementations use something like a 32-character hex string.

E.g. ZYDPLLBWSK3MVQJSIYHB1OR2JXCY0X2C5UJ2QAR2MAAIT5Q

The client_secret is a secret known only to the application and the authorization server. It is essentially the application’s own password. It must be sufficiently random to not be guessable, which means you should avoid using common UUID libraries, which often consider the timestamp or MAC address of the server generating it.

A great way to generate a secure secret is to use a cryptographically-secure library to generate a 256-bit value and then convert it to a hexadecimal representation.

In PHP, you can use the random_bytes function and convert to a hex string:

bin2hex(random_bytes(32));

Lq08Q~EtgN-BpoINX6msRD9GL_cCx

The token endpoint is used by the application in order to get an access token or a refresh token. It is used by all flows except for the Implicit Flow because, in that case, an access token is issued directly.

E.g. -https://login.microsoftonline.com/5c951c05-0f75-44ef-6223f150a449/oauth2/v2.0/token

Scope is a way to limit an app’s access to a user’s data. Rather than granting complete access to a user’s account, it is often useful to give apps a way to request a more limited scope of what they are allowed to do on behalf of a user.