Looking for a highly-capable but easy to use MIME email parser

cmayo · Jul 16, 2012

One of my projects hit a brick wall last week after my mail parsing script choked on an incoming mail from GoDaddy's "Workspace Webmail" client. I'd been using a mime parser from mlemos (mime_parser.php,v 1.80 2011/05/05 20:31:05) which returns the mail elements in a rather confusing (to me) all-in-one multi-level associative array, and it turns out my feeble coding skills aren't up to the task of extracting the data I need from the returned array.

So, I'm looking for another parser and hoping someone in the group can recommend one for me. I'd like to be able to toss it an incoming mail (like below), and be able to easily get a list of all the To: addresses, the Cc: addresses, Bcc's, Subject, From, Reply-to, mail body (text and/or html) and attachments, without having to write the code to walk through a complex array hunting for the things I need.

Ultimately, the script will be on the receiving end of a pipe but while testing, I need to have it parse a string containing the mail (the string is the mail returned from Net/POP3.php's $pop3->getMsg function like the string below).

Any thoughts?

Return-path: <user@example.com>
Envelope-to: ticket_6533_reference@services.example.com
Delivery-date: Mon, 16 Jul 2012 21:14:08 -0700
Received: from p3plsmtp05-03-02.prod.phx3.secureserver.net ([97.74.135.48]:60160 helo=p3plwbeout05-03.prod.phx3.secureserver.net)
by mail.example.com with esmtp (Exim 4.77)
(envelope-from <user@example.com>)
id 1SqzAl-0002rX-Ej
for ticket_6533_reference@services.example.com; Mon, 16 Jul 2012 21:14:08 -0700
Received: from localhost ([99.99.99.99])
by p3plwbeout05-03.prod.phx3.secureserver.net with bizsmtp
id bGE71j0012ZSNkp01GE7Fn; Mon, 16 Jul 2012 21:14:07 -0700
x-cmae-analysis: v=2.0 cv=ecG/js4H c=1 sm=1 a=gKIryCBQe32em1xqtQuthw==:17
a=Dz-sLDYWmIQA:10 a=7wwIHox7JvgA:10 a=1KO90zH8swkA:10 a=CHmiLw99jGwA:10
a=GlVLAuWUAAAA:8 a=TZb1taSUAAAA:8 a=XNXZDCW058qgDS8wB7gA:9 a=QEXdDO2ut3YA:10
a=_W_S_7VecoQA:10 a=SSmOFEACAAAA:8 a=RqOAJGx8AAAA:8 a=F4y1ph5t4H-GYW27F5AA:9
a=1Vq_FK4TplAA:10 a=2hejMlIOCYnmdwJD7IAA:9 a=HXjIzolwW10A:10
a=-ThlaWeBkFIVvBjM:18 a=gKIryCBQe32em1xqtQuthw==:117
Received: (qmail 26261 invoked by uid 99); 17 Jul 2012 04:14:07 -0000
Content-Type: multipart/mixed;
boundary="=_0fa7218a96e43ce2eb9b4e5c8f27ffcc"
X-Originating-IP: 99.99.99.99
User-Agent: Workspace Webmail 5.6.23
Message-Id: <20120716211406.7c696047686f2f9cbde4fbb08b8a7789.e0af1c7426.wbe@email05.secureserver.net>
From: <user@example.com>
To: ticket_6533_reference@services.example.com
Subject: Sample mail from GoDaddy's Workspace Webmail
Date: Mon, 16 Jul 2012 21:14:06 -0700
Mime-Version: 1.0
X-Spam-Status: No, score=1.0
X-Spam-Score: 10
X-Spam-Bar: +
X-Ham-Report: Spam detection software, running on the system "mail.example.com", has
identified this incoming email as possible spam. The original message
has been attached to this so you can view it (if it isn't spam) or label
similar future email. If you have any questions, see
the administrator of that system for details.

Content preview: This is a sample email sent from Godaddy's Workspace Webmail
client. This email contains two attachments. [...]

Content analysis details: (1.0 points, 5.0 required)

pts rule name description
---- ---------------------- --------------------------------------------------
-1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1%
[score: 0.0000]
0.0 HTML_MESSAGE BODY: HTML included in message
0.7 MIME_HTML_ONLY BODY: Message only has text/html MIME parts
2.2 SB_GIF_AND_NO_URIS SB_GIF_AND_NO_URIS
X-Spam-Flag: NO

--=_0fa7218a96e43ce2eb9b4e5c8f27ffcc
Content-Transfer-Encoding: quoted-printable
Content-Type: text/html; charset="utf-8"

<html><body><span style=3D"font-family:Verdana; color:#000000; font-size:10=
pt;"><div>This is a sample email sent from Godaddy's Workspace Webmail clie=
nt. This email contains two attachments.</div></span></body></html>
--=_0fa7218a96e43ce2eb9b4e5c8f27ffcc
Content-Transfer-Encoding: base64
Content-Type: image/gif;
name="facebook_24x24.gif";
Content-Disposition: attachment;
filename="facebook_24x24.gif";

R0lGODlhGAAYAPf0AP///35lTLWchLmhii4pIzcwKn9uXXphSTQtJn9mTayRdo11XbGXfaiLb51+
X6OFZr+pkzgwKZV3Wr2mkDsyKb6rmGBOPMu4pTs0Lb2ql/n2845yVr6qlzgxKYJoT4ZsUohtUq2S
dzYuJYZrUfj29MSwnHlfRc67qS8pJHJfTIhsUo9yVpV4Wpd4WzsyKDYvKINpT6ODY4BmTJ6HcIlw
V3phRzUuJ76nkTcxKpB4YcGxosKxoTUvKLKeijgxKjkyLKuPc/j187abf6aIa7Oagj82LT41LDgx
K3ZkUYNpULKhkD00LOzk2zIsJsm2pDMsJoZsUcu3pOzj20A3LcCqlaGBY4pxWXJXPKuPdKGCY6WI
bLCSdaSIbLukjpB/b4BtXDo0Lb6li/n39b2nkIJpT7ymkL6unzozLf38+76oksu6qci1o2dYS826
pquZhn5lTbuhh7CWfJF1WeLYz8avmHtiSI12Xsq3o3VbQoZqT7qii4x0XZmAaJR9Z6uLazcwKcu8
rU5DOc+8qjoyK3ZdRINqUOfe14BnTmNRPrumkb2mj3ddQjUvKamQdopoSX9vXZx9Xl9NO0Q6MKSH
aXtqWX5lS7Obg/n18z40KpyFbvz7+pt+Yvz6+EI4L3pfRUtBNzErJbOfi824pY50WsGumk1BNff1
8unf1sm1oWFOO66UeYFwXzMsJVhKPGZWR4dsUotrTJiEcMOumtnMwL2nktTIvPv6+eff1zQtJ3Bb
R6yQdcq2o5h5XKqKa/39/IJpUD80K66TeY9wUa+RdCgjHo5xVb+qlpyGb4FnTrqjjMy4pbWZff38
/LOfjamTfeni23NYPWFOPLilk35mTaeQesStleDWzJyCaD82K5V7Y2xXQ5l4WYZrT9jDr7GXfnxj
SXZkVdbHutXArMe0oYpxWNC/rradha2Rdse4qiwmIMq0ncCtmotvUzUtJrGWfa6XgTkzLIJoTkE4
L4luUzw1LgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C1hNUCBEYXRhWE1QPD94
cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1w
bWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS4w
LWMwNjAgNjEuMTM0Nzc3LCAyMDEwLzAyLzEyLTE3OjMyOjAwICAgICAgICAiPiA8cmRmOlJERiB4
bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8
cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5j
b20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0v
IiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNl
UmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1IFdpbmRvd3MiIHhtcE1N
Okluc3RhbmNlSUQ9InhtcC5paWQ6RjJGMjk1RTU4MkE2MTFFMDhCNzk5NzA4RURDQkQ3M0QiIHht
cE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6RjJGMjk1RTY4MkE2MTFFMDhCNzk5NzA4RURDQkQ3M0Qi
PiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDpGMkYyOTVFMzgy
QTYxMUUwOEI3OTk3MDhFRENCRDczRCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpGMkYyOTVF
NDgyQTYxMUUwOEI3OTk3MDhFRENCRDczRCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRG
PiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PgH//v38+/r5+Pf29fTz8vHw7+7t7Ovq
6ejn5uXk4+Lh4N/e3dzb2tnY19bV1NPS0dDPzs3My8rJyMfGxcTDwsHAv769vLu6ubi3trW0s7Kx
sK+urayrqqmop6alpKOioaCfnp2cm5qZmJeWlZSTkpGQj46NjIuKiYiHhoWEg4KBgH9+fXx7enl4
d3Z1dHNycXBvbm1sa2ppaGdmZWRjYmFgX15dXFtaWVhXVlVUU1JRUE9OTUxLSklIR0ZFRENCQUA/
Pj08Ozo5ODc2NTQzMjEwLy4tLCsqKSgnJiUkIyIhIB8eHRwbGhkYFxYVFBMSERAPDg0MCwoJCAcG
BQQDAgEAACH5BAEAAPQALAAAAAAYABgAAAj/AOnRw1DqyyMDCBMqTLjKlQ+BApfEIlWBQwaLHCpo
1Ggxw7pQrTAI/EMNlZ4BKFOqXElFnSR4Z4rQMSegps2bOAUQqQbuBQ55YRgIHUrUW5xzIZIGcweH
ko0CU4QomEq1KhZdauYYuhUOyDIk7Qpg29KgrNmzk2YBWAvg2ZBhKRAUAObngd27d6uo0rTWFwlr
WXrlkosphoPDiBFvs7SWWSIuWiDF0CaXgoQWLCRo1pwZVqO1JDY5EtaCF6LKr+atWLGh9YZicnoA
Wmtrh7R37KBYqPwhgYcRKkAI5zbKFFu2tTx52F2AQu9pCQ4hi+dBBo0gx9fqWJSEufME4MMn2Qjw
yw26tZzMKOnzrRBzFyMCyJ8vv9IVPmsvkYNW5w2ZSJXFRx99JsywlgY51CAfDN6pMCCBBgKAoIIB
wBCNXC7kccCGHHKIRyYH2kHIhjKkwkoBnVyzxwIstsgiDc4ceIwVLGaTgk+fiHNDGhD06CMEijix
lhgl3ADBGKJ4MQgGTxjTBi1lTCDllMmssRYasnQxQQndBIILPUcY0YwgykRxwZln3lGOFEyccsIu
J4zDBihgCMQIMTZ0EMGefOopwp8RdNBBOiiIJBAGPKBAwKKMNupoEz8IFBAAOw==
--=_0fa7218a96e43ce2eb9b4e5c8f27ffcc
Content-Transfer-Encoding: base64
Content-Type: image/png;
name="twitter_26x26.png";
Content-Disposition: attachment;
filename="twitter_26x26.png";

iVBORw0KGgoAAAANSUhEUgAAABoAAAAaCAYAAACpSkzOAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJ
bWFnZVJlYWR5ccllPAAAAyBpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdp
bj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6
eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEz
NDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJo
dHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlw
dGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEu
MC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVz
b3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1N
OkRvY3VtZW50SUQ9InhtcC5kaWQ6MzlENTFGOTA4MkZFMTFFMDlFNDdFRTAwOTNBOUM1QzkiIHht
cE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MzlENTFGOEY4MkZFMTFFMDlFNDdFRTAwOTNBOUM1Qzki
IHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNSBXaW5kb3dzIj4gPHhtcE1NOkRl
cml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5kaWQ6M0FBRTQwMDRGNDgyRTAxMUI0Q0ZD
RUE4NEY3RDYxREYiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6M0FBRTQwMDRGNDgyRTAxMUI0
Q0ZDRUE4NEY3RDYxREYiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1l
dGE+IDw/eHBhY2tldCBlbmQ9InIiPz6CNRG1AAAEkElEQVR42qx

http://WWW8bVRT+ZubO2OM1iR1ndes0

aSo10JYiELtEVdQneOEBCcErf4i+AhIIJHhAKohKlkAsKqUEQgioFJKShJImwc4eJ15m454zM44d
JUKkudJVxvH1953zne+cO8rE+69BUUXOiGeumB35YfkMwMODLQWea6O68fefVnW96NqNkkRV+pK9
Y692j76Q1KPpYyDZI7Pr28OlP4qvby3+8oEw4tnLmaFnkqqmo175B8e5RCSJrsJTydrm/cvyuadA
clnVDRz3IkxVMxBJ9haEfPBcpy41df+/OKrKEtGSIAeecVEnMk+Ehw47eNDyPBeaHoWiaGjsrkpC
nSM/uL6aL6PrNOA6VhuRoqhQhQHpFgbdvwi0vl3CvfG3cXd+CfmciaEn34DZMchYbVnL3xOH8NyA
xAuIgii3l28j1fcwpFn4YKAP6QWS+t74W3jvs99gRjQsrdaQKUwxURMHez8hDkFR05dhRoqmcia/
TxQxs/Axnr2YR+/YSzA7T7BEtDbvT+LTr2dwtpBkIst2USwWcam6jv7zrzCwlCKoIxhPpcYiEkqZ
t11DJJHF8NgTSCcEbk4t4MN3r2LuxlVUSncYZG7yGtJxnbemKogaGlIxge/HJ7C58KMfkKKw7H79
bb9GHmUUpOw5TlBYYH3bQjZtMBARJqbfwWOPPoKpu1voz0bhul7gOXBmOzUbm4tTiKbzcBoVWedI
U3o1zMRz7OZ2rBrM9CAujKShC5WCw4AEJsJvb00gFReciabtbTqTMAXm5uZw6/qbWL79CesWqiW8
wHGtbqHneHYE3f0jmJURpqREqgSmqCO66juPiJr57K2G5WJlswFDrCFbKYPGmsdEJBkXrr0HXLsO
3UyjpysS9E5obeXQ/pJKyroJnDk9JAM9LSdCD+MQhwh7hQrWuhz5uSP/OM51nsTkNx+xs2IyI9c7
fOhaMpuR0TFkRy5x4Nw6crwRh/AJPJq0dF1wx4dWp+/0aAonBnIolVe4+JpycEa24yHXEUEid8Yn
IDfLBBTV4GfVt5/LJGvzN7F+b7xpdfqusbOC3coG/lreZUAyBxuhZYeu6xm6CCPWJc1UbZs29Jcn
g5+mw5OgdOc6fpr4gW3tyCip66nwfZkoDGkEUk4NwClDR+54VCB38jySPWfZsS1zoSmhYOZgHmm6
ib5zLyOW+Rmri9NYr1hsBrJ1q2JEQBCm/H8imUKy9yE5fvKM0X4LeAG2FdQo6ODwSHrgAmJdBWTW
5uWdsibrtwPbqnP0hi6ngWFKR3ZyMxIBXZrkLuyrnz9DfaMJX0cvmHde03GaHmMpaSSRHOFgJVA2
jRHnKU/ROqFj9xuSJ79fln3XhNOStBXeGexEzYi1AVAA8P77/cIfBtLettVQWD4JyJO8eXPu1fMo
rytUK77TJAlxiPJGfb6zPDOc6h1DbWuJ9QwJj/4CpPjvCokctuS9Rhxidavx+fSv3+VGgWSie1Rm
o7H2D7K4N6W8RCKxt4lDKc98idXZr3I3vrh2ZbDbPCXkLAv75KiL7E+TYqFcnX36+ReLmVPPlf4V
YADmmLeOkjSEDQAAAABJRU5ErkJggg==
--=_0fa7218a96e43ce2eb9b4e5c8f27ffcc--

jpadie · Jul 18, 2012

here is a set of classes I use for scanning imap folders in a practice management system I use for my law practice. The data is taken and inserted into a wordpress backend but i have taken that bit out for you.

you should do something with the $message variable at line 743 otherwise it will get overwritten each iteration of the loop.

my code scans all messages in all folders every time it executes. i store a hash of each message in a database to make parsing take less time. the hashing code is in there but you will need to implement the database write and read functions if you want this functionality.

to connect to your imap server edit the $data variable at line 646.

if you want only to parse the INBOX then bypass the others by adding some identifying code in line 663 (perhaps

Code:

if( false === stripos($folder, 'inbox')) continue;

or something like that (untested))

if you want only to look at new emails then change line 680 to refer to

Code:

$mailIDs = $imap->fetch[red]New[/red]UIDs();

warning: i have not used this in a year now. I think it was working when I last used it, but no guarantees. use with considerable caution. it was designed to be used in a wordpress context and i've tried to make it anodyne but ...

note: this assumes that you use an imap mail server. you can easily adapt this to use pop3 but i have not done so. it may be as simple as changing the type key in line 653 to pop3.

Code:

<?php
error_reporting(E_ALL); ini_set('display_errors', true);
ob_end_flush();
ob_implicit_flush();
ini_set('memory_limit', "512M");


class mailFetcher {
	
	public function factory($data){
		extract ($data);
		$type = strtolower($data['type']);
		switch ($type){
			case 'imap':
				$iM = new imapConnector($host, $port, $username, $password, $useSSL);
			break;
			case 'pop':
				$iM = new popFetcher($host, $port, $username, $password, $useSSL);
			break;
		}
		return $iM;
	}
}

class imapConnector{


	public $server = '';
	public $connected = false;
	public function __construct($host, $port, $userName, $password, $useSSL){
		//instantiate variables for the arguments
		$this->host = $host;
		$this->port = $port;
		$this->userName = $userName;
		$this->password = $password;
		$this->useSSL = $useSSL;
		$this->current = 0;
		//instantiate other useful variables
		$this->conStatus = 'disconnected';
		$this->conn = null;
		
		//set defaults
		if (!$this->useSSL){
			if (empty($this->port)){
				$this->port = 143;
			}
		} else {
			if (empty($this->port)){
				$this->port = 993;
			}
			
		}
		if (!$this->useSSL){
			$server = "{" . $this->host .":". $this->port . "/imap/user=".$this->userName."}";
		} else {
			$server = "{" . $this->host .":". $this->port . "/user=".$this->userName."/imap/ssl/novalidate-cert}";
		}
		$this->server = $server;
	}
	public function connect($folder=null){
		if($this->connected):
			imap_close($this->conn);
		endif;
		$this->conn = imap_open($this->server . $folder, $this->userName, $this->password, OP_DEBUG );
		//imap_timeout(IMAP_READTIMEOUT, 5);
		$this->connected = true;
		return $this->conn;
	}
	public function getConnection(){
		return $this->conn;
	}
	public function fetchUIDs(){
		$ids = imap_sort($this->conn, SORTARRIVAL, 1 ,SE_UID);
		return $ids;
	}
	public function fetchNewUIDs(){
		$ids = imap_search($this->conn, 'UNSEEN', SE_UID);
		return $ids;
	}
	public function __destruct(){
		imap_close($this->conn);
	}
	public function fetchHeader($id){
		$info = imap_fetchheader($this->conn, $id, FT_UID);
		$info = imap_rfc822_parse_headers($info);
		return $info;
	}
	public function setFlag($id){
		imap_setflag_full($this->conn, $id, '\Flagged', ST_UID);
	}
	
	public function fetchCompleteMessage($id){
		$body = imap_body($this->conn, $id, FT_UID);
	}
	
	public function getStruct($id){
		$struct = imap_fetchstructure($this->conn, $id, FT_UID);
		return $struct;
	}
	
	public function getBody($id){
		$body = imap_body($this->conn, $id, FT_UID);
		return $body;
	}
	public function getBodyPart($id, $part){
		mail_log("fetching body part $part for mail id $id");
		$part = imap_fetchbody($this->conn, $id, $part, FT_UID);
		
		return $part;
	}
}


class imapHeader{
	
	public $fields = array(
			'to'=>array(),
			'cc'=>array(),
			'bcc'=>array(),
			'from'=>array(),
			'sender'=>array(),
			'date'=>'',
			'subject'=>'',
			'Size'=>'',
			'udate'=>'');
	public function __construct(){
	}
	public function getString($type){
		$return = array();
		foreach ($this->$type as $add){
			$mailbox = isset($add->mailbox) ? $add->mailbox :'';
			$host = isset($add->host) ? $add->host : '';
			if(!empty($add->personal)):
				$return[] = "{$add->personal} ({$mailbox}@{$host})";
			else:
				$return[] = "{$mailbox}@{$host}";
			endif;
		}
		return $return;
	}
	public function load($data){
		if(is_object($data)):
			$data = get_object_vars($data);
		endif;
		foreach ($this->fields as $field=>$val):
			if(!empty($data[$field])):
				$this->$field = $data[$field];
			else:
				$this->$field = $val;
			endif;
		endforeach;
		$this->subject = imap_mime_header_decode($this->subject);
		foreach(array('to','cc','from','bcc') as $type):
			if(!isset($this->$type)) continue;
			foreach($this->$type as & $address):
				$address->personal = isset($address->personal) ? imap_mime_header_decode($address->personal): '';
				if(is_array($address->personal)):
					$charset = ($address->personal[0]->charset == 'default' ? 'us-ascii' : $address->personal[0]->charset);
					$address->personal = iconv($charset, 'UTF-8//TRANSLIT', $address->personal[0]->text);
				endif;
			endforeach;
		endforeach;
	}
	
	public function getHash(){
		$array = array();
		foreach($this->fields as $field=>$val):
			$array[$field] = $this->$field;
		endforeach;
		return sha1(serialize($array));
	}
}


class imapMessage{
	
	public $to = array();
	public $from = array();
	public $cc = array();
	public $bcc = array();
	public $attachments = array();
	public $plain = '';
	public $html = '';
	public $hasAttachments = false;
	
	public function setHeader($header){
		$this->header = $header;
	}
	
	public function numAttachments(){
		return count($this->attachments);
	}
	public function setDate($date){
		$this->sentDate = strtotime($date);
	}
	
	public function setTo($array){
		$this->to = $array;
	}
	public function setFrom($array){
		$this->from = $array;
	}
	public function setBcc($array){
		$this->bcc = $array;
	}
	
	public function setCC($array){
		$this->cc = $array;
	}
	
	public function setHTML($data){
		if (!empty($this->html)){
			$this->html .=  "<br/>" . $data;
		} else {
			$this->html = $data;
		}
	}
	public function setPlain($data){
		if (!empty($this->plain)){
			$this->plain .= "\n\n" . $data;
		} else {
			$this->plain = $data;
		}
	}
	
	public function getText(){
		$text = '';
		foreach(array('to','cc','bcc','from') as $type):
			$text  .= implode(' ', $this->header->getString($type));
		endforeach;
		$text .= ' ' . $this->header->subject .' '. $this->plain;
		return $text;
	}
	public function addAttachment($attachment){
		$this->attachments[] = $attachment;
	}
	
	public function process(){
		$this->html = preg_replace('/<head>.*?<\/head>/ims', '', $this->html);
		$this->html = strip_tags($this->html, '<br><p><span><font><div><h1><h2><h3><img><table><tr><td><th><tbody><tfoot><thead>');
		//remove
		if (empty($this->plain)){
			$this->setPlain(strip_tags($this->html, '<a>'));
		}
		$this->html = trim($this->html);
		$this->plain = trim($this->plain);
	}
}


class imapStructureParser{
	
	public $struct;
	public $plain = '';
	public $html = '';
	public $attachments = array();
	public $imap;
	
	
	public function __construct($struct, $imap, $id){
		$this->struct = $struct;
		$this->imap = $imap;
		$this->id = $id;
	}
	
	public function decode(){
		if(!isset($this->struct->parts)):
			//there is no multipart
			mail_log('not a multipart message');
			$this->getPart($this->struct, 0);
		else:
			mail_log('multipart message');
			foreach($this->struct->parts as $partNo=>$p):
				mail_log('fetching body part '. $partNo);
				$this->getPart($p, $partNo + 1);
			endforeach;
		endif;
		$results = array(
					'plain'=>$this->plain,
					'html'=>$this->html,
					'attachments'=>$this->attachments);
		return $results;
	}
	
	private function getPart($struct, $part){
		
		/*
		 * get the raw part (canonicalised)
		 */ 
		if ($part == 0):  //deal with no multipart
			$data = $this->imap->getBody($this->id);
		else:
			$data = $this->imap->getBodyPart($this->id, $part); 
		endif;
		
		/*
		 * decode the part
		 */
		
		if(isset($struct->encoding)):
			switch($struct->encoding):
				case 3:
					$data = imap_base64($data);
					break;
				case 4:
					$data = imap_qprint($data);
					break;
			endswitch;
		endif;
		/*
		 * get the parameters
		 */
		$params = array();
		if (isset($struct->parameters)):
			foreach($struct->parameters as $x):
				$params[ strtolower( $x->attribute ) ] = $x->value;
			endforeach;
		endif;
		if (isset($struct->dparameters)):
			foreach($struct->parameters as $x):
				$params[ strtolower( $x->attribute ) ] = $x->value;
			endforeach;
		endif;
		
		/*
		 * check if an attachment 
		 */ 
		if (isset($params['filename']) || isset($params['name'])):
        	// filename may be given as 'Filename' or 'Name' or both
        	$filename = !empty($params['filename']) ? $params['filename'] : $params['name'];
        	// filename may be encoded, so see imap_mime_header_decode()
			$bits = imap_mime_header_decode($filename);
			$a = new imapAttachment();
			$a->payload($data);
			$a->setName($bits[0]->text);
			$this->attachments[] = $a;
        elseif($struct->type == 0 && $data):
			/*
			 * Messages may be split in different parts because of inline attachments,
			 * so append parts together with blank row.
			 */
			
			/*
			 * convert to UTF-8
			 */ 
	        if(isset($params['charset'])):
				$charset = $params['charset'];  // assume all parts are same charset
	        	$_data = iconv($charset, 'UTF-8//TRANSLIT', $data);
				$data = ($_data) ? $_data : $data;
			endif;
			/*
			 * add to the properties
			 */
			if (strtolower($struct->subtype) =='plain'):
            	$this->plain .= trim($data) ."\n";
        	else:
            	$this->html .= $data ."<br/>";
        	endif;
		
		elseif($struct->type==2 && $data):
			/*
			 * convert to UTF-8
			 */ 
	        if(isset($params['charset'])):
				$charset = $params['charset'];  // assume all parts are same charset
	        	$_data = iconv($charset, 'UTF-8//TRANSLIT', $data);
				$data = ($_data) ? $_data : $data;
			endif;
			$this->plain .= trim($data) . "\n";
		endif;
		
		if (isset($struct->parts)):
        	foreach ($struct->parts as $partno0=>$p2)
            	$this->getPart($p2,$part.'.'.($partno0+1));  // 1.2, 1.2.1, etc.
    	endif;
		
    }
}
class imapAttachment{
	
	public $payload;
	public $filename = '';
	public $fn = '';
	public $tempFileName = '';
	
	public function setPayload($data){
		$this->payload($data);
		
	}
	public function isZip(){
		$mime = $this->getType();
		if(strtolower($mime) == 'application/zip') return true;
		$bits = pathinfo($this->filename);
		if($bits['extension'] == 'zip') return true;
		return false;
	}	
	public function payload($data){
		$this->payload = $data;
		$this->makeTemp();
	}
	private function makeTemp(){
		$fn = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid();
		file_put_contents($fn, $this->payload);
		$this->tempFileName = $fn;
	}
	public function setFileName($name){
		$this->filename = $name;
	}
	public function setName($name){
		$this->setFileName($name);
	}
	public function getHash(){
		return sha1($this->payload);
	}
	public function getType(){
		if(!isset($this->mime)):
			$this->mime = getMime($this->fn);
		endif;
		return $this->mime;
	}
	public function __destruct(){
		@unlink($this->tempFileName);
	}
	public function getExtension(){
		$bits = pathinfo($this->filename);
		return $bits['extension'];	
	}
	public function setAttachmentID($id){
		$this->attachmentID = $id;
	}
}
define('ISWP', false); //set to true if you are using this in a wordpress context
class zipHandler{
	
	/**
	 * holds a numeric array of fully qualified path names to the extracted files
	 * @var
	 */
	public $files = array();
	
	/**
	 * holds the file name of the zip file
	 * @var
	 */
	private $zipFile = '';
	
	/**
	 * 
	 * @param string $file - a filename (can be a pointer to a temp file)
	 * @return
	 */
	
	public function __construct($file){
		$this->dirs = array();
		$this->files = array();
		$this->zipFile = $file;
	}
	
	public function unzip(){
		if (!file_exists($this->zipFile)){
			return new AACERROR("ZIP Handler Error", "The file $this->zipFile does not exist on " . __LINE__ . " File was " . $this->zipFile);
		}
		if (!is_readable($this->zipFile)){
			return new AACERROR("ZIP Handler Error", "The file $this->zipFile is not readable. This is usually a permissions issue");
		}
		if (!class_exists("ZipArchive")){
			if (ISWP){
				require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
				$result = $this->pclZipWay();
				if ($result === true){
					return true;
				} else {
					return $result;
				}
			} else {
				$result = $this->hardWay();
				if ($result === true){
					return true;
				} else {
					return $result;
				}
			}
		} else {
			
			$result = $this->phpWay();
			if ($result instanceof AACERROR){
				return $result;	
			} else {
				return true;
			}
		}
	}
	
	private function pclZipWay(){
		/**
		 *@var $errors (array) used by the pclzip library
		 */
		$errors = array(
		'filtered'=> ' the file/folder was not extracted (filtered by the user).',
		'already_a_directory'=> 'the file was not extracted because a folder with same name already exists.',
		'newer_exist'=>'the file was not extracted because a file with same name already exists and is write protected.',
		'write_protected'=>'the file was not extracted because a more recent file exists.',
		'path_creation_fail'=>'the file was not extracted because an error occurs while creating its path.',
		'write_error'=>'the file was not extracted because a write error occur',
		'read_error'=>'the file was not extracted because a read error occur',
		'invalid_header'=> 'the file was not extracted because of a bad header',
		'skipped'=>'the file was not extracted or added because a user call-back function request to skip it.',
		'filename_too_long'=>'the file was not added in the archive because the filename is too long (maximum 255 caracters).');
		
		$dir = $this->getTempDir();
		$zip = new PclZip($this->zipFile);
		$list = $zip->extract(PCLZIP_OPT_PATH, $dir);
		if ($list == false){
			return new adieERROR('Zip Handler Error', 'Error extracting files from the zip archive. ' . $zip->errorInfo(true));
		} else {
			$message = array();
			foreach ($list as $f){
				if ($f['status'] !== 'ok'){
					$message[] = "The file $f[stored_filename] was not extracted.  The error code was {$errors[$f[status]]}";
				}
			}
			$this->getFileNames($dir);
			if (count ($message) > 0){
				return new AACERROR('Non-fatal Zip Handler error', implode ('<br/>', $message));
			//we could use the PCLZIP functions to grab the file names, but then the internal properties are not set for the clean up later
			} else {
				return true;
			}
		}
		
	}
	
	/**
	 * default method for unzipping via the command line
	 * 
	 * note that no santisation is possible
	 * @return 
	 */
	private function hardWay(){
		$dir = $this->getTempDir();
		$cmd = 'unzip -d ' . $dir .' '. $this->zipFile ;
		exec ($cmd);
		$this->getFileNames($dir);
		return true;
	}
	
	/**
	 * method to grab and create a uniquely named directory
	 * @return directory name on success, AACERROR on failure
	 */
	private function getTempDir(){
		// use a semi-random value to find an empty directory name
		if (!isset($this->tempDir)):
		do {
			$dir  = sys_get_temp_dir()  . DIRECTORY_SEPARATOR . uniqid('dir_');
		} while (file_exists($dir));
		//create the directory with 0777 privileges
		//may be better to secure this
		$result = mkdir($dir, 0777, true);
		if (!$result){
			return new AACERROR('Zip Hander Error', 'Failed to create a temporary directly to unzip the files into');
		}
		$this->tempDir = $dir;
		endif;
		return $this->tempDir;
	}
	
	/**
	 * method to unzip the zip archive
	 * 
	 * @return true on success, AACERROR on failure
	 */
	private function phpWay(){
		//get temporary directory
		$dir = $this->getTempDir();
		$zip = new ZipArchive;
		if ( true === ($zip->open($this->zipFile))){
			$zip->extractTo($dir);
			$zip->close();
			$this->files = array(); //flush the filenames array
			$this->getFileNames($dir);
		} else {
			return new AACERROR('Zip Handler Error', 'Failed to open the zip file');
		}
	}
	
	/**
	 * method to open and recursively read the directory to list the created zip files
	 * 
	 * @param object $dir
	 * @return 
	 */
	private function getFileNames($dir){
		$this->dirs[] = $dir;
		$dh = opendir($dir) or die('cannot open directory ' . $dir);
		while (false  !== ($file = readdir($dh))){
			if ($file == '.' || $file == '..') continue;
			if (is_dir($dir.DIRECTORY_SEPARATOR .$file)){
				$this->getFileNames($dir.DIRECTORY_SEPARATOR .$file);
			} else {
				$this->files[] = $dir.DIRECTORY_SEPARATOR .$file;
			}
		}
	}
	
	
	/**
	 * method for deleting the files and directories that were created by this class
	 * 
	 * fails silently as no big deal if the temp files are not cleanly deleted
	 * this method may be called explicitly and will be called by the destructor.
	 * @return 
	 */
	public function deleteFiles(){
		exec('rm -rf ' . escapeshellarg(realpath($this->getTempDir())), $output, $return);
	}
	
	/**
	 * destructor method
	 * @return 
	 */
	public function __destruct(){
		$this->deleteFiles();
	}
}

class AACERROR{
	public function __construct($type, $message, $fatal=false){
		$this->type = $type;
		$this->message = $message;
		$this->fatal = $fatal;
	}
	
	public function displayErrorInfo(){
		echo <<<HTML
<h1 style="color:red">$type</h1>
<p style="color:black">$message</p>
HTML;
		if ($this->fatal) exit;
	}
}


function mail_log($text){
	$file = 'mailFetcherLog.txt';
	file_put_contents($file, date('Y-m-d H:i:s')."\t" . $text . "\n", FILE_APPEND);
	echo '<pre>' . ($text) . '</pre>';
}

$data = array(
	'host'=>'', 
	'port'=>null, 
	'type'=>'imap', 
	'username'=>'', 
	'password'=>'', 
	'useSSL'=>false);

echo '<pre>';
$imap = mailFetcher::factory($data);
$imap->connect();
$folders = imap_list($imap->getConnection(), $imap->server, '*');
$c=0;
/*
 * iterate through each folder
 */
foreach($folders as $i=>$folder):
	$folder = preg_replace('/\{.*?\}/','',$folder);
	$folder = imap_utf7_encode($folder);
	
	mail_log("<hr/><hr/><hr/>start processing $folder<br/>");
	$r = $imap->connect($folder);
	if (!$r):
		mail_log(print_r(imap_errors(),true));
		exit;
	endif;
	set_time_limit(15);
	/*
	 * get the ids of the mail messages in this folder
	 */
	$mailIDs = $imap->fetchUIDs();
	if (count($mailIDs) === 0){
		mail_log('Folder is empty<br/>');
	} else {
		mail_log ("Processing " . count($mailIDs));
	}
	/*
	 * iterate over each mail Message
	 */ 
	foreach($mailIDs as $id):
			mail_log('<hr/><hr/>processing mail ID ' . $id);
			set_time_limit(10);
			//return an associative array of header information
			$header = $imap->fetchHeader($id);
			//mail_log('Raw Header: ' . print_r($header, true));
			$h = new imapheader();
			$h->load($header);
			//mail_log('Header: ' . print_r($h, true));
			
			$message = new imapMessage();
			$message->setHeader($h);
				
			//getStructure
			$struct = $imap->getStruct($id);
			$iS = new imapStructureParser($struct, &$imap, $id);
			$messageBody = $iS->decode();
			
			//free memory
			$iS = null;
			
			//assign to the message object
			$message->setPlain($messageBody['plain']);
			$message->setHTML($messageBody['html']);
			foreach ($messageBody['attachments'] as $attachment):
				$message->addAttachment($attachment);					
				if($attachment->isZip()):
					mail_log('attachment is a zip file. Breaking it apart');
					//break apart zip
					$zH = new zipHandler($attachment->tempFileName);
					$result = $zh->unzip();
					if($result === true):						
						foreach($zh->files as $zipFile):
							$a = new imapAttachment();
							$a->setPayload(file_get_contents($zipFile));
							$a->setFileName(basename($zipFile));
							$message->addAttachment($a);
						endforeach;
					else:
						mail_log('Problem extracting zip file');
						mail_log('Error was ' . $result->message);
					endif;
				endif;
			endforeach;
			
			
			//free memory
			$messageBody = null;
			
			//clean the message up
			$message->process();
		
			
			if ($result == false):
				mail_log('Unable to process email ' . $result);
			else:
				mail_log('Mail processed');
				
				//do something with $message here
			endif;
		$c++;
		$header = $message = $struct = $messageBody = $poster = null;
	
	endforeach;
endforeach;
?>

cmayo · Jul 18, 2012

Wow, that's very kind of you, thanks very much! I'll try to get this code plugged in over the weekend and see how it goes.

Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

Looking for a highly-capable but easy to use MIME email parser

cmayo

MIS

jpadie

Technical User

cmayo

MIS

Similar threads

Part and Inventory Search

Sponsor