outbound_smtp_auth supporting XOAUTH2

Author: juliebin

content/momentum/4/modules/outbound-smtp-auth.md

@@ -1,58 +1,58 @@
 ---
 lastUpdated: "03/26/2020"
 title: "outbound_smtp_auth"
-description: "This module enables users to specify authentication parameters for a given set of messages so that Momentum will authenticate against the peer server when it sends outbound mail It currently supports the AUTH LOGIN and AUTH PLAIN methods of authentication You can specify the parameters in configuration or in lua..."
+description: "This module enables users to specify authentication parameters for a given set of messages so that Momentum will authenticate against the peer server when it sends outbound mail It currently supports the AUTH LOGIN, AUTH PLAIN and AUTH XOAUTH2 methods of authentication You can specify the parameters in configuration or in lua..."
 ---
 
-<a name="idp22419360"></a> 
+<a name="modules.outbound_smtp_auth"></a>
 
-This module enables users to specify authentication parameters for a given set of messages so that Momentum will authenticate against the peer server when it sends outbound mail. It currently supports the 'AUTH LOGIN' and 'AUTH PLAIN' methods of authentication. You can specify the parameters in configuration or in lua, or use a combination of both.
+This module enables users to specify authentication parameters for a given set of messages so that
+Momentum will authenticate against the peer server when it sends outbound mail. It currently
+supports the `AUTH LOGIN`, `AUTH PLAIN` and `AUTH XOAUTH2` methods of authentication.
+ You can specify the parameters in configuration or in lua, or use a combination of both.
 
 ### Note
 
 This module makes heavy use of message contexts to facilitate authentication. If it is enabled, you risk having extra I/O unless `keep_message_dicts_in_memory` is on.
 
-**Configuration Change. ** This feature is available in Momentum 4.2 and later.
+** Configuration Change ** This module is refactored in Momentum 5.1, but this feature is available in Momentum 4.2 and later.
 
 ### <a name="modules.outbound_smtp_auth.configuration"></a> Configuration
 
-Configuration variables are listed below. These values can all be changed and overridden by setting context variables with the same name as the options in lua. All variables are valid in the binding group, binding, domain, and global scopes.
+Configuration variables are listed below. These values can all be changed and overridden by setting
+ message context variables with the same name as the options in lua.
+ All variables are valid in the binding group, binding, domain, and global scopes.
 
 <dl class="variablelist">
 
-<dt>outbound_smtp_auth_key</dt>
-
-<dd>
-
-A unique key that can be used in lua to look up authorization details in a database. It enables you to easily trigger custom behavior based on a configuration scope. The default value is `false`.
-
-</dd>
-
 <dt>outbound_smtp_auth_pass</dt>
 
 <dd>
 
-The password that will be passed to the remote server. The default value is `false`.
+The password or auth token (e.g. for `AUTH XOAUTH2`)that will be passed to the remote server. The default value is not set.
 
 ### Note
 
-Setting the password in configuration will leave it as plaintext. To set the password more securely, dynamically retrieve it from a data store in lua and set it in the context variable that corresponds to this option.
+Setting the password in configuration will leave it as plaintext.
+ To set the password more securely, dynamically retrieve it from a data store in lua and
+ set it in the context variable that corresponds to this option.
 
 </dd>
 
 <dt>outbound_smtp_auth_type</dt>
 
 <dd>
 
-Determines what authentication protocol should be used. The only supported values are 'PLAIN' and 'LOGIN'. The default value is `false`.
+Determines what authentication protocol should be used. The only supported values are 'PLAIN',
+           'LOGIN' and 'XOAUTH2'. The default value is not set.
 
 </dd>
 
 <dt>outbound_smtp_auth_user</dt>
 
 <dd>
 
-The username that will be passed to the remote server. The default value is `false`.
+The username that will be passed to the remote server. The default value is not set.
 
 </dd>
 
@@ -64,21 +64,23 @@ Basic examples of usage are provided below.
 
 The following example shows how you can extend the new hook and set the username and password in lua.
 
-<a name="modules.outbound_smtp_auth.example.set_username_pw"></a> 
+<a name="modules.outbound_smtp_auth.example.set_username_pw"></a>
 
 
 ```
 function mod:outbound_smtp_auth_config(msg, ac, vctx)
-  print('NOTICE: outbound_smtp_auth_config Lua hook called');
-  print('NOTICE: msg:['.. tostring(msg) ..']')
-  msg:context_set(VCTX_MESS, 'outbound_smtp_auth_user', 'foo')
-  msg:context_set(VCTX_MESS, 'outbound_smtp_auth_pass', 'bar')
+  --print('NOTICE: outbound_smtp_auth_config Lua hook called');
+  msg:context_set(VCTX_MESS, 'outbound_smtp_auth_type', 'XOAUTH2')
+  -- credential taken from example here:
+  -- https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth
+  msg:context_set(VCTX_MESS, 'outbound_smtp_auth_user', '[email protected]')
+  msg:context_set(VCTX_MESS, 'outbound_smtp_auth_pass', 'EwBAAl3BAAUFFpUAo7J3Ve0bjLBWZWCclRC3EoAA')
 end
 ```
 
 The following example shows how to use the new configuration variables to set distinct authorization parameters for two different domains.
 
-<a name="modules.outbound_smtp_auth.example.set_auth_parms"></a> 
+<a name="modules.outbound_smtp_auth.example.set_auth_parms"></a>
 
 
 ```
@@ -90,13 +92,17 @@ Domain "messagesystems.com" {
   Outbound_SMTP_AUTH_Type = "LOGIN"
   Outbound_SMTP_AUTH_User = "msys"
   Outbound_SMTP_AUTH_Pass = "msys"
-  Outbound_SMTP_AUTH_Key = "somestring"
 }
 
 Domain "sparkpost.com" {
   Outbound_SMTP_AUTH_Type = "PLAIN"
   Outbound_SMTP_AUTH_user = "sparkpost"
   Outbound_SMTP_AUTH_pass = "sparkpost"
-  Outbound_SMTP_AUTH_Key = "someotherstring"
 }
-```
+
+Domain "bird.com" {
+  Outbound_SMTP_AUTH_Type = "XOAUTH2"
+  Outbound_SMTP_AUTH_user = "[email protected]"
+  Outbound_SMTP_AUTH_pass = "EwBAAl3BAAUFFpUAo7J3Ve0bjLBWZWCclRC3EoAA"
+}
+```