Class Swift_Transport_Esmtp_AuthHandler

An ESMTP handler for AUTH support.

Swift_Transport_Esmtp_AuthHandler implements Swift_Transport_EsmtpHandler

Package: Swift\Transport
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Transport/Esmtp/AuthHandler.php

Methods summary

`public`	# `__construct( array $authenticators )` Create a new AuthHandler with $authenticators for support. Create a new AuthHandler with $authenticators for support. Parameters `$authenticators` `Swift_Transport_Esmtp_Authenticator[]` $authenticators
`public`	# `setAuthenticators( array $authenticators )` Set the Authenticators which can process a login request. Set the Authenticators which can process a login request. Parameters `$authenticators` `Swift_Transport_Esmtp_Authenticator[]` $authenticators
`public Swift_Transport_Esmtp_Authenticator[]`	# `getAuthenticators( )` Get the Authenticators which can process a login request. Get the Authenticators which can process a login request. Returns `Swift_Transport_Esmtp_Authenticator[]`
`public`	# `setUsername( string $username )` Set the username to authenticate with. Set the username to authenticate with. Parameters `$username` `string` $username
`public string`	# `getUsername( )` Get the username to authenticate with. Get the username to authenticate with. Returns `string`
`public`	# `setPassword( string $password )` Set the password to authenticate with. Set the password to authenticate with. Parameters `$password` `string` $password
`public string`	# `getPassword( )` Get the password to authenticate with. Get the password to authenticate with. Returns `string`
`public`	# `setAuthMode( string $mode )` Set the auth mode to use to authenticate. Set the auth mode to use to authenticate. Parameters `$mode` `string` $mode
`public string`	# `getAuthMode( )` Get the auth mode to use to authenticate. Get the auth mode to use to authenticate. Returns `string`
`public boolean`	# `getHandledKeyword( )` Get the name of the ESMTP extension this handles. Get the name of the ESMTP extension this handles. Returns `boolean` Implementation of `Swift_Transport_EsmtpHandler::getHandledKeyword()`
`public`	# `setKeywordParams( array $parameters )` Set the parameters which the EHLO greeting indicated. Set the parameters which the EHLO greeting indicated. Parameters `$parameters` `string[]` $parameters Implementation of `Swift_Transport_EsmtpHandler::setKeywordParams()`
`public`	# `afterEhlo( Swift_Transport_SmtpAgent $agent )` Runs immediately after a EHLO has been issued. Runs immediately after a EHLO has been issued. Parameters `$agent` `Swift_Transport_SmtpAgent` $agent to read/write Implementation of `Swift_Transport_EsmtpHandler::afterEhlo()`
`public string[]`	# `getMailParams( )` Not used. Not used. Returns `string[]` Implementation of `Swift_Transport_EsmtpHandler::getMailParams()`
`public string[]`	# `getRcptParams( )` Not used. Not used. Returns `string[]` Implementation of `Swift_Transport_EsmtpHandler::getRcptParams()`
`public`	# `onCommand( Swift_Transport_SmtpAgent $agent, string $command, int[] $codes = array(), string[] & $failedRecipients = null, boolean & $stop = false )` Not used. Not used. Parameters `$agent` `Swift_Transport_SmtpAgent` $agent to read/write `$command` `string` $command to send `$codes` `int[]` $codes expected in response `$failedRecipients` `string[]` &$failedRecipients `$stop` `boolean` &$stop to be set true if the command is now sent Implementation of `Swift_Transport_EsmtpHandler::onCommand()`
`public integer`	# `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. 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. Parameters `$esmtpKeyword` `string` $esmtpKeyword to compare with Returns `integer` Implementation of `Swift_Transport_EsmtpHandler::getPriorityOver()`
`public string[]`	# `exposeMixinMethods( )` Returns an array of method names which are exposed to the Esmtp class. Returns an array of method names which are exposed to the Esmtp class. Returns `string[]` Implementation of `Swift_Transport_EsmtpHandler::exposeMixinMethods()`
`public`	# `resetState( )` Not used. Not used. Implementation of `Swift_Transport_EsmtpHandler::resetState()`
`protected array`	# `_getAuthenticatorsForAgent( )` Returns the authenticator list for the given agent. Returns the authenticator list for the given agent. Returns `array`

Magic methods summary

Properties summary

`private Swift_Transport_Esmtp_Authenticator[]`	`$_authenticators`	# Authenticators available to process the request. Authenticators available to process the request.
`private string`	`$_username`	# The username for authentication. The username for authentication.
`private string`	`$_password`	# The password for authentication. The password for authentication.
`private string`	`$_auth_mode`	# The auth mode for authentication. The auth mode for authentication.
`private string[]`	`$_esmtpParams`	# The ESMTP AUTH parameters available. The ESMTP AUTH parameters available.