Documentation

Horde_Mime_Headers_Element_Single extends Horde_Mime_Headers_Element
in package

Interface representing a single named header element that can only appear once in a message part.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.5.0

Table of Contents

$full_value  : string
$name  : string
$value  : string
$value_single  : string
$_name  : string
Header name (UTF-8, although limited to US-ASCII subset by RFCs).
$_values  : array<string|int, mixed>
Header values.
__construct()  : mixed
Constructor.
__get()  : mixed
__toString()  : mixed
getHandles()  : array<string|int, mixed>
Return list of explicit header names handled by this driver.
getIterator()  : mixed
isDefault()  : bool
If true, indicates the contents of the header is the default value.
sendEncode()  : array<string|int, mixed>
Returns the encoded string value(s) needed when sending the header text to a RFC compliant mail submission server.
setValue()  : mixed
Set the value of the header.
_sanityCheck()  : string
Perform sanity checking on a header value.
_sendEncode()  : mixed
TODO
_setValue()  : mixed
TODO

Properties

$full_value read-only

public string $full_value

Full header value.

$name read-only

public string $name

Header name.

$value read-only

public string $value

Header value.

$value_single read-only

public string $value_single

The first header value.

$_name

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

protected string $_name

$_values

Header values.

protected array<string|int, mixed> $_values = array()

Methods

__construct()

Constructor.

public __construct(string $name, mixed $value) : mixed
Parameters
$name : string

Header name.

$value : mixed

Header value(s).

Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__toString()

public __toString() : mixed
Return values
mixed

getHandles()

Return list of explicit header names handled by this driver.

public static getHandles() : array<string|int, mixed>
Return values
array<string|int, mixed>

Header list.

getIterator()

public getIterator() : mixed
Return values
mixed

isDefault()

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

public isDefault() : bool
Tags
since
2.8.0
Return values
bool

True if this header is the default value.

sendEncode()

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

public final sendEncode([array<string|int, mixed> $opts = array() ]) : array<string|int, mixed>
Parameters
$opts : array<string|int, mixed> = array()

Additional options:

  • charset: (string) Charset to encode to. DEFAULT: UTF-8
Return values
array<string|int, mixed>

An array of string values.

setValue()

Set the value of the header.

public final setValue(mixed $value) : mixed
Parameters
$value : mixed

Header value(s).

Return values
mixed

_sanityCheck()

Perform sanity checking on a header value.

protected _sanityCheck(string $data) : string
Parameters
$data : string

The header data.

Return values
string

The cleaned header data.

_sendEncode()

TODO

protected _sendEncode(mixed $opts) : mixed
Parameters
$opts : mixed
Return values
mixed

_setValue()

TODO

protected _setValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

Search results