Interface Swift_Transport_EsmtpHandler

Implemented bySwift_Transport_Esmtp_AuthHandler

An ESMTP handler.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
afterEhlo() Runs immediately after a EHLO has been issued. Swift_Transport_EsmtpHandler
exposeMixinMethods() Returns an array of method names which are exposed to the Esmtp class. Swift_Transport_EsmtpHandler
getHandledKeyword() Get the name of the ESMTP extension this handles. Swift_Transport_EsmtpHandler
getMailParams() Get params which are appended to MAIL FROM:<>. Swift_Transport_EsmtpHandler
getPriorityOver() Returns +1, -1 or 0 according to the rules for usort(). Swift_Transport_EsmtpHandler
getRcptParams() Get params which are appended to RCPT TO:<>. Swift_Transport_EsmtpHandler
onCommand() Runs when a command is due to be sent. Swift_Transport_EsmtpHandler
resetState() Tells this handler to clear any buffers and reset its state. Swift_Transport_EsmtpHandler
setKeywordParams() Set the parameters which the EHLO greeting indicated. Swift_Transport_EsmtpHandler

Method Details

afterEhlo() public abstract method

Runs immediately after a EHLO has been issued.

public abstract void afterEhlo ( Swift_Transport_SmtpAgent $agent )
$agent Swift_Transport_SmtpAgent

To read/write

exposeMixinMethods() public abstract method

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

public abstract string[] exposeMixinMethods ( )
getHandledKeyword() public abstract method

Get the name of the ESMTP extension this handles.

public abstract bool getHandledKeyword ( )
getMailParams() public abstract method

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

public abstract string[] getMailParams ( )
getPriorityOver() public abstract method

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.

public abstract int getPriorityOver ( $esmtpKeyword )
$esmtpKeyword string

To compare with

getRcptParams() public abstract method

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

public abstract string[] getRcptParams ( )
onCommand() public abstract method

Runs when a command is due to be sent.

public abstract void onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients null, &$stop false )
$agent Swift_Transport_SmtpAgent

To read/write

$command string

To send

$codes int

Expected in response

$failedRecipients string[]

To collect failures

$stop bool

To be set true by-reference if the command is now sent

resetState() public abstract method

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

public abstract void resetState ( )
setKeywordParams() public abstract method

Set the parameters which the EHLO greeting indicated.

public abstract void setKeywordParams ( array $parameters )
$parameters string[]