IEmailOAuthProvider Interface

Defines the OAuth provider (authorization code flow) that is used to obtain the OAuth access tokens for POP3 / SMTP servers.

Namespace: CMS.EmailEngine
Assembly: CMS.EmailEngine (in CMS.EmailEngine.dll) Version: 13.0.131

Syntax

public interface IEmailOAuthProvider

The IEmailOAuthProvider type exposes the following members.

Properties

	Name	Description
Public property	CustomAuthorizationDialogPath	Path to custom authorization dialog. Return null to keep the default authorization dialog (~/CMSModules/EmailEngine/Pages/OAuth2AccessTokenDialog.aspx).
Public property	RequiresTenantID	Indicates if provider is tenant-based.

Methods

	Name	Description
Public method	CompleteAuthorization	Trades the provided authorizationCode for the access token. Stores the access token, token expiration and a refresh token into credentials.
Public method	GetAuthorizationUrl	URL which is used to request an authorization code, which contains all the necessary information (client id, requested scopes, etc..). The authorization code flow begins with redirecting the user to this URL.
Public method	RefreshToken	Refreshes the EmailOAuthCredentialsAccessToken in the credentials.