Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Transport_Esmtp_Auth_XOAuth2Authenticator

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Transport/Esmtp/Auth/XOAuth2Authenticator.php

Class Overview


Handles XOAUTH2 authentication.


Author(s):

Implements interfaces:

Methods



Class Details

[line 26]
Handles XOAUTH2 authentication.

Example:

  1.  $transport Swift_SmtpTransport::newInstance('smtp.gmail.com'587'tls')
  2.    ->setAuthMode('XOAUTH2')
  3.    ->setUsername('YOUR_EMAIL_ADDRESS')
  4.    ->setPassword('YOUR_ACCESS_TOKEN');




Tags:



[ Top ]


Class Methods


method authenticate [line 47]

bool authenticate( Swift_Transport_SmtpAgent $agent, string $email, string $token)

Try to authenticate the user with $email and $token.



Tags:

access:  public



Implementation of:
Swift_Transport_Esmtp_Authenticator::authenticate()
Try to authenticate the user with $username and $password.

Parameters:

Swift_Transport_SmtpAgent   $agent  
string   $email  
string   $token  

[ Top ]

method constructXOAuth2Params [line 66]

void constructXOAuth2Params( $email, $token)

Construct the auth parameter.



Tags:

see:  the_sasl_xoauth2_mechanism
access:  protected


Parameters:

   $email  
   $token  

[ Top ]

method getAuthKeyword [line 33]

string getAuthKeyword( )

Get the name of the AUTH mechanism this Authenticator handles.



Tags:

access:  public



Implementation of:
Swift_Transport_Esmtp_Authenticator::getAuthKeyword()
Get the name of the AUTH mechanism this Authenticator handles.
[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:56:49 +0000 by phpDocumentor 1.4.3