downloads | documentation | faq | getting help | mailing lists | reporting bugs | sites | links | my 
search for in the  
view the version of this page
Last updated: Thu, 21 Aug 2003

XLIX. mailparse functions



This extension is EXPERIMENTAL. The behaviour of this extension -- including the names of its functions and anything else documented about this extension -- may change without notice in a future release of PHP. Use this extension at your own risk.

This extension has been moved from PHP as of PHP 4.2.0 and now mailparse lives in PECL.


These functions are only available if PHP was configured with --enable-mailparse.

Table of Contents
mailparse_determine_best_xfer_encoding --  Figures out the best way of encoding the content read from the file pointer fp, which must be seek-able
mailparse_msg_create -- Returns a handle that can be used to parse a message
mailparse_msg_extract_part_file -- Extracts/decodes a message section, decoding the transfer encoding
mailparse_msg_extract_part --  Extracts/decodes a message section. If callbackfunc is not specified, the contents will be sent to "stdout"
mailparse_msg_free -- Frees a handle allocated by mailparse_msg_crea
mailparse_msg_get_part_data -- Returns an associative array of info about the message
mailparse_msg_get_part -- Returns a handle on a given section in a mimemessage
mailparse_msg_get_structure -- Returns an array of mime section names in the supplied message
mailparse_msg_parse_file -- Parse file and return a resource representing the structure
mailparse_msg_parse -- Incrementally parse data into buffer
mailparse_rfc822_parse_addresses --  Parse addresses and returns a hash containing that data
mailparse_stream_encode --  Streams data from source file pointer, apply encoding and write to destfp
mailparse_uudecode_all --  Scans the data from fp and extract each embedded uuencoded file. Returns an array listing filename information

add a note add a note User Contributed Notes
mailparse functions
boris at gamate dot com
12-Sep-2003 08:11
Example how to handle mail content from a variable:


= [...] // Mail Content from pipe or whatever

$mail mailparse_msg_create();
$struct mailparse_msg_get_structure($mail); 

$struct as $st) { 
$section mailparse_msg_get_part($mail$st); 
$info mailparse_msg_get_part_data($section); 

toffe at dev dot null dot se
11-May-2003 12:50
To install mailparse on later versions of php, 4.3.1 in my case, you have to compile it with --enable-mbstring then do:

# pear install mailparse

This should download/compile/install the mailparse module...
To use it, either put in your php.ini or use dl(""); in each script you need the mailparse capabilities in.

/C A
wberrier at yahoo dot com
09-Jul-2002 02:45
[Authors note:
The tarball for 4.2.x can be found here:
and contains a script called try.php that demonstrates the usage of these functions.

I've pasted the contents of the file below:

 * This is a simple email viewer.
 * make sure that $filename points to a file containing an email message and
 * load this page in your browser.
 * You will be able to choose a part to view.
 * */

$filename "uumsg";

/* parse the message and return a mime message resource */
$mime mailparse_msg_parse_file($filename);
/* return an array of message parts - this contsists of the names of the parts
 * only */
$struct mailparse_msg_get_structure($mime);

/* print a choice of sections */
foreach($struct as $st) {
"<td><a href=\"$PHP_SELF?showpart=$st\">$st</a></td>\n";
/* get a handle on the message resource for a subsection */
$section mailparse_msg_get_part($mime$st);
/* get content-type, encoding and header information for that section */
$info mailparse_msg_get_part_data($section);
"<td>" $info["content-type"] . "</td>\n";
"<td>" $info["content-disposition"] . "</td>\n";
"<td>" $info["disposition-filename"] . "</td>\n";
"<td>" $info["charset"] . "</td>\n";

/* if we were called to display a part, do so now */
if ($showpart)  {
/* get a handle on the message resource for the desired part */
$sec mailparse_msg_get_part($mime$showpart);

"<table border=1><tr><th>Section $showpart</th></tr><tr><td>";
/* extract the part from the message file and dump it to the output buff
         * */
$contents ob_get_contents();
/* quote the message for safe display in a browser */
echo nl2br(htmlentities($contents)) . "</td></tr></table>";;

 Last updated: Thu, 21 Aug 2003
show source | credits | sitemap | mirror sites 
Copyright © 2001-2003 The PHP Group
All rights reserved.
This mirror generously provided by:
Last updated: Sat 01 Nov 2003 04:13:36 EST EST