API Documentation
\

\Horde_ListHeaders

Class to parse List Header fields (RFC 2369/2919).

Summary

Methods
Properties
Constants
headers()
listHeadersExist()
parse()
No public properties found
No constants found
_parseBase()
_parseListId()
_parseListPost()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

headers()

headers() : array

Returns the list of valid mailing list headers.

Returns

array —

The list of valid mailing list headers.

listHeadersExist()

listHeadersExist(\Horde_Mime_Headers  $ob) : boolean

Do any mailing list headers exist?

Parameters

\Horde_Mime_Headers $ob

Headers object.

Returns

boolean —

True if any mailing list headers exist.

parse()

parse(string  $id, string  $value) : mixed

Parse a list header.

Parameters

string $id

Header ID.
string $value

Header value.

Returns

mixed —

An array of Horde_ListHeaders_Base objects, a Horde_ListHeaders_Id object, or false if unable to parse.

_parseBase()

_parseBase() : array

Parse a base list header (RFC 2369).

Returns

array —

List of Horde_List_Headers_Base objects.

_parseListId()

_parseListId() : \Horde_ListHeaders_Id

Parse a List-ID (RFC 2919).

Returns

\Horde_ListHeaders_Id —

Id object.

_parseListPost()

_parseListPost() : array

Parse a List-Post header (RFC 2369 [3.4]).

Returns

array —

List of Horde_List_Headers_Base objects.