Swift_Transport_EsmtpHandler
in
An ESMTP handler.
Tags
Table of Contents
- afterEhlo() : mixed
- Runs immediately after a EHLO has been issued.
- exposeMixinMethods() : array<string|int, string>
- Returns an array of method names which are exposed to the Esmtp class.
- getHandledKeyword() : string
- Get the name of the ESMTP extension this handles.
- getMailParams() : array<string|int, string>
- Get params which are appended to MAIL FROM:<>.
- getPriorityOver() : int
- Returns +1, -1 or 0 according to the rules for usort().
- getRcptParams() : array<string|int, string>
- Get params which are appended to RCPT TO:<>.
- onCommand() : mixed
- Runs when a command is due to be sent.
- resetState() : mixed
- Tells this handler to clear any buffers and reset its state.
- setKeywordParams() : mixed
- Set the parameters which the EHLO greeting indicated.
Methods
afterEhlo()
Runs immediately after a EHLO has been issued.
public
afterEhlo(Swift_Transport_SmtpAgent $agent) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
Return values
mixed —exposeMixinMethods()
Returns an array of method names which are exposed to the Esmtp class.
public
exposeMixinMethods() : array<string|int, string>
Return values
array<string|int, string> —getHandledKeyword()
Get the name of the ESMTP extension this handles.
public
getHandledKeyword() : string
Return values
string —getMailParams()
Get params which are appended to MAIL FROM:<>.
public
getMailParams() : array<string|int, string>
Return values
array<string|int, string> —getPriorityOver()
Returns +1, -1 or 0 according to the rules for usort().
public
getPriorityOver(string $esmtpKeyword) : int
This method is called to ensure extensions can be execute in an appropriate order.
Parameters
- $esmtpKeyword : string
-
to compare with
Return values
int —getRcptParams()
Get params which are appended to RCPT TO:<>.
public
getRcptParams() : array<string|int, string>
Return values
array<string|int, string> —onCommand()
Runs when a command is due to be sent.
public
onCommand(Swift_Transport_SmtpAgent $agent, string $command[, array<string|int, int> $codes = [] ][, array<string|int, string> &$failedRecipients = null ][, bool &$stop = false ]) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
- $command : string
-
to send
- $codes : array<string|int, int> = []
-
expected in response
- $failedRecipients : array<string|int, string> = null
-
to collect failures
- $stop : bool = false
-
to be set true by-reference if the command is now sent
Return values
mixed —resetState()
Tells this handler to clear any buffers and reset its state.
public
resetState() : mixed
Return values
mixed —setKeywordParams()
Set the parameters which the EHLO greeting indicated.
public
setKeywordParams(array<string|int, string> $parameters) : mixed
Parameters
- $parameters : array<string|int, string>