Capabilities for Email OAuth Integration
Release 7.1 introduces OAuth-based email authentication, enabling developers to securely send emails without using app passwords. The following function and system variable simplify OAuth provider selection and authentication.
Function: $$SetOAuthProviderFromEmailId
$$SetOAuthProviderFromEmailId automatically determines the OAuth provider based on the sender email address and updates SVOAuthProvider .
Syntax
$$SetOAuthProviderFromEmailId : <EmailID>
where, <EmailID> is the Sender email address.
Behavior
- Identifies the provider from the email domain.
- Updates SVOAuthProvider automatically.
- Eliminates the need to manually set OAuth provider names.
Example
[Function: TSPL AutoMailBalanceSheet]
60 : Call : SetOAuthProviderFromEmailId : ##SVMailFromAddress
In the above example, the function identifies the OAuth provider based on the sender email address stored in SVMailFromAddress and automatically updates SVOAuthProvider. This eliminates the need to manually specify providers such as Google, Microsoft, or Yahoo.
Variable: SVOAuthProvider
SVOAuthProvider is a system variable used to specify the OAuth provider to be used for mail authentication.
Syntax
Set : SVOAuthProvider : “<Provider>”
Supported Values: Google, Microsoft, Yahoo
Behavior
- Specifies the OAuth provider for the Mail action.
- Uses an existing authenticated session when available.
- Initiates the OAuth sign-in flow if no valid session exists.
- Passwords are not required when OAuth authentication is used.
Example
Set : SVOAuthProvider : “google”
In the above example, the system variable SVOAuthProvider is set to google, indicating that Google should be used as the OAuth authentication provider for sending emails. When the Mail action is invoked, the platform uses the existing Google OAuth session associated with the sender email account or initiates the Google authentication flow if no valid session is available.
