Struct email::account::OAuth2Config

pub struct OAuth2Config {
    pub method: OAuth2Method,
    pub client_id: String,
    pub client_secret: Secret,
    pub auth_url: String,
    pub token_url: String,
    pub access_token: Secret,
    pub refresh_token: Secret,
    pub pkce: bool,
    pub scopes: OAuth2Scopes,
    pub redirect_host: String,
    pub redirect_port: u16,
}

The OAuth 2.0 configuration.

Fields

method: OAuth2Method

Method for presenting an OAuth 2.0 bearer token to a service for authentication.

client_id: String

Client identifier issued to the client during the registration process described by Section 2.2.

client_secret: Secret

Client password issued to the client during the registration process described by Section 2.2.

auth_url: String

URL of the authorization server’s authorization endpoint.

token_url: String

URL of the authorization server’s token endpoint.

access_token: Secret

Access token returned by the token endpoint and used to access protected resources.

refresh_token: Secret

Refresh token used to obtain a new access token (if supported by the authorization server).

pkce: bool

Enable the PKCE protection. The value must have a minimum length of 43 characters and a maximum length of 128 characters. Each character must be ASCII alphanumeric or one of the characters “-” / “.” / “_” / “~”.

scopes: OAuth2Scopes

Access token scope(s), as defined by the authorization server.

redirect_host: String

Host name of the client’s redirection endpoint.

redirect_port: u16

Host port of the client’s redirection endpoint.

Implementations

impl OAuth2Config

pub fn default_redirect_host() -> String

Returns the default redirect host name. Combines well with serde’s default and skip_serializing_if macros.

pub fn default_redirect_port() -> u16

Returns the default redirect host port. Combines well with serde’s default and skip_serializing_if macros.

pub fn reset(&self) -> Result<()>

Resets the three secrets of the OAuth 2.0 configuration.

pub async fn configure( &self, get_client_secret: impl Fn() -> Result<String> ) -> Result<()>

If the access token is not defined, runs the authorization code grant OAuth 2.0 flow in order to save the acces token and the refresh token if present.

pub async fn refresh_access_token(&self) -> Result<String>

Runs the refresh access token OAuth 2.0 flow by exchanging a refresh token with a new pair of access/refresh token.

pub async fn access_token(&self) -> Result<String>

Returns the access token if existing, otherwise returns an error.

Trait Implementations

impl Clone for OAuth2Config

fn clone(&self) -> OAuth2Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OAuth2Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OAuth2Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<OAuth2Config> for OAuth2Config

fn eq(&self, other: &OAuth2Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OAuth2Config

impl StructuralEq for OAuth2Config

impl StructuralPartialEq for OAuth2Config