Mail (channel settings)
See also: General Channel Settings, SMTP (Input Agent), Mail (Input Agent Cron) and Response Route Mail (SMTP).
(1) The channel can be used to receive or send emails via the SMTP protocol.
(2) Like (1) but with authentication.
(3) If POP3 is selected, field (11) has to contain the address of a POP3 server.
(4) If IMAP is selected, field (11) has to contain the address of an IMAP server.
(5) (S/MIME) A local certificate (with private key) can be assigned to the channel here. This certificate is used to decrypt the incoming data encrypted by the partner and to sign outgoing data.
(6) (S/MIME) A partner certificate, i.e. the public part of a certificate of your partner, can be assigned to the channel here. This certificate is used to encrypt the data to be sent and to check the signature of received data.
(7) (S/MIME) Specifies whether data sent from Lobster_data to the partner system will be signed and/or encrypted. The data is signed with the signature algorithm set in (9) and encrypted using the encryption algorithm set in (10).
(8) (S/MIME) If set, Lobster_data rejects data that is not signed or encrypted. Attention: If the partner sends encrypted or signed data, a local certificate to decrypt the data or a partner certificate to check the signing must still be available, even if the option here in (8) is not set. Otherwise, the message would not be decryptable or the signature could not be checked. But the message will not be rejected.
(9) (S/MIME) Determines which algorithm is used to sign data sent by Lobster_data. The setting is only effective if the checkbox Send signed (7) is set.
(10) (S/MIME) Determines which algorithm is used to encrypt data sent by Lobster_data. The setting is only effective if the checkbox Send encrypted (7) is set.
(11) The address of the POP3/IMAP server.
The allowed protocols are pop3, imap, pop3s, imaps. The port number can be omitted, in which case the default port number will be used: 110 (pop3), 143 (imap), 995 (pop3s), 993 (imaps). It can be overwritten with a value greater than 0 wherever the channel is used.
(12) Here an alternative SMTP user can be specified if this does not match the value in field Own ID.
(13) The authentication procedure for the partner SMTP server can be specified explicitly. It is also possible to specify several methods separated by blanks (the order is observed). Example: NTLM LOGIN PLAIN MD5-DIGEST
(14) Name of the IMAP directory from which emails are to be fetched. Only emails from this directory will be read. Any existing subdirectories are not taken into account. To fetch the emails from the inbox of the user account, the value INBOX must be entered in the field. In order to fetch the emails from a subfolder of the inbox of the user account, the value INBOX.<name of the subfolder> must be entered.
(15) A test email is sent to the partner system with the address specified in the field Partner address.
(16) and (17) For OAuth2 authorization. The necessary values/settings and the procedure are very dependent on the respective provider (e.g. Microsoft, Google, etc.). Two grant types are available: Refresh Token and Client Credentials. Below you will find a small configuration example for the grant type Client Credentials and the provider Microsoft Azure, but we cannot guarantee that this information is up-to-date. Please always refer to the documentation of the respective provider. The grant type Refresh Token is a little bit more complicated, because you have to fetch a refresh token manually first (grant type Authorization Code) (e.g. with Postman or an HTTP channel), but that would go beyond the scope here. C ontact our support team for more details if necessary.
Communication Paths
With a Mail channel, the following three communication paths are covered.
The channel is selected in a profile with an Input Agent of type SMTP. In this case, the partner system logs in to Lobster_data to submit emails to Lobster_data. The content of the Partner ID field corresponds to the sender address, provided it is not overwritten in the profile. If the AuthenticationService is defined as the SmtpAuthenticator, then the remote system must use the contents of the fields Partner ID and Partner password for the login. If no SmtpAuthenticator is defined (or not the AuthenticationService), the contents of the fields Partner ID and Partner Password have no relevance.
The channel is selected in a profile with a time-driven Input Agent of type Mail and subtype IMAP or POP3. In this case, Lobster_data logs in to the partner system (IMAP server). For this, it uses the contents of the fields Own ID and Own Password. The emails are then read from the IMAP directory.
The channel is selected in a profile with a Response Route of type Mail (SMTP). In this case, Lobster_data logs on to the partner system (SMTP server), which can be reached via the Partner address. For this, it uses the contents of the fields Own ID and Own Password. The emails are then transferred to the partner system using the SMTP protocol. If the Partner address field is empty, the values for the Partner address, Own ID and Own Password are replaced by the corresponding values in the configuration file ./etc/startup.xml (see the following listing). The content of fields Own ID and Own password are ignored in such a case.
<
Call
name
=
"addApplication"
>
<
Arg
>
<
New
class
=
"com.ebd.util.net.mail.HubStartupConfiguration"
>
<
Call
name
=
"setMailSettings"
>
<
Arg
>localhost</
Arg
>
<
Arg
type
=
"int"
>25</
Arg
>
<
Arg
>user</
Arg
>
<
Arg
>password</
Arg
>
</
Call
>
</
New
>
</
Arg
>
</
Call
>
Instead of localhost, the address of the server is entered. The port on which the SMTP server is listening is specified in the line afterwards. This is followed by the optional information for user and password.