Configuring Java CAPS Environment Components for Communications Adapters

Configuring EMail Adapter Environment Properties

The EMail Adapter configuration parameters, accessed from the EMail Adapter External System in the Environment Explorer tree, are organized into the following sections:

Inbound Email Adapter ⇒ Connection Settings

The Inbound Email Adapter ⇒ Connection Settings section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 14 Environment - Inbound Email Adapter ⇒ Connection Settings

Name 

Description 

Required Value 

Host Receive

Specifies the host name of the server used to receive messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login).

The host name of the server used to receive messages. 

Port Receive

Specifies the port number used to connect when receiving Email messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login).

The port number used to connect when receiving Email messages. This is a number between 1 and 65535.

The configured default is 110.

User Receive

Specifies the user name used when receiving messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login).

The valid user login name used when receiving Email messages. 

Password Receive

Specifies the password used when receiving messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login).

The user password used when receiving messages. 

Inbound Email Adapter ⇒ SSL

The Inbound Email Adapter ⇒ SSL section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 15 Environment - Inbound Email Adapter ⇒ SSL

Name 

Description 

Required Value 

Receive SSL Protocol

Specifies the SSL protocol to use when establishing an SSL connection with the server. 

Select the appropriate SSL protocol. The options are: 

  • No SSL

  • TLS

  • TLSv1

  • SSLv3

  • SSLv2

  • SSL

The configured default is No SSL.

X509 Algorithm Name

Specifies the X509 algorithm name to use for the trust and key manager factories. 

An X509 algorithm name. 

The configured default is SunX509.

Inbound Email Adapter ⇒ SSL ⇒ CACerts

The Inbound Email Adapter ⇒ SSL ⇒ CACerts section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 16 Environment - Inbound Email Adapter ⇒ SSL ⇒ CACerts

Name 

Description 

Required Value 

TrustStore type

Specifies the type of truststore used for CA certificate management when establishing SSL connections. 

The trustStore type. 

The configured default is JKS.

TrustStore

Specifies a truststore used for CA certificate management to establish SSL connections. A truststore file is a key database file that contains the public keys for a target server. 

The truststore used for CA certificate management. 

TrustStore password

Specifies the password for accessing the truststore used for CA certificate management when establishing SSL connections. 

The truststore password. 

Inbound Email Adapter ⇒ MDB Settings

The Inbound Email Adapter ⇒ MDB Settings section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 17 Environment - Inbound Email Adapter ⇒ MDB Settings

Name 

Description 

Required Value 

Max Pool Size

Specifies the maximum pool size. This controls the number of concurrent sessions. 

An integer indicating the maximum pool size. 

The configured default is 10.

Outbound Email Adapter ⇒ Connection Settings ⇒ Send SMTP

The Outbound Email Adapter ⇒ Connection Settings ⇒ Send SMTP section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 18 Environment - Outbound Email Adapter ⇒ Connection Settings ⇒ Send SMTP

Name 

Description 

Required Value 

Host Send

Specifies the host name of the server used to send messages. This is required for the “sending” Adapter connection. 

The host name of the server used to send messages. 

Port Send

Specifies the port number to connect to when sending messages. This is required for “sending” Adapter connections. 

An integer indicating the port number. 

The configured default is 25.

User Send

Specifies the user name used when sending messages. This is required for “sending” Adapter connections. 

The login name used to access the sending host server. 

Password Send

Specifies the password used when sending messages. This is required for “sending” Adapter connections. 

The user password used to access the sending host server. 

Text encoding

Specifies the encoding used for body and header text. Available encoding options are: 

  • ASCII: for ASCII text.

  • iso-8859-1: Latin 1 (Western Europe) text.

  • iso-2022-jp: Japanese character text.

  • ISO2022CN: Chinese character text.

  • ISO2022CN_GB: Simplified Chinese character text.

    ISO2022KR: Korean character text.

Select one of the following: 

  • ASCII

  • iso-8859-1

  • iso-2022-jp

  • ISO2022CN

  • ISO2022CN_GB

  • ISO2022KR

Header encoding

Specifies the encoding used for the header. Available encoding options are: 

  • B: Identical to the "BASE64" encoding defined by RFC 1341.

  • Q: Designed to allow text containing mostly ASCII characters to be deciphered by an ASCII terminal without decoding. Q encoding is similar to "Quoted-Printable" content- transfer-encoding defined in RFC 1341.

    “Q” encoding is recommended for use with most Latin character sets, while “B” encoding is recommended for all others.

Select one of the following: 

  • B

  • Q

Outbound Email Adapter ⇒ Connection Settings ⇒ Receive POP3

The Outbound Email Adapter ⇒ Connection Settings ⇒ Receive POP3 section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 19 Environment - Outbound Email Adapter ⇒ Connection Settings ⇒ Receive POP3

Name 

Description 

Required Value 

Host Receive

Specifies the host name of the server used to receive messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). 

The host name of the server used to receive messages. 

Port Receive

Specifies the port number to connect to when receiving messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connection when the Session Authentication parameter is set to Yes (for POP3 login). 

An integer indicating the port number used to connect with the receiving host server. 

The configured default is 110.

User Receive

Specifies the user name used when receiving messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the Session Authentication parameter is set to Yes (for POP3 login). 

The login name used to access the receiving host server. 

Password Receive

Specifies the password used when receiving messages. This is required for “receiving” Adapter connections. This is also required for “sending” Adapter connections when the Session Authentication parameter is set to Yes (for POP3 login). 

The user password used to access the receiving host server. 

Session Authentica-tion

Determines whether a POP3 session authentication is performed before attempting an SMTP connection. This is required by some e-mail services. 

Set the value to Yes only when necessary. Yes requires that settings for Host Receive, Port Receive, User Receive, and Password Receive are entered for sending the Adapter connection. 

Select Yes or No.

Yes indicates that POP3 session authentication will be performed before attempting an SMTP connection.

The configured default is No.

Outbound Email Adapter ⇒ SSL

The Outbound Email Adapter ⇒ SSL section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 20 Environment - Outbound Email Adapter ⇒ SSL

Name 

Description 

Required Value 

Send SSL Protocol

Specifies the SSL protocol to use when establishing an SSL connection with the SMTP server. 

Select the appropriate SSL protocol. The options are: 

  • No SSL

  • TLS

  • TLSv1

  • SSLv3

  • SSLv2

  • SSL

The configured default is No SSL.

Receive SSL Protocol

Specifies the SSL protocol to use when establishing an SSL connection with the server. 

Select the appropriate SSL protocol. The options are: 

  • No SSL

  • TLS

  • TLSv1

  • SSLv3

  • SSLv2

  • SSL

The configured default is No SSL.

X509 Algorithm Name

Specifies the X509 algorithm name to use for the trust and key manager factories. 

An X509 algorithm name. 

The configured default is SunX509.

Outbound Email Adapter ⇒ SSL ⇒ CACerts

The Outbound Email Adapter ⇒ SSL ⇒ CACerts section of the EMail Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 21 Environment - Outbound Email Adapter ⇒ SSL ⇒ CACerts

Name 

Description 

Required Value 

TrustStore type

Specifies the type of truststore used for CA certificate management when establishing SSL connections. 

The trustStore type. 

The configured default is JKS.

TrustStore

Specifies a truststore used for CA certificate management to establish SSL connections. 

The truststore used for CA certificate management. 

TrustStore password

Specifies the password used to access the truststore used for CA certificate management when establishing SSL connections. 

The truststore password.