PHP Class Swift_Mime_SimpleHeaderFactory, Halite

Author: Chris Corbyn
Inheritance: implements Swift_Mime_HeaderFactory
Show file Open project: HaliteChallenge/Halite Class Usage Examples

Public Methods

Method Description
__clone ( ) Make a deep copy of object.
__construct ( Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, Swift_Mime_Grammar $grammar, string | null $charset = null ) Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.
charsetChanged ( string $charset ) Notify this observer that the entity's charset has changed.
createDateHeader ( string $name, integer | null $timestamp = null ) : Swift_Mime_Header Create a new Date header using $timestamp (UNIX time).
createIdHeader ( string $name, string | array $ids = null ) : Swift_Mime_Header Create a new ID header for Message-ID or Content-ID.
createMailboxHeader ( string $name, array | string | null $addresses = null ) : Swift_Mime_Header Create a new Mailbox Header with a list of $addresses.
createParameterizedHeader ( string $name, string $value = null, array $params = [] ) : Swift_Mime_ParameterizedHeader Create a new ParameterizedHeader with $name, $value and $params.
createPathHeader ( string $name, string $path = null ) : Swift_Mime_Header Create a new Path header with an address (path) in it.
createTextHeader ( string $name, string $value = null ) : Swift_Mime_Header Create a new basic text header with $name and $value.

Private Methods

Method Description
_setHeaderCharset ( Swift_Mime_Header $header ) Apply the charset to the Header

Method Details

__clone() public method

Make a deep copy of object.
public __clone ( )

__construct() public method

Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.
public __construct ( Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, Swift_Mime_Grammar $grammar, string | null $charset = null )
$encoder Swift_Mime_HeaderEncoder
$paramEncoder Swift_Encoder
$grammar Swift_Mime_Grammar
$charset string | null

charsetChanged() public method

Notify this observer that the entity's charset has changed.
public charsetChanged ( string $charset )
$charset string

createDateHeader() public method

Create a new Date header using $timestamp (UNIX time).
public createDateHeader ( string $name, integer | null $timestamp = null ) : Swift_Mime_Header
$name string
$timestamp integer | null
return Swift_Mime_Header

createIdHeader() public method

Create a new ID header for Message-ID or Content-ID.
public createIdHeader ( string $name, string | array $ids = null ) : Swift_Mime_Header
$name string
$ids string | array
return Swift_Mime_Header

createMailboxHeader() public method

Create a new Mailbox Header with a list of $addresses.
public createMailboxHeader ( string $name, array | string | null $addresses = null ) : Swift_Mime_Header
$name string
$addresses array | string | null
return Swift_Mime_Header

createParameterizedHeader() public method

Create a new ParameterizedHeader with $name, $value and $params.
public createParameterizedHeader ( string $name, string $value = null, array $params = [] ) : Swift_Mime_ParameterizedHeader
$name string
$value string
$params array
return Swift_Mime_ParameterizedHeader

createPathHeader() public method

Create a new Path header with an address (path) in it.
public createPathHeader ( string $name, string $path = null ) : Swift_Mime_Header
$name string
$path string
return Swift_Mime_Header

createTextHeader() public method

Create a new basic text header with $name and $value.
public createTextHeader ( string $name, string $value = null ) : Swift_Mime_Header
$name string
$value string
return Swift_Mime_Header