Interface ISmtpOAuthProvider

Namespace: DotNetNuke.Services.Mail.OAuth
Assembly: DotNetNuke.dll
Syntax
public interface ISmtpOAuthProvider

Properties

LocalizedName

Declaration
string LocalizedName { get; }
Property Value
Type Description
string

Name

Declaration
string Name { get; }
Property Value
Type Description
string

Methods

Authorize(int, IOAuth2SmtpClient)

Declaration
void Authorize(int portalId, IOAuth2SmtpClient smtpClient)
Parameters
Type Name Description
int portalId
IOAuth2SmtpClient smtpClient

AuthorizeAsync(int, IOAuth2SmtpClient, CancellationToken)

Declaration
Task AuthorizeAsync(int portalId, IOAuth2SmtpClient smtpClient, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int portalId
IOAuth2SmtpClient smtpClient
CancellationToken cancellationToken
Returns
Type Description
Task

GetAuthorizeUrl(int)

Declaration
string GetAuthorizeUrl(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
string

GetSettings(int)

Declaration
IList<SmtpOAuthSetting> GetSettings(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IList<SmtpOAuthSetting>

IsAuthorized(int)

Declaration
bool IsAuthorized(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
bool

IsAuthorizedAsync(int, CancellationToken)

Declaration
Task<bool> IsAuthorizedAsync(int portalId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int portalId
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

UpdateSettings(int, IDictionary<string, string>, out IList<string>)

Declaration
bool UpdateSettings(int portalId, IDictionary<string, string> settings, out IList<string> errorMessages)
Parameters
Type Name Description
int portalId
IDictionary<string, string> settings
IList<string> errorMessages
Returns
Type Description
bool

Extension Methods