Swift_Mime_SimpleHeaderFactory
in package
implements
Swift_Mime_CharsetObserver
Creates MIME headers.
Tags
Interfaces, Classes and Traits
- Swift_Mime_CharsetObserver
- Observes changes in an Mime entity's character set.
Table of Contents
- $addressEncoder : mixed
- Swift_AddressEncoder
- $charset : mixed
- The charset of created Headers
- $emailValidator : mixed
- Strict EmailValidator
- $encoder : mixed
- The HeaderEncoder used by these headers
- $paramEncoder : mixed
- The Encoder used by parameters
- __clone() : mixed
- Make a deep copy of object.
- __construct() : mixed
- Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.
- charsetChanged() : mixed
- Notify this observer that the entity's charset has changed.
- createDateHeader() : Swift_Mime_Header
- Create a new Date header using $dateTime.
- createIdHeader() : Swift_Mime_Header
- Create a new ID header for Message-ID or Content-ID.
- createMailboxHeader() : Swift_Mime_Header
- Create a new Mailbox Header with a list of $addresses.
- createParameterizedHeader() : Swift_Mime_Headers_ParameterizedHeader
- Create a new ParameterizedHeader with $name, $value and $params.
- createPathHeader() : Swift_Mime_Header
- Create a new Path header with an address (path) in it.
- createTextHeader() : Swift_Mime_Header
- Create a new basic text header with $name and $value.
- setHeaderCharset() : mixed
- Apply the charset to the Header
Properties
$addressEncoder
Swift_AddressEncoder
private
mixed
$addressEncoder
$charset
The charset of created Headers
private
mixed
$charset
$emailValidator
Strict EmailValidator
private
mixed
$emailValidator
$encoder
The HeaderEncoder used by these headers
private
mixed
$encoder
$paramEncoder
The Encoder used by parameters
private
mixed
$paramEncoder
Methods
__clone()
Make a deep copy of object.
public
__clone() : mixed
Return values
mixed —__construct()
Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.
public
__construct(Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, EmailValidator $emailValidator[, string|null $charset = null ][, Swift_AddressEncoder $addressEncoder = null ]) : mixed
Parameters
- $encoder : Swift_Mime_HeaderEncoder
- $paramEncoder : Swift_Encoder
- $emailValidator : EmailValidator
- $charset : string|null = null
- $addressEncoder : Swift_AddressEncoder = null
Return values
mixed —charsetChanged()
Notify this observer that the entity's charset has changed.
public
charsetChanged(string $charset) : mixed
Parameters
- $charset : string
Return values
mixed —createDateHeader()
Create a new Date header using $dateTime.
public
createDateHeader(string $name[, DateTimeInterface|null $dateTime = null ]) : Swift_Mime_Header
Parameters
- $name : string
- $dateTime : DateTimeInterface|null = null
Return values
Swift_Mime_Header —createIdHeader()
Create a new ID header for Message-ID or Content-ID.
public
createIdHeader(string $name[, string|array<string|int, mixed> $ids = null ]) : Swift_Mime_Header
Parameters
- $name : string
- $ids : string|array<string|int, mixed> = null
Return values
Swift_Mime_Header —createMailboxHeader()
Create a new Mailbox Header with a list of $addresses.
public
createMailboxHeader(string $name[, array<string|int, mixed>|string|null $addresses = null ]) : Swift_Mime_Header
Parameters
- $name : string
- $addresses : array<string|int, mixed>|string|null = null
Return values
Swift_Mime_Header —createParameterizedHeader()
Create a new ParameterizedHeader with $name, $value and $params.
public
createParameterizedHeader(string $name[, string $value = null ][, array<string|int, mixed> $params = [] ]) : Swift_Mime_Headers_ParameterizedHeader
Parameters
- $name : string
- $value : string = null
- $params : array<string|int, mixed> = []
Return values
Swift_Mime_Headers_ParameterizedHeader —createPathHeader()
Create a new Path header with an address (path) in it.
public
createPathHeader(string $name[, string $path = null ]) : Swift_Mime_Header
Parameters
- $name : string
- $path : string = null
Return values
Swift_Mime_Header —createTextHeader()
Create a new basic text header with $name and $value.
public
createTextHeader(string $name[, string $value = null ]) : Swift_Mime_Header
Parameters
- $name : string
- $value : string = null
Return values
Swift_Mime_Header —setHeaderCharset()
Apply the charset to the Header
private
setHeaderCharset(Swift_Mime_Header $header) : mixed
Parameters
- $header : Swift_Mime_Header