Class Swift_Mime_Headers_MailboxHeader

A Mailbox Address MIME Header for something like From or Sender.

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header

Extended by

Swift_Mime_Headers_MailboxHeader

Package: Swift\Mime
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Mime/Headers/MailboxHeader.php

Methods summary

`public`	# `__construct( string $name, Swift_Mime_HeaderEncoder $encoder, Swift_Mime_Grammar $grammar )` Creates a new MailboxHeader with $name. Creates a new MailboxHeader with $name. Parameters `$name` `string` $name of Header `$encoder` `Swift_Mime_HeaderEncoder` $encoder `$grammar` `Swift_Mime_Grammar` $grammar Overrides `Swift_Mime_Headers_AbstractHeader::__construct`
`public integer`	# `getFieldType( )` Get the type of Header that this instance represents. Get the type of Header that this instance represents. Returns `integer` See `Swift_Mime_Header::TYPE_TEXT`, `Swift_Mime_Header::TYPE_PARAMETERIZED`, `Swift_Mime_Header::TYPE_MAILBOX` `Swift_Mime_Header::TYPE_DATE`, `Swift_Mime_Header::TYPE_ID`, `Swift_Mime_Header::TYPE_PATH`
`public`	# `setFieldBodyModel( mixed $model )` Set the model for the field body. This method takes a string, or an array of addresses. Set the model for the field body. This method takes a string, or an array of addresses. Parameters `$model` `mixed` $model Throws `Swift_RfcComplianceException`
`public array`	# `getFieldBodyModel( )` Get the model for the field body. This method returns an associative array like `Swift_Mime_Headers_MailboxHeader::getNameAddresses()` Get the model for the field body. This method returns an associative array like `Swift_Mime_Headers_MailboxHeader::getNameAddresses()` Returns `array` Throws `Swift_RfcComplianceException`
`public`	# `setNameAddresses( string\|string[] $mailboxes )` Set a list of mailboxes to be shown in this Header. The mailboxes can be a simple array of addresses, or an array of key=>value pairs where (email => personalName). Example: <?php //Sets two mailboxes in the Header, one with a personal name $header->setNameAddresses(array( 'chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' //No associated personal name )); ?> Set a list of mailboxes to be shown in this Header. The mailboxes can be a simple array of addresses, or an array of key=>value pairs where (email => personalName). Example: <?php //Sets two mailboxes in the Header, one with a personal name $header->setNameAddresses(array( 'chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' //No associated personal name )); ?> Parameters `$mailboxes` `string\|string[]` $mailboxes Throws `Swift_RfcComplianceException` See `Swift_Mime_Headers_MailboxHeader::__construct()` `Swift_Mime_Headers_MailboxHeader::setAddresses()` setValue()
`public string[]`	# `getNameAddressStrings( )` Get the full mailbox list of this Header as an array of valid RFC 2822 strings. Example: <?php $header = new Swift_Mime_Headers_MailboxHeader('From', array('chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' => 'Mark Corbyn') ); print_r($header->getNameAddressStrings()); // array ( // 0 => Chris Corbyn <chris@swiftmailer.org>, // 1 => Mark Corbyn <mark@swiftmailer.org> // ) ?> Get the full mailbox list of this Header as an array of valid RFC 2822 strings. Example: <?php $header = new Swift_Mime_Headers_MailboxHeader('From', array('chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' => 'Mark Corbyn') ); print_r($header->getNameAddressStrings()); // array ( // 0 => Chris Corbyn <chris@swiftmailer.org>, // 1 => Mark Corbyn <mark@swiftmailer.org> // ) ?> Returns `string[]` Throws `Swift_RfcComplianceException` See `Swift_Mime_Headers_MailboxHeader::getNameAddresses()` `Swift_Mime_Headers_AbstractHeader::toString()`
`public string[]`	# `getNameAddresses( )` Get all mailboxes in this Header as key=>value pairs. The key is the address and the value is the name (or null if none set). Example: <?php $header = new Swift_Mime_Headers_MailboxHeader('From', array('chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' => 'Mark Corbyn') ); print_r($header->getNameAddresses()); // array ( // chris@swiftmailer.org => Chris Corbyn, // mark@swiftmailer.org => Mark Corbyn // ) ?> Get all mailboxes in this Header as key=>value pairs. The key is the address and the value is the name (or null if none set). Example: <?php $header = new Swift_Mime_Headers_MailboxHeader('From', array('chris@swiftmailer.org' => 'Chris Corbyn', 'mark@swiftmailer.org' => 'Mark Corbyn') ); print_r($header->getNameAddresses()); // array ( // chris@swiftmailer.org => Chris Corbyn, // mark@swiftmailer.org => Mark Corbyn // ) ?> Returns `string[]` See `Swift_Mime_Headers_MailboxHeader::getAddresses()` `Swift_Mime_Headers_MailboxHeader::getNameAddressStrings()`
`public`	# `setAddresses( string[] $addresses )` Makes this Header represent a list of plain email addresses with no names. Example: <?php //Sets three email addresses as the Header data $header->setAddresses( array('one@domain.tld', 'two@domain.tld', 'three@domain.tld') ); ?> Makes this Header represent a list of plain email addresses with no names. Example: <?php //Sets three email addresses as the Header data $header->setAddresses( array('one@domain.tld', 'two@domain.tld', 'three@domain.tld') ); ?> Parameters `$addresses` `string[]` $addresses Throws `Swift_RfcComplianceException` See `Swift_Mime_Headers_MailboxHeader::setNameAddresses()` setValue()
`public string[]`	# `getAddresses( )` Get all email addresses in this Header. Get all email addresses in this Header. Returns `string[]` See `Swift_Mime_Headers_MailboxHeader::getNameAddresses()`
`public`	# `removeAddresses( string\|string[] $addresses )` Remove one or more addresses from this Header. Remove one or more addresses from this Header. Parameters `$addresses` `string\|string[]` $addresses
`public string`	# `getFieldBody( )` Get the string value of the body in this Header. This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see `Swift_Mime_Headers_AbstractHeader::toString()` for that). Get the string value of the body in this Header. This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see `Swift_Mime_Headers_AbstractHeader::toString()` for that). Returns `string` Throws `Swift_RfcComplianceException` See `Swift_Mime_Headers_AbstractHeader::toString()`
`protected string[]`	# `normalizeMailboxes( array $mailboxes )` Normalizes a user-input list of mailboxes into consistent key=>value pairs. Normalizes a user-input list of mailboxes into consistent key=>value pairs. Parameters `$mailboxes` `string[]` $mailboxes Returns `string[]`
`protected string`	# `createDisplayNameString( string $displayName, boolean $shorten = false )` Produces a compliant, formatted display-name based on the string given. Produces a compliant, formatted display-name based on the string given. Parameters `$displayName` `string` $displayName as displayed `$shorten` `boolean` $shorten the first line to make remove for header name Returns `string`
`protected string`	# `createMailboxListString( array $mailboxes )` Creates a string form of all the mailboxes in the passed array. Creates a string form of all the mailboxes in the passed array. Parameters `$mailboxes` `string[]` $mailboxes Returns `string` Throws `Swift_RfcComplianceException`
`protected boolean`	# `tokenNeedsEncoding( string $token )` Redefine the encoding requirements for mailboxes. Commas and semicolons are used to separate multiple addresses, and should therefore be encoded Redefine the encoding requirements for mailboxes. Commas and semicolons are used to separate multiple addresses, and should therefore be encoded Parameters `$token` `string` $token Returns `boolean` Overrides `Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding`
`private string[]`	# `_createNameAddressStrings( array $mailboxes )` Return an array of strings conforming the the name-addr spec of RFC 2822. Return an array of strings conforming the the name-addr spec of RFC 2822. Parameters `$mailboxes` `string[]` $mailboxes Returns `string[]`
`private`	# `_assertValidAddress( string $address )` Throws an Exception if the address passed does not comply with RFC 2822. Throws an Exception if the address passed does not comply with RFC 2822. Parameters `$address` `string` $address Throws `Swift_RfcComplianceException` If invalid.

Methods inherited from Swift_Mime_Headers_AbstractHeader

__toString(), clearCachedValueIf(), createPhrase(), encodeWords(), generateTokenLines(), getCachedValue(), getCharset(), getEncodableWordTokens(), getEncoder(), getFieldName(), getGrammar(), getLanguage(), getMaxLineLength(), getTokenAsEncodedWord(), setCachedValue(), setCharset(), setEncoder(), setFieldName(), setGrammar(), setLanguage(), setMaxLineLength(), toString(), toTokens()

Magic methods summary

Constants summary

Constants inherited from Swift_Mime_Header

TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT

Properties summary

`private string[]`	`$_mailboxes`	# The mailboxes used in this Header. The mailboxes used in this Header.