Symfony\Component\Mime\Header\MailboxHeader Class Reference

Inheritance diagram for Symfony\Component\Mime\Header\MailboxHeader:

Public Member Functions
	__construct (string $name, Address $address)
	getAddress ()
	getBody ()
	getBodyAsString ()
	setAddress (Address $address)
	setBody ($body)
Public Member Functions inherited from Symfony\Component\Mime\Header\AbstractHeader
	__construct (string $name)
	getCharset ()
	getLanguage ()
	getMaxLineLength ()
	getName ()
	setCharset (string $charset)
	setLanguage (string $lang)
	setMaxLineLength (int $lineLength)
	toString ()

Protected Member Functions
	tokenNeedsEncoding (string $token)
Protected Member Functions inherited from Symfony\Component\Mime\Header\AbstractHeader
	createPhrase (HeaderInterface $header, string $string, string $charset, bool $shorten=false)
	encodeWords (HeaderInterface $header, string $input, int $usedLength=-1)
	generateTokenLines (string $token)
	getEncodableWordTokens (string $string)
	getTokenAsEncodedWord (string $token, int $firstLineOffset=0)
	toTokens (string $string=null)

Additional Inherited Members
Data Fields inherited from Symfony\Component\Mime\Header\AbstractHeader
const	PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\*\+\-\/=\?\^_`\{\}\|~]+(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?)|(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?"((?:(?:[ \t]*(?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21\x23-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))*(?:(?:[ \t]*(?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?))+?)'

Detailed Description

A Mailbox MIME Header for something like Sender (one named address).

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 22 of file MailboxHeader.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Mime\Header\MailboxHeader::__construct	(	string	$name,
		Address	$address
	)

Definition at line 26 of file MailboxHeader.php.

References Symfony\Component\Mime\Header\MailboxHeader\setAddress().

Member Function Documentation

getAddress()

Symfony\Component\Mime\Header\MailboxHeader::getAddress

(

)

Definition at line 59 of file MailboxHeader.php.

Referenced by Symfony\Component\Mime\Header\MailboxHeader\getBody().

getBody()

Symfony\Component\Mime\Header\MailboxHeader::getBody

(

)

Exceptions

RfcComplianceException

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 46 of file MailboxHeader.php.

References Symfony\Component\Mime\Header\MailboxHeader\getAddress().

getBodyAsString()

Symfony\Component\Mime\Header\MailboxHeader::getBodyAsString

(

)

Gets the header's body, prepared for folding into a final header value.

This is not necessarily RFC 2822 compliant since folding white space is not added at this stage (see toString() for that).

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 64 of file MailboxHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\createPhrase(), and Symfony\Component\Mime\Header\AbstractHeader\getCharset().

setAddress()

Symfony\Component\Mime\Header\MailboxHeader::setAddress

(

Address

$address

)

Exceptions

RfcComplianceException

Definition at line 54 of file MailboxHeader.php.

Referenced by Symfony\Component\Mime\Header\MailboxHeader\__construct(), and Symfony\Component\Mime\Header\MailboxHeader\setBody().

setBody()

Symfony\Component\Mime\Header\MailboxHeader::setBody

(

$body

)

Parameters

Address

$body

Exceptions

RfcComplianceException

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 38 of file MailboxHeader.php.

References Symfony\Component\Mime\Header\MailboxHeader\setAddress().

tokenNeedsEncoding()

Symfony\Component\Mime\Header\MailboxHeader::tokenNeedsEncoding ( string  $token )

protected

Redefine the encoding requirements for an address.

All "specials" must be encoded as the full header value will not be quoted

See also

RFC 2822 3.2.1

Reimplemented from Symfony\Component\Mime\Header\AbstractHeader.

Definition at line 81 of file MailboxHeader.php.

---

The documentation for this class was generated from the following file:

• MailboxHeader.php