OAuth - OAuth2 authentication wrapper class. More...

Inheritance diagram for PHPMailer\PHPMailer\OAuth:

Public Member Functions
	__construct ($options)
	OAuth constructor.

	getOauth64 ()
	Generate a base64-encoded OAuth token.

Protected Attributes
string	$oauthClientId = ''
	The client ID, generated in the app definition of the service you're connecting to.

string	$oauthClientSecret = ''
	The client secret, generated in the app definition of the service you're connecting to.

string	$oauthRefreshToken = ''
	The refresh token, used to obtain new AccessTokens.

AccessToken	$oauthToken
	The current OAuth access token.

string	$oauthUserEmail = ''
	The user's email address, usually used as the login ID and also the from address when sending email.

AbstractProvider	$provider
	An instance of the League OAuth Client Provider.

Detailed Description

OAuth - OAuth2 authentication wrapper class.

Uses the oauth2-client package from the League of Extraordinary Packages.

Author: Marcus Bointon (Synchro/coolbru) phpma.nosp@m.iler.nosp@m.@sync.nosp@m.hrom.nosp@m.edia..nosp@m.co.u.nosp@m.k

Constructor & Destructor Documentation

PHPMailer\PHPMailer\OAuth::__construct ( $options )

OAuth constructor.

Parameters

array $options Associative array containing provider, userName, clientSecret, clientId and refreshToken elements

PHPMailer\PHPMailer\OAuth::getGrant ( )

protected

Get a new RefreshToken.

Return values

RefreshToken

PHPMailer\PHPMailer\OAuth::getOauth64 ( )

Generate a base64-encoded OAuth token.

Return values

string

PHPMailer\PHPMailer\OAuth::getToken ( )

protected

Get a new AccessToken.

Return values

AccessToken

The documentation for this class was generated from the following file: