API Documentation
\

\Horde_Mime_Headers_AddressesMulti

This class represents address fields that may appear multiple times in a message part (i.e. they are independent of each other) (RFC 5322).

Summary

Methods
Properties
Constants
__get()
__construct()
setValue()
sendEncode()
isDefault()
getHandles()
getIterator()
__clone()
getAddressList()
$full_value
$value
$name
$value_single
No constants found
_setValue()
_sendEncode()
_sanityCheck()
$_name
$_values
N/A
No private methods found
No private properties found
N/A

Properties

$full_value

$full_value : array

List of full header values (strings).

Type

array

$value

$value : array

List of header values (strings).

Type

array

$name

$name : string

Header name.

Type

string

$value_single

$value_single : string

The first header value.

Type

string

$_name

$_name : string

Header name (UTF-8, although limited to US-ASCII subset by RFCs).

Type

string

$_values

$_values : array

Header values.

Type

array

Methods

__get()

__get(  $name)

Parameters

$name

__construct()

__construct(string  $name, mixed  $value)

Constructor.

Parameters

string $name

Header name.
mixed $value

Header value(s).

setValue()

setValue(mixed  $value)

Set the value of the header.

Parameters

mixed $value

Header value(s).

sendEncode()

sendEncode(array  $opts = array()) : array

Returns the encoded string value(s) needed when sending the header text to a RFC compliant mail submission server.

Parameters

array $opts

Additional options:

  • charset: (string) Charset to encode to. DEFAULT: UTF-8

Returns

array —

An array of string values.

isDefault()

isDefault() : boolean

If true, indicates the contents of the header is the default value.

Returns

boolean —

True if this header is the default value.

getHandles()

getHandles()

getIterator()

getIterator()

__clone()

__clone()

getAddressList()

getAddressList(boolean  $first = false) : mixed

Return the address list representation(s) for this header.

Parameters

boolean $first

If true, return only the first element rather than the entire list.

Returns

mixed —

A Horde_Mail_Rfc822_List object (if $first is true) or an array of those objects.

_setValue()

_setValue(  $value)

TODO

Parameters

$value

_sendEncode()

_sendEncode(array  $opts)

Parameters

array $opts

See Horde_Mime_Headers_Addresses#doSendEncode().

_sanityCheck()

_sanityCheck(string  $data) : string

Perform sanity checking on a header value.

Parameters

string $data

The header data.

Returns

string —

The cleaned header data.