API Documentation
\

\Horde_Mail_Rfc822_Group

Object representation of a RFC 822 group e-mail address.

Summary

Methods
Properties
Constants
__toString()
writeAddress()
match()
__construct()
__set()
__get()
count()
$addresses
$groupname
$groupname_encoded
$label
$valid
No constants found
_writeAddress()
$_groupname
N/A
No private methods found
No private properties found
N/A

Properties

$groupname

$groupname : string

Groupname (UTF-8).

Type

string

$groupname_encoded

$groupname_encoded : string

MIME encoded groupname (UTF-8).

Type

string

$label

$label : string

The shorthand label for this group.

Type

string

$valid

$valid : boolean

Returns true if there is enough information in object to create a valid address.

Type

boolean

$_groupname

$_groupname : string

Group name (MIME decoded).

Type

string

Methods

__toString()

__toString() : string

String representation of object.

Returns

string —

Returns the full e-mail address.

writeAddress()

writeAddress(mixed  $opts = array()) : string

Write an address given information in this part.

Parameters

mixed $opts

If boolean true, is equivalent to passing true for both 'encode' and 'idn'. If an array, these keys are supported:

  • comment: (boolean) If true, include comment(s) in output? @since 2.6.0 DEFAULT: false
  • encode: (mixed) MIME encode the personal/groupname parts? If boolean true, encodes in 'UTF-8'. If a string, encodes using this charset. DEFAULT: false
  • idn: (boolean) If true, encodes IDN domain names (RFC 3490). DEFAULT: false
  • noquote: (boolean) If true, don't quote personal part. [@since 2.4.0] DEFAULT: false

Returns

string —

The correctly escaped/quoted address.

match()

match(mixed  $ob) : boolean

Compare this object against other data.

Parameters

mixed $ob

Address data.

Returns

boolean —

True if the data reflects the same canonical address.

__construct()

__construct(string  $groupname = null, mixed  $addresses = null)

Constructor.

Parameters

string $groupname

If set, used as the group name.
mixed $addresses

If a GroupList object, used as the address list. Any other non-null value is parsed and used as the address list (addresses not verified; sub-groups are ignored).

__set()

__set(  $name,   $value)

Parameters

$name
$value

__get()

__get(  $name)

Parameters

$name

count()

count() : integer

Address count.

Returns

integer —

The number of addresses.

_writeAddress()

_writeAddress(array  $opts) : string

Class-specific implementation of writeAddress().

Parameters

array $opts

See writeAddress().

Returns

string —

The correctly escaped/quoted address.