Docs For Class Swift_Transport_Esmtp

Swift_Transport_Esmtp_AuthHandler __construct(

$authenticators)

Create a new AuthHandler with $authenticators for support.

Tags:

access:

public

Parameters:

Swift_Transport_Esmtp_Authenticator[]

$authenticators

[ Top ]

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 ]

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 ]

Swift_Transport_Esmtp_Authenticator[] getAuthenticators(
)

Get the Authenticators which can process a login request.

Tags:

access:

public

[ Top ]

string getAuthMode(
)

Get the auth mode to use to authenticate.

Tags:

access:

public

[ Top ]

boolean 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 ]

void getMailParams(
)

Not used.

Tags:

access:

public

Implementation of:

Swift_Transport_EsmtpHandler::getMailParams(): Get params which are appended to MAIL FROM:<>.

[ Top ]

string getPassword(
)

Get the password to authenticate with.

Tags:

access:

public

[ Top ]

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 ]

void getRcptParams(
)

Not used.

Tags:

access:

public

Implementation of:

Swift_Transport_EsmtpHandler::getRcptParams(): Get params which are appended to RCPT TO:<>.

[ Top ]

string getUsername(
)

Get the username to authenticate with.

Tags:

access:

public

[ Top ]

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 ]

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 ]

void setAuthenticators(

$authenticators)

Set the Authenticators which can process a login request.

Tags:

access:

public

Parameters:

Swift_Transport_Esmtp_Authenticator[]

$authenticators

[ Top ]

void setAuthMode(
string
$mode)

Set the auth mode to use to authenticate.

Tags:

access:

public

Parameters:

string

$mode

[ Top ]

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 ]

void setPassword(
string
$password)

Set the password to authenticate with.

Tags:

access:

public

Parameters:

string

$password

[ Top ]

void setUsername(
string
$username)

Set the username to authenticate with.

Tags:

access:

public

Parameters:

string

$username

[ Top ]

array _getAuthenticatorsForAgent(
Swift_Transport_SmtpAgent
$agent)

Returns the authenticator list for the given agent.

Tags:

access:

protected

Parameters:

Swift_Transport_SmtpAgent

$agent

[ Top ]

Class: Swift_Transport_Esmtp_AuthHandler

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 63]

Tags:

Parameters:

method afterEhlo [line 162]

Tags:

Parameters:

method exposeMixinMethods [line 225]

Tags:

method getAuthenticators [line 81]

Tags:

method getAuthMode [line 135]

Tags:

method getHandledKeyword [line 144]

Tags:

method getMailParams [line 189]

Tags:

method getPassword [line 117]

Tags:

method getPriorityOver [line 216]

Tags:

Parameters:

method getRcptParams [line 197]

Tags:

method getUsername [line 99]

Tags:

method onCommand [line 205]

Tags:

Parameters:

method resetState [line 233]

Tags:

method setAuthenticators [line 72]

Tags:

Parameters:

method setAuthMode [line 126]

Tags:

Parameters:

method setKeywordParams [line 153]

Tags:

Parameters:

method setPassword [line 108]

Tags:

Parameters:

method setUsername [line 90]

Tags:

Parameters:

method _getAuthenticatorsForAgent [line 245]

Tags:

Parameters: