Swift_Mime_SimpleHeaderFactory Class Reference

Inheritance diagram for Swift_Mime_SimpleHeaderFactory:

Public Member Functions
	__construct (Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, Swift_Mime_Grammar $grammar, $charset=null)
	createMailboxHeader ($name, $addresses=null)
	createDateHeader ($name, $timestamp=null)
	createTextHeader ($name, $value=null)
	createParameterizedHeader ($name, $value=null, $params=array())
	createIdHeader ($name, $ids=null)
	createPathHeader ($name, $path=null)
	charsetChanged ($charset)
	__clone ()

Private Member Functions
	_setHeaderCharset (Swift_Mime_Header $header)

Private Attributes
	$_encoder
	$_paramEncoder
	$_grammar
	$_charset

Detailed Description

Creates MIME headers.

Author

Chris Corbyn

Definition at line 16 of file SimpleHeaderFactory.php.

Constructor & Destructor Documentation

__construct	(	Swift_Mime_HeaderEncoder	$encoder,
		Swift_Encoder	$paramEncoder,
		Swift_Mime_Grammar	$grammar,
			$charset = null
	)

Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.

Parameters

Swift_Mime_HeaderEncoder	$encoder
Swift_Encoder	$paramEncoder
Swift_Mime_Grammar	$grammar
string | null	$charset

Definition at line 38 of file SimpleHeaderFactory.php.

Member Function Documentation

__clone

(

)

Make a deep copy of object.

Definition at line 185 of file SimpleHeaderFactory.php.

References $_encoder, and $_paramEncoder.

_setHeaderCharset ( Swift_Mime_Header  $header )

private

Apply the charset to the Header

Definition at line 192 of file SimpleHeaderFactory.php.

References Swift_Mime_Header\setCharset().

Referenced by createDateHeader(), createIdHeader(), createMailboxHeader(), createParameterizedHeader(), createPathHeader(), and createTextHeader().

charsetChanged

(

$charset

)

Notify this observer that the entity's charset has changed.

Parameters

string

$charset

Implements Swift_Mime_CharsetObserver.

Definition at line 175 of file SimpleHeaderFactory.php.

createDateHeader	(		$name,
			$timestamp = null
	)

Create a new Date header using $timestamp (UNIX time).

Parameters

string	$name
int | null	$timestamp

Returns

Swift_Mime_Header

Implements Swift_Mime_HeaderFactory.

Definition at line 73 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

createIdHeader	(		$name,
			$ids = null
	)

Create a new ID header for Message-ID or Content-ID.

Parameters

string	$name
string | array	$ids

Returns

Swift_Mime_Header

Implements Swift_Mime_HeaderFactory.

Definition at line 140 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

createMailboxHeader	(		$name,
			$addresses = null
	)

Create a new Mailbox Header with a list of $addresses.

Parameters

string	$name
array | string | null	$addresses

Returns

Swift_Mime_Header

Implements Swift_Mime_HeaderFactory.

Definition at line 54 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

createParameterizedHeader	(		$name,
			$value = null,
			$params = array()
	)

Create a new ParameterizedHeader with $name, $value and $params.

Parameters

string	$name
string	$value
array	$params

Returns

Swift_Mime_ParameterizedHeader

Implements Swift_Mime_HeaderFactory.

Definition at line 112 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

createPathHeader	(		$name,
			$path = null
	)

Create a new Path header with an address (path) in it.

Parameters

string	$name
string	$path

Returns

Swift_Mime_Header

Implements Swift_Mime_HeaderFactory.

Definition at line 159 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

createTextHeader	(		$name,
			$value = null
	)

Create a new basic text header with $name and $value.

Parameters

string	$name
string	$value

Returns

Swift_Mime_Header

Implements Swift_Mime_HeaderFactory.

Definition at line 92 of file SimpleHeaderFactory.php.

References _setHeaderCharset().

Member Data Documentation

$_charset

private

The charset of created Headers

Definition at line 28 of file SimpleHeaderFactory.php.

$_encoder

private

The HeaderEncoder used by these headers

Definition at line 19 of file SimpleHeaderFactory.php.

Referenced by __clone().

$_grammar

private

The Grammar

Definition at line 25 of file SimpleHeaderFactory.php.

$_paramEncoder

private

The Encoder used by parameters

Definition at line 22 of file SimpleHeaderFactory.php.

Referenced by __clone().