Docs For Class Swift_Transport

Class: Swift_Transport_EsmtpHandler

Class Details

[line 19]
An ESMTP handler.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

Class Methods

method afterEhlo [line 38]

void afterEhlo(
Swift_Transport_SmtpAgent
$agent)

Runs immediately after a EHLO has been issued.

Tags:

access:

public

Parameters:

Swift_Transport_SmtpAgent

$agent

to read/write

[ Top ]

method exposeMixinMethods [line 75]

string[] exposeMixinMethods(
)

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

Tags:

access:

public

[ Top ]

method getHandledKeyword [line 26]

boolean getHandledKeyword(
)

Get the name of the ESMTP extension this handles.

Tags:

access:

public

[ Top ]

method getMailParams [line 44]

string[] getMailParams(
)

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

Tags:

access:

public

[ Top ]

method getPriorityOver [line 69]

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

Parameters:

string

$esmtpKeyword

to compare with

[ Top ]

method getRcptParams [line 50]

string[] getRcptParams(
)

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

Tags:

access:

public

[ Top ]

method onCommand [line 60]

void onCommand(
Swift_Transport_SmtpAgent
$agent, string
$command, [int[]
$codes = array()], [string[]
&$failedRecipients = null], [boolean
&$stop = false])

Runs when a command is due to be sent.

Tags:

access:

public

Parameters:

Swift_Transport_SmtpAgent	$agent	to read/write
string	$command	to send
int[]	$codes	expected in response
string[]	&$failedRecipients
boolean	&$stop	to be set true if the command is now sent

[ Top ]

method resetState [line 80]

void resetState(
)

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

Tags:

access:

public

[ Top ]

method setKeywordParams [line 32]

void setKeywordParams(

$parameters)

Set the parameters which the EHLO greeting indicated.

Tags:

access:

public

Parameters:

string[]

$parameters

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:33:15 -0500 by phpDocumentor 1.4.3

Class: Swift_Transport_EsmtpHandler

Interface Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

method afterEhlo [line 38]

Tags:

Parameters:

method exposeMixinMethods [line 75]

Tags:

method getHandledKeyword [line 26]

Tags:

method getMailParams [line 44]

Tags:

method getPriorityOver [line 69]

Tags:

Parameters:

method getRcptParams [line 50]

Tags:

method onCommand [line 60]

Tags:

Parameters:

method resetState [line 80]

Tags:

method setKeywordParams [line 32]

Tags:

Parameters: