Swift_Transport_Esmtp_SmtpUtf8Handler
in package
implements
Swift_Transport_EsmtpHandler
An ESMTP handler for SMTPUTF8 support (RFC 6531).
SMTPUTF8 is required when sending to email addresses containing non-ASCII characters in local-part (the substring before @). This handler should be used together with Swift_AddressEncoder_Utf8AddressEncoder.
SMTPUTF8 mode is enabled unconditionally, even when sending to ASCII-only addresses, so it should only be used with an outbound SMTP server that will deliver ASCII-only messages even if the next hop does not support SMTPUTF8.
Tags
Interfaces, Classes and Traits
- Swift_Transport_EsmtpHandler
- An ESMTP handler.
Table of Contents
- __construct() : mixed
- afterEhlo() : mixed
- Not used.
- exposeMixinMethods() : array<string|int, string>
- Not used.
- 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>
- Not used.
- onCommand() : mixed
- Not used.
- resetState() : mixed
- Not used.
- setKeywordParams() : mixed
- Not used.
Methods
__construct()
public
__construct() : mixed
Return values
mixed —afterEhlo()
Not used.
public
afterEhlo(Swift_Transport_SmtpAgent $agent) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
Return values
mixed —exposeMixinMethods()
Not used.
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()
Not used.
public
getRcptParams() : array<string|int, string>
Return values
array<string|int, string> —onCommand()
Not used.
public
onCommand(Swift_Transport_SmtpAgent $agent, mixed $command[, mixed $codes = [] ][, mixed &$failedRecipients = null ][, mixed &$stop = false ]) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
- $command : mixed
-
to send
- $codes : mixed = []
-
expected in response
- $failedRecipients : mixed = null
-
to collect failures
- $stop : mixed = false
-
to be set true by-reference if the command is now sent
Return values
mixed —resetState()
Not used.
public
resetState() : mixed
Return values
mixed —setKeywordParams()
Not used.
public
setKeywordParams(array<string|int, mixed> $parameters) : mixed
Parameters
- $parameters : array<string|int, mixed>