JavaScript Editor Javascript validator     Web page editor 
↑


PEAR Manual
PrevNext

Mail_RFC822::parseAddressList()

Mail_RFC822::parseAddressList() -- extract the parts of a list of email addresses

Synopsis

require_once 'Mail/RFC822.php';

array parseAddressList ([string $address = '', string [$defaultDomain = 'localhost'] [, boolean $nestGroups = NULL [, boolean $validate = NULL]]])

Description

Extracts the given addresses into their parts.

Parameter

Return value

array - a nested array of anonymous objects.

If $nestGroups set to FALSE, you can jump over the next paragraph.

Every array entry contains an object per group. This object has two attributes:

groupname - the name of the group
addresses - an array of all addresses of a group

The addresses array consists of an array of anonymous objects for each address. This object comes with the following attributes:

personal - the name of the address owner
comment - an array, an entry for each comment per address
mailbox - the name of the mailbox, the part before the @
host - the name of the server, the part after the @

Throws

Table 52-1. Possible PEAR_Error values

Error codeError messageReasonSolution
NULL every The given address string is not RFC822 compliant The error code contains a description of the error.

Note

This function can be called statically.

Warning

This class checks the string only. It does not check for the existence of an email address.

Example

Example 52-1. Extract some addresses

<?php
$address = 'My group: "Richard" <richard@localhost>;, ted@example.com (A comment)';

$addresses = Mail_RFC822::parseAddressList($address, 'phpguru.org', TRUE);
print_r($addresses);
?>

PrevHomeNext
RFC822 - IntroductionUpMail_IMAP

→


JavaScript Editor Javascript validator     Web page editor