[ Index ]

MailPress 544

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/Transport/Esmtp/ -> AuthHandler.php (summary)

(no description)

File Size: 263 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Transport_Esmtp_AuthHandler:: (19 methods):
  __construct()
  setAuthenticators()
  getAuthenticators()
  setUsername()
  getUsername()
  setPassword()
  getPassword()
  setAuthMode()
  getAuthMode()
  getHandledKeyword()
  setKeywordParams()
  afterEhlo()
  getMailParams()
  getRcptParams()
  onCommand()
  getPriorityOver()
  exposeMixinMethods()
  resetState()
  _getAuthenticatorsForAgent()


Class: Swift_Transport_Esmtp_AuthHandler  - X-Ref

An ESMTP handler for AUTH support.

__construct(array $authenticators)   X-Ref
Create a new AuthHandler with $authenticators for support.

param: Swift_Transport_Esmtp_Authenticator[] $authenticators

setAuthenticators(array $authenticators)   X-Ref
Set the Authenticators which can process a login request.

param: Swift_Transport_Esmtp_Authenticator[] $authenticators

getAuthenticators()   X-Ref
Get the Authenticators which can process a login request.

return: Swift_Transport_Esmtp_Authenticator[]

setUsername($username)   X-Ref
Set the username to authenticate with.

param: string $username

getUsername()   X-Ref
Get the username to authenticate with.

return: string

setPassword($password)   X-Ref
Set the password to authenticate with.

param: string $password

getPassword()   X-Ref
Get the password to authenticate with.

return: string

setAuthMode($mode)   X-Ref
Set the auth mode to use to authenticate.

param: string $mode

getAuthMode()   X-Ref
Get the auth mode to use to authenticate.

return: string

getHandledKeyword()   X-Ref
Get the name of the ESMTP extension this handles.

return: bool

setKeywordParams(array $parameters)   X-Ref
Set the parameters which the EHLO greeting indicated.

param: string[] $parameters

afterEhlo(Swift_Transport_SmtpAgent $agent)   X-Ref
Runs immediately after a EHLO has been issued.

param: Swift_Transport_SmtpAgent $agent to read/write

getMailParams()   X-Ref
Not used.


getRcptParams()   X-Ref
Not used.


onCommand(Swift_Transport_SmtpAgent $agent, $command, $codes = array()   X-Ref
Not used.


getPriorityOver($esmtpKeyword)   X-Ref
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.

param: string $esmtpKeyword to compare with
return: int

exposeMixinMethods()   X-Ref
Returns an array of method names which are exposed to the Esmtp class.

return: string[]

resetState()   X-Ref
Not used.


_getAuthenticatorsForAgent()   X-Ref
Returns the authenticator list for the given agent.

param: Swift_Transport_SmtpAgent $agent
return: array



Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1