PHP Interface Swift_Transport_EsmtpHandler, Halite

Author: Chris Corbyn

Show file Open project: HaliteChallenge/Halite

Public Methods

Method	Description
afterEhlo ( Swift_Transport_SmtpAgent $agent )	Runs immediately after a EHLO has been issued.
exposeMixinMethods ( ) : string[]	Returns an array of method names which are exposed to the Esmtp class.
getHandledKeyword ( ) : boolean	Get the name of the ESMTP extension this handles.
getMailParams ( ) : string[]	Get params which are appended to MAIL FROM:<>.
getPriorityOver ( string $esmtpKeyword ) : integer	Returns +1, -1 or 0 according to the rules for usort().
getRcptParams ( ) : string[]	Get params which are appended to RCPT TO:<>.
onCommand ( Swift_Transport_SmtpAgent $agent, string $command, int[] $codes = [], string[] &$failedRecipients = null, boolean &$stop = false )	Runs when a command is due to be sent.
resetState ( )	Tells this handler to clear any buffers and reset its state.
setKeywordParams ( array $parameters )	Set the parameters which the EHLO greeting indicated.

Runs immediately after a EHLO has been issued.

public afterEhlo ( Swift_Transport_SmtpAgent $agent )
$agent	Swift_Transport_SmtpAgent	to read/write

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

public exposeMixinMethods ( ) : string[]
return	string[]

Get the name of the ESMTP extension this handles.

public getHandledKeyword ( ) : boolean
return	boolean

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

public getMailParams ( ) : string[]
return	string[]

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

public getPriorityOver ( string $esmtpKeyword ) : integer
$esmtpKeyword	string	to compare with
return	integer

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

public getRcptParams ( ) : string[]
return	string[]

Runs when a command is due to be sent.

public onCommand ( Swift_Transport_SmtpAgent $agent, string $command, int[] $codes = [], string[] &$failedRecipients = null, boolean &$stop = false )
$agent	Swift_Transport_SmtpAgent	to read/write
$command	string	to send
$codes	int[]	expected in response
$failedRecipients	string[]	to collect failures
$stop	boolean	to be set true by-reference if the command is now sent

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

public resetState ( )

Set the parameters which the EHLO greeting indicated.

public setKeywordParams ( array $parameters )
$parameters	array