Configuring Driver Parameters to Support Microsoft OAuth 2.0 with Siebel EMR for Outbound Protocol SMTP

You can now send emails with the SMTP protocol to the Microsoft Office 365 mail server.

As of Siebel CRM 25.4 Update, Microsoft OAuth 2.0 support has been enabled to SMTP outbound protocol. If you are using Microsoft Exchange Online and Siebel Email Response, then you must enable Microsoft OAuth 2.0 as outlined here. To support Microsoft OAuth 2.0 for SMTP outbound protocol, several new parameters can be added to the Internet SMTP/IMAP Server driver and the Internet SMTP/POP3 Server driver.

Before you enable OAuth in Siebel CRM application, please make sure you enable OAuth for SMTP in Microsoft Exchange Online. Please refer to Microsoft documentation regarding authenticate an IMAP, POP or SMTP connection using OAuth.

To enable Microsoft OAuth 2.0 for SMTP outbound protocol, you must add all the parameters you require and configure them as follows:

1. Enable Java SMTP

   1. Navigate to Site Map > Administration-Communications > Communications Drivers and Profiles, choose the driver you are using.

   2. Set ‘Enable Java SMTP’ to ‘TRUE’ through Driver Parameters configuration.

2. Configure New SMTP Parameters

   1. Navigate to Site Map > Administration-Communications > Communications Drivers and Profiles, choose the driver you are using, pick the driver profile you’ve set up.

   2. Add profile parameters:

      UserParameter Count: for example, 10

      UserParameter1-N: for example, 1-10

      Specify a prefix based on the protocol usage: for example, imap, pop3, smtp.

      Note: The value should be set to the exact count of the parameters being configured.

      Refer to the table below to configure profile parameters for IMAP/SMTP driver:

      

      This table shows you the complete list for the IMAP/SMTP Driver Parameters related to OAuth enablement. Some of the parameters are required, some of them are optional.

      UserParameter Count: It shows the exact count of the parameters being configured. For example, if you only need to configure 8 parameters, put ‘8’ as the value for this parameter.

      UserParameter 1-3: these parameters are related to the IMAP/inbound protocol. If you have previously configured the parameters to enable OAuth for your IMAP protocol, we highly recommend that you add “imap” prefix to these parameters to ensure they are adaptable to future changes.

      UserParameter 4-6: these parameters are related to the SMTP/outbound protocol. Make sure you add “smtp” prefix to the values.

      • smtp:mail.smtp.auth/true - enables SMTP authentication in Java mail which is required to user OAuth
      • smtp:mail.smtp.starttls.enable/true - required as the SMTP server expects the communications it secures to be secure/encrypted.
      • smtp:mail.transport.protocol/smtp - sets the default transport method for outbound emails to be smtp

      UserParameter7-8: these two parameters are used to turn on logs. The default settings are False. If you need to troubleshoot issues related to OAuth authentication process, you can turn on logs using these parameters.

      UserParameter9-10: some customers may want to set up SMTP Proxy server. An SMTP Proxy server acts as an intermediary between an email client (or server) and the SMTP server used to send emails. Instead of directly sending an email from the client to the SMTP server, the email first passes through the SMTP Proxy server. It can enhance the performance, security, and reliability of email communications. You can configure these two parameters if you have SMTP Proxy server setup.

      

      This table shows the parameter list for the POP3/SMTP Driver related to OAuth enablement. Some of these parameters are required, some of them are optional.

      UserParameter Count: it shows the exact count of the parameters being configured.

      POP3/Inbound UserParameters: it is highly recommended that you add “pop3” prefix to these parameters to ensure they are adaptable to future changes.

      Regarding parameters for the SMTP/outbound protocol, make sure you put “smtp” prefix to the values.

      • smtp:mail.smtp.auth/true - enables SMTP authentication in Java mail which is required to user OAuth
      • smtp:mail.smtp.starttls.enable/true - required as the SMTP server expects the communications it secures to be secure/encrypted.
      • smtp:mail.transport.protocol/smtp - sets the default transport method for outbound emails to be smtp

      If you need to troubleshoot issues related to OAuth authentication process, you can turn on logs using the mail.debug parameters. They are optional parameters.

      Some customers may want to set up SMTP Proxy server. An SMTP Proxy server acts as an intermediary between an email client (or server) and the SMTP server used to send emails. Instead of directly sending an email from the client to the SMTP server, the email first passes through the SMTP Proxy server. It can enhance the performance, security, and reliability of email communications. You can configure these two parameters if you have SMTP Proxy server setup.

      SSL and TLS Support for SMTP:

      The new Java SMTP Client supports OAuth. SSL and TLS settings are passed to the mail servlet as User Parameters, for example, smtp:mail.smtp.starttls.enable/true, smtp:mail.smtp.ssl.enable/true

      “Enable SSL for SMTP” and “Enable TLS for SMTP” in Driver Profile Parameters are no longer used as they do not support OAuth authentication.

      Debugging and Troubleshooting:

      For debugging and troubleshooting purpose, you can turn on the debug log through Communication Driver Profile Parameter configuration: mail.debug/true, mail.debug.auth/true. Please only turn on them as necessary, as enabling these two log parameters may impact performance.

      The OAuth 2.0 debug information is logged in the following log files:

      • IMAPSMTP or POP3SMTP logs in the siebel\log directory. These logs record interactions between Siebel application and SMTP mail server.

      • mail.log in the Tomcat server's log directory