API Documentation
\

\Horde_Mail_Rfc822_Object

Object representation of an RFC 822 element.

Summary

Methods
Properties
Constants
__toString()
writeAddress()
match()
No public properties found
No constants found
_writeAddress()
No protected properties found
N/A
No private methods found
No private properties found
N/A

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.

_writeAddress()

_writeAddress(array  $opts) : string

Class-specific implementation of writeAddress().

Parameters

array $opts

See writeAddress().

Returns

string —

The correctly escaped/quoted address.