cvs: php4 /pear/Mail RFC822.php

heyesr Mon Oct 29 08:48:13 2001 EDT Modified files: /php4/pear/Mail RFC822.php Log: Added description and usage example. Index: php4/pear/Mail/RFC822.php diff -u php4/pear/Mail/RFC822.php:1.12 php4/pear/Mail/RFC822.php:1.13 --- php4/pear/Mail/RFC822.php:1.12 Mon Oct 29 08:34:41 2001 +++ php4/pear/Mail/RFC822.php Mon Oct 29 08:48:13 2001 @@ -13,7 +13,7 @@ // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ -// | Authors: Richard Heyes <richard.heyes@heyes-computing.net> | +// | Authors: Richard Heyes <richard@phpguru.org> | // | Chuck Hagenbuch <chuck@horde.org> | // +----------------------------------------------------------------------+ @@ -22,9 +22,23 @@ /** * RFC 822 Email address list validation Utility * -* @author Richard Heyes <richard.heyes@heyes-computing.net> +* What is it? +* +* This class will take an address string, and parse it into it's consituent +* parts, be that either addresses, groups, or combinations. Nested groups +* are not supported. The structure it returns is pretty straight forward, +* and is similar to that provided by the imap_rfc822_parse_adrlist(). Use +* print_r() to view the structure. +* +* How do I use it? +* +* $address_string = 'My Group: "Richard Heyes" <richard@localhost> (A comment), ted@example.com (Ted Bloggs), Barney;'; +* $structure = Mail_RFC822::parseAddressList($address_string, 'example.com', TRUE) +* print_r($structure); +* +* @author Richard Heyes <richard@phpguru.org> * @author Chuck Hagenbuch <chuck@horde.org> -* @version $Revision: 1.12 $ +* @version $Revision: 1.13 $ * @package Mail */