\Swift_Mime_SimpleHeaderSet
A collection of MIME headers.
- Author: Chris Corbyn
Synopsis
class Swift_Mime_SimpleHeaderSet
implements
Swift_Mime_HeaderSet
{
- // members
- private $_factory;
- private array $_headers;
- private array $_order;
- private array $_required;
- private $_charset;
- // methods
- public void __construct()
- public void setCharset()
- public void addMailboxHeader()
- public void addDateHeader()
- public void addTextHeader()
- public void addParameterizedHeader()
- public void addIdHeader()
- public void addPathHeader()
- public boolean has()
- public void set()
- public Swift_Mime_Header get()
- public array getAll()
- public array listAll()
- public void remove()
- public void removeAll()
- public Swift_Mime_HeaderSet newInstance()
- public void defineOrdering()
- public void setAlwaysDisplayed()
- public void charsetChanged()
- public string toString()
- public string __toString()
- private void _storeHeader()
- private void _canSort()
- private void _sortHeaders()
- private void _isDisplayed()
- private void _notifyHeadersOfCharset()
Hierarchy
Implements
Members
private
-
$_charset
The charset used by Headers -
$_factory
HeaderFactory -
$_headers
Collection of set Headers -
$_order
Field ordering details -
$_required
List of fields which are required to be displayed
Methods
private
- _canSort() — Test if the headers can be sorted
- _isDisplayed() — Test if the given Header is always displayed
- _notifyHeadersOfCharset() — Notify all Headers of the new charset
- _sortHeaders() — uksort() algorithm for Header ordering
- _storeHeader() — Save a Header to the internal collection
public
- __construct() — Create a new SimpleHeaderSet with the given $factory.
- __toString() — Returns a string representation of this object.
- addDateHeader() — Add a new Date header using $timestamp (UNIX time).
- addIdHeader() — Add a new ID header for Message-ID or Content-ID.
- addMailboxHeader() — Add a new Mailbox Header with a list of $addresses.
- addParameterizedHeader() — Add a new ParameterizedHeader with $name, $value and $params.
- addPathHeader() — Add a new Path header with an address (path) in it.
- addTextHeader() — Add a new basic text header with $name and $value.
- charsetChanged() — Notify this observer that the entity's charset has changed.
- defineOrdering() — Define a list of Header names as an array in the correct order.
- get() — Get the header with the given $name.
- getAll() — Get all headers with the given $name.
- has() — Returns true if at least one header with the given $name exists.
- listAll() — Return the name of all Headers
- newInstance() — Create a new instance of this HeaderSet.
- remove() — Remove the header with the given $name if it's set.
- removeAll() — Remove all headers with the given $name.
- set() — Set a header in the HeaderSet.
- setAlwaysDisplayed() — Set a list of header names which must always be displayed when set.
- setCharset() — Set the charset used by these headers.
- toString() — Returns a string with a representation of all headers.