Horde_Mail_Rfc822_Object
in package
Object representation of an RFC 822 element.
Tags
Table of Contents
- __toString() : string
- String representation of object.
- match() : bool
- Compare this object against other data.
- writeAddress() : string
- Write an address given information in this part.
- _writeAddress() : string
- Class-specific implementation of writeAddress().
Methods
__toString()
String representation of object.
public
__toString() : string
Return values
string —Returns the full e-mail address.
match()
Compare this object against other data.
public
abstract match(mixed $ob) : bool
Parameters
- $ob : mixed
-
Address data.
Return values
bool —True if the data reflects the same canonical address.
writeAddress()
Write an address given information in this part.
public
writeAddress([mixed $opts = array() ]) : string
Parameters
- $opts : mixed = array()
-
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
Return values
string —The correctly escaped/quoted address.
_writeAddress()
Class-specific implementation of writeAddress().
protected
abstract _writeAddress(array<string|int, mixed> $opts) : string
Parameters
- $opts : array<string|int, mixed>
-
See writeAddress().
Tags
Return values
string —The correctly escaped/quoted address.