Swift_Transport_Esmtp_EightBitMimeHandler
in package
implements
Swift_Transport_EsmtpHandler
An ESMTP handler for 8BITMIME support (RFC 6152).
8BITMIME is required when sending 8-bit content to over SMTP, e.g. when using Swift_Mime_ContentEncoder_PlainContentEncoder in "8bit" mode.
8BITMIME mode is enabled unconditionally, even when sending ASCII-only messages, so it should only be used with an outbound SMTP server that will convert the message to 7-bit MIME if the next hop does not support 8BITMIME.
Tags
Interfaces, Classes and Traits
- Swift_Transport_EsmtpHandler
- An ESMTP handler.
Table of Contents
- $encoding : mixed
- __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.
Properties
$encoding
protected
mixed
$encoding
Methods
__construct()
public
__construct([string $encoding = '8BITMIME' ]) : mixed
Parameters
- $encoding : string = '8BITMIME'
-
The parameter so send with the MAIL FROM command; either "8BITMIME" or "7BIT"
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>