Swift_Transport_EsmtpHandler Interface Reference

Inheritance diagram for Swift_Transport_EsmtpHandler:

Public Member Functions
	getHandledKeyword ()
	setKeywordParams (array $parameters)
	afterEhlo (Swift_Transport_SmtpAgent $agent)
	getMailParams ()
	getRcptParams ()
	onCommand (Swift_Transport_SmtpAgent $agent, $command, $codes=array(), &$failedRecipients=null, &$stop=false)
	getPriorityOver ($esmtpKeyword)
	exposeMixinMethods ()
	resetState ()

Detailed Description

An ESMTP handler.

Author

Chris Corbyn

Definition at line 16 of file EsmtpHandler.php.

Member Function Documentation

afterEhlo

(

Swift_Transport_SmtpAgent

$agent

)

Runs immediately after a EHLO has been issued.

Parameters

Swift_Transport_SmtpAgent

$agent

to read/write

Implemented in Swift_Transport_Esmtp_AuthHandler.

exposeMixinMethods

(

)

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

Returns

string[]

Implemented in Swift_Transport_Esmtp_AuthHandler.

getHandledKeyword

(

)

Get the name of the ESMTP extension this handles.

Returns

bool

Implemented in Swift_Transport_Esmtp_AuthHandler.

getMailParams

(

)

Get params which are appended to MAIL FROM:<>.

Returns

string[]

Implemented in Swift_Transport_Esmtp_AuthHandler.

getPriorityOver

(

$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.

Parameters

string

$esmtpKeyword

to compare with

Returns

int

Implemented in Swift_Transport_Esmtp_AuthHandler.

getRcptParams

(

)

Get params which are appended to RCPT TO:<>.

Returns

string[]

Implemented in Swift_Transport_Esmtp_AuthHandler.

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

Runs when a command is due to be sent.

Parameters

Swift_Transport_SmtpAgent	$agent	to read/write
string	$command	to send
	int[]	$codes expected in response
	string[]	$failedRecipients to collect failures
bool	$stop	to be set true by-reference if the command is now sent

Implemented in Swift_Transport_Esmtp_AuthHandler.

resetState

(

)

Tells this handler to clear any buffers and reset its state.

Implemented in Swift_Transport_Esmtp_AuthHandler.

setKeywordParams

(

array

$parameters

)

Set the parameters which the EHLO greeting indicated.

Parameters

string[]

$parameters

Implemented in Swift_Transport_Esmtp_AuthHandler.