Mail_RFC822::parseAddressList()
Prev		Next

Mail_RFC822::parseAddressList()

Mail_RFC822::parseAddressList() – メールアドレスの一覧から各部分を展開する

Synopsis

require_once 'Mail/RFC822.php';

array parseAddressList ( string $address = '' , string $defaultDomain = 'localhost' , boolean $nestGroups = = null , boolean $validate = = null )

Description

指定したアドレスを各部分に展開します。

Parameter

string $address - 検証するアドレス。
string $defaultDomain - 指定されたアドレスでドメインが指定されていない場合に使用する、デフォルトのドメイン。
boolean $nestGroups - 結果を入れ子構造の見やすい形式で返すかどうか。
boolean $validate - atom の検証を行うかどうか。例えば、名前をエンコードする前にアドレスの検証をしたい場合などにこれを Off にします。

Return value

array - 入れ子状の配列、あるいは無名オブジェクトの配列を返します。

$nestGroups が FALSE の場合は、次の段落を読み飛ばしてください。

配列のエントリはグループ単位のオブジェクトとなっています。このオブジェクトは二つの属性を持っています。

groupname - グループの名前。
addresses - グループ内のすべてのアドレスの配列。

配列 addresses は、各アドレスを表す無名オブジェクトの配列です。このオブジェクトは次の属性を持っています。

personal - アドレスの所有者名。
comment - アドレスについてのコメントを保持する配列。
mailbox - メールボックスの名前。@ の前の部分。
host - サーバの名前。@ の後の部分。

Throws

**Possible PEAR_Error values**
エラーコード	エラーメッセージ	原因	対応
NULL	すべて	指定した文字列は RFC822 に準拠していません。	エラーの内容がエラーコードに含まれます。

Note

This function can be called statically.

このクラスがチェックするのは文字列だけです。そのアドレスが実際に存在するかどうかはチェックしません。

Example

アドレスの展開


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

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

Prev	Mail	Next
RFC822 - 導入	PEAR Manual	Mail_IMAP