Docs For Class Swift_Mime

Swift_Mime_SimpleHeaderSet __construct(
Swift_Mime_HeaderFactory
$factory, [string
$charset = null])

Create a new SimpleHeaderSet with the given $factory.

Tags:

access:

public

Parameters:

Swift_Mime_HeaderFactory	$factory
string	$charset

[ Top ]

void addDateHeader(
string
$name, [int
$timestamp = null])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addDateHeader(): Add a new Date header using $timestamp (UNIX time).

Parameters:

string	$name
int	$timestamp

[ Top ]

void addIdHeader(
string
$name, [string|array
$ids = null])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addIdHeader(): Add a new ID header for Message-ID or Content-ID.

Parameters:

string	$name
string\|array	$ids

[ Top ]

void addMailboxHeader(
string
$name, [array|string
$addresses = null])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addMailboxHeader(): Add a new Mailbox Header with a list of $addresses.

Parameters:

string	$name
array\|string	$addresses

[ Top ]

void addParameterizedHeader(
string
$name, [string
$value = null], [array
$params = array()])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addParameterizedHeader(): Add a new ParameterizedHeader with $name, $value and $params.

Parameters:

string	$name
string	$value
array	$params

[ Top ]

void addPathHeader(
string
$name, [string
$path = null])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addPathHeader(): Add a new Path header with an address (path) in it.

Parameters:

string	$name
string	$path

[ Top ]

void addTextHeader(
string
$name, [string
$value = null])

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

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::addTextHeader(): Add a new basic text header with $name and $value.

Parameters:

string	$name
string	$value

[ Top ]

void charsetChanged(
string
$charset)

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

Tags:

access:

public

Implementation of:

Swift_Mime_CharsetObserver::charsetChanged(): Notify this observer that the entity's charset has changed.

Parameters:

string

$charset

[ Top ]

void defineOrdering(

$sequence)

Define a list of Header names as an array in the correct order.

These Headers will be output in the given order where present.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::defineOrdering(): Define a list of Header names as an array in the correct order.

Parameters:

array

$sequence

[ Top ]

Swift_Mime_Header get(
string
$name, [int
$index = 0])

Get the header with the given $name.

If multiple headers match, the actual one may be specified by $index. Returns NULL if none present.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::get(): Get the header with the given $name.

Parameters:

string	$name
int	$index

[ Top ]

array getAll(
[string
$name = null])

Get all headers with the given $name.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::getAll(): Get all headers with the given $name.

Parameters:

string

$name

[ Top ]

boolean has(
string
$name, [int
$index = 0])

Returns true if at least one header with the given $name exists.

If multiple headers match, the actual one may be specified by $index.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::has(): Returns true if at least one header with the given $name exists.

Parameters:

string	$name
int	$index

[ Top ]

Swift_Mime_HeaderSet newInstance(
)

Create a new instance of this HeaderSet.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::newInstance(): Create a new instance of this HeaderSet.

[ Top ]

void remove(
string
$name, [int
$index = 0])

Remove the header with the given $name if it's set.

If multiple headers match, the actual one may be specified by $index.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::remove(): Remove the header with the given $name if it's set.

Parameters:

string	$name
int	$index

[ Top ]

void removeAll(
string
$name)

Remove all headers with the given $name.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::removeAll(): Remove all headers with the given $name.

Parameters:

string

$name

[ Top ]

void set(
Swift_Mime_Header
$header, [int
$index = 0])

Set a header in the HeaderSet.

The header may be a previously fetched header via get() or it may be one that has been created separately.

If $index is specified, the header will be inserted into the set at this offset.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::set(): Set a header in the HeaderSet.

Parameters:

Swift_Mime_Header	$header
int	$index

[ Top ]

void setAlwaysDisplayed(

$names)

Set a list of header names which must always be displayed when set.

Usually headers without a field value won't be output unless set here.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::setAlwaysDisplayed(): Set a list of header names which must always be displayed when set.

Parameters:

array

$names

[ Top ]

void setCharset(
string
$charset)

Set the charset used by these headers.

Tags:

access:

public

Parameters:

string

$charset

[ Top ]

string toString(
)

Returns a string with a representation of all headers.

Tags:

access:

public

Implementation of:

Swift_Mime_HeaderSet::toString(): Returns a string with a representation of all headers.

[ Top ]

string __toString(
)

Returns a string representation of this object.

Tags:

see:	Swift_Mime_SimpleHeaderSet::toString()
access:	public

[ Top ]

Class: Swift_Mime_SimpleHeaderSet

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 46]

Tags:

Parameters:

method addDateHeader [line 86]

Tags:

Parameters:

method addIdHeader [line 125]

Tags:

Parameters:

method addMailboxHeader [line 74]

Tags:

Parameters:

method addParameterizedHeader [line 111]

Tags:

Parameters:

method addPathHeader [line 136]

Tags:

Parameters:

method addTextHeader [line 98]

Tags:

Parameters:

method charsetChanged [line 286]

Tags:

Parameters:

method defineOrdering [line 264]

Tags:

Parameters:

method get [line 186]

Tags:

Parameters:

method getAll [line 202]

Tags:

Parameters:

method has [line 151]

Tags:

Parameters:

method newInstance [line 252]

Tags:

method remove [line 230]

Tags:

Parameters:

method removeAll [line 241]

Tags:

Parameters:

method set [line 170]

Tags:

Parameters:

method setAlwaysDisplayed [line 276]

Tags:

Parameters:

method setCharset [line 61]

Tags:

Parameters:

method toString [line 296]

Tags:

method __toString [line 324]

Tags: