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

Class: Swift_Transport_Esmtp_AuthHandler

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

Class Overview


An ESMTP handler for AUTH support.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods



Class Details

[line 16]
An ESMTP handler for AUTH support.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 58]

Swift_Transport_Esmtp_AuthHandler __construct( $authenticators)

Create a new AuthHandler with $authenticators for support.



Tags:

access:  public


Parameters:

Swift_Transport_Esmtp_Authenticator[]   $authenticators  

[ Top ]

method afterEhlo [line 168]

void afterEhlo( Swift_Transport_SmtpAgent $agent)

Runs immediately after a EHLO has been issued.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::afterEhlo()
Runs immediately after a EHLO has been issued.

Parameters:

Swift_Transport_SmtpAgent   $agent   to read/write

[ Top ]

method exposeMixinMethods [line 230]

string[] exposeMixinMethods( )

Returns an array of method names which are exposed to the Esmtp class.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::exposeMixinMethods()
Returns an array of method names which are exposed to the Esmtp class.
[ Top ]

method getAuthenticators [line 78]

Swift_Transport_Esmtp_Authenticator[] getAuthenticators( )

Get the Authenticators which can process a login request.



Tags:

access:  public


[ Top ]

method getAuthMode [line 138]

string getAuthMode( )

Get the auth mode to use to authenticate.



Tags:

access:  public


[ Top ]

method getHandledKeyword [line 148]

bool getHandledKeyword( )

Get the name of the ESMTP extension this handles.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::getHandledKeyword()
Get the name of the ESMTP extension this handles.
[ Top ]

method getMailParams [line 191]

void getMailParams( )

Not used.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::getMailParams()
Get params which are appended to MAIL FROM:<>.
[ Top ]

method getPassword [line 118]

string getPassword( )

Get the password to authenticate with.



Tags:

access:  public


[ Top ]

method getPriorityOver [line 220]

int getPriorityOver( string $esmtpKeyword)

Returns +1, -1 or 0 according to the rules for usort().

This method is called to ensure extensions can be execute in an appropriate order.




Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::getPriorityOver()
Returns +1, -1 or 0 according to the rules for usort().

Parameters:

string   $esmtpKeyword   to compare with

[ Top ]

method getRcptParams [line 199]

void getRcptParams( )

Not used.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::getRcptParams()
Get params which are appended to RCPT TO:<>.
[ Top ]

method getUsername [line 98]

string getUsername( )

Get the username to authenticate with.



Tags:

access:  public


[ Top ]

method onCommand [line 207]

void onCommand( Swift_Transport_SmtpAgent $agent, $command, [ $codes = array()], [ &$failedRecipients = null], [ &$stop = false])

Not used.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::onCommand()
Runs when a command is due to be sent.

Parameters:

Swift_Transport_SmtpAgent   $agent  
   $command  
   $codes  
   &$failedRecipients  
   &$stop  

[ Top ]

method resetState [line 238]

void resetState( )

Not used.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::resetState()
Tells this handler to clear any buffers and reset its state.
[ Top ]

method setAuthenticators [line 68]

void setAuthenticators( $authenticators)

Set the Authenticators which can process a login request.



Tags:

access:  public


Parameters:

Swift_Transport_Esmtp_Authenticator[]   $authenticators  

[ Top ]

method setAuthMode [line 128]

void setAuthMode( string $mode)

Set the auth mode to use to authenticate.



Tags:

access:  public


Parameters:

string   $mode  

[ Top ]

method setKeywordParams [line 158]

void setKeywordParams( $parameters)

Set the parameters which the EHLO greeting indicated.



Tags:

access:  public



Implementation of:
Swift_Transport_EsmtpHandler::setKeywordParams()
Set the parameters which the EHLO greeting indicated.

Parameters:

string[]   $parameters  

[ Top ]

method setPassword [line 108]

void setPassword( string $password)

Set the password to authenticate with.



Tags:

access:  public


Parameters:

string   $password  

[ Top ]

method setUsername [line 88]

void setUsername( string $username)

Set the username to authenticate with.



Tags:

access:  public


Parameters:

string   $username  

[ Top ]

method _getAuthenticatorsForAgent [line 249]

array _getAuthenticatorsForAgent( Swift_Transport_SmtpAgent $agent)

Returns the authenticator list for the given agent.



Tags:

access:  protected


Parameters:

Swift_Transport_SmtpAgent   $agent  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:44:24 +0000 by phpDocumentor 1.4.3