319 lines
9.6 KiB
PHP
319 lines
9.6 KiB
PHP
|
<?php
|
||
|
|
/*********************************************************************************
|
||
|
|
** The contents of this file are subject to the vtiger CRM Public License Version 1.0
|
||
|
|
* ("License"); You may not use this file except in compliance with the License
|
||
|
|
* The Original Code is: vtiger CRM Open Source
|
||
|
|
* The Initial Developer of the Original Code is vtiger.
|
||
|
|
* Portions created by vtiger are Copyright (C) vtiger.
|
||
|
|
* All Rights Reserved.
|
||
|
|
*
|
||
|
|
********************************************************************************/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This class provides structured way of accessing details of email.
|
||
|
|
*/
|
||
|
|
class Vtiger_MailRecord {
|
||
|
|
// FROM address(es) list
|
||
|
|
var $_from;
|
||
|
|
// TO address(es) list
|
||
|
|
var $_to;
|
||
|
|
//var $_replyto;
|
||
|
|
|
||
|
|
// CC address(es) list
|
||
|
|
var $_cc;
|
||
|
|
// BCC address(es) list
|
||
|
|
var $_bcc;
|
||
|
|
// DATE
|
||
|
|
var $_date;
|
||
|
|
// SUBJECT
|
||
|
|
var $_subject;
|
||
|
|
// BODY (either HTML / PLAIN message)
|
||
|
|
var $_body;
|
||
|
|
// CHARSET of the body content
|
||
|
|
var $_charset;
|
||
|
|
// If HTML message was set as body content
|
||
|
|
var $_isbodyhtml;
|
||
|
|
// PLAIN message of the original email
|
||
|
|
var $_plainmessage = false;
|
||
|
|
// HTML message of the original email
|
||
|
|
var $_htmlmessage = false;
|
||
|
|
// ATTACHMENTS list of the email
|
||
|
|
var $_attachments = false;
|
||
|
|
// UNIQUEID associated with the email
|
||
|
|
var $_uniqueid = false;
|
||
|
|
|
||
|
|
// Flag to avoid re-parsing the email body.
|
||
|
|
var $_bodyparsed = false;
|
||
|
|
|
||
|
|
/** DEBUG Functionality. */
|
||
|
|
var $debug = false;
|
||
|
|
function log($message=false) {
|
||
|
|
if(!$message) $message = $this->__toString();
|
||
|
|
|
||
|
|
global $log;
|
||
|
|
if($log && $this->debug) { $log->debug($message); }
|
||
|
|
else if($this->debug) {
|
||
|
|
echo var_export($message, true) . "\n";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* String representation of the object.
|
||
|
|
*/
|
||
|
|
function __toString() {
|
||
|
|
$tostring = '';
|
||
|
|
$tostring .= 'FROM: ['. implode(',', $this->_from) . ']';
|
||
|
|
$tostring .= ',TO: [' . implode(',', $this->_to) . ']';
|
||
|
|
if(!empty($this->_cc)) $tostring .= ',CC: [' . implode(',', $this->_cc) . ']';
|
||
|
|
if(!empty($this->_bcc))$tostring .= ',BCC: [' . implode(',', $this->_bcc) . ']';
|
||
|
|
$tostring .= ',DATE: ['. $this->_date . ']';
|
||
|
|
$tostring .= ',SUBJECT: ['. $this->_subject . ']';
|
||
|
|
return $tostring;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor.
|
||
|
|
*/
|
||
|
|
function __construct($imap, $messageid, $fetchbody=true) {
|
||
|
|
$this->__parseHeader($imap, $messageid);
|
||
|
|
if($fetchbody) $this->__parseBody($imap, $messageid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get body content as Text.
|
||
|
|
*/
|
||
|
|
function getBodyText($striptags=true) {
|
||
|
|
$bodytext = $this->_body;
|
||
|
|
|
||
|
|
if($this->_plainmessage) {
|
||
|
|
$bodytext = $this->_plainmessage;
|
||
|
|
} else if($this->_isbodyhtml) {
|
||
|
|
// TODO This conversion can added multiple lines if
|
||
|
|
// content is displayed directly on HTML page
|
||
|
|
$bodytext = preg_replace("/<br>/", "\n", $bodytext);
|
||
|
|
$bodytext = strip_tags($bodytext);
|
||
|
|
}
|
||
|
|
return $bodytext;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get body content as HTML.
|
||
|
|
*/
|
||
|
|
function getBodyHTML() {
|
||
|
|
$bodyhtml = $this->_body;
|
||
|
|
if(!$this->_isbodyhtml) {
|
||
|
|
$bodyhtml = preg_replace( Array("/\r\n/", "/\n/"), Array('<br>','<br>'), $bodyhtml );
|
||
|
|
}
|
||
|
|
return $bodyhtml;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Fetch the mail body from server.
|
||
|
|
*/
|
||
|
|
function fetchBody($imap, $messageid) {
|
||
|
|
if(!$this->_bodyparsed) $this->__parseBody($imap, $messageid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Parse the email id from the mail header text.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
function __getEmailIdList($inarray) {
|
||
|
|
if(empty($inarray)) return Array();
|
||
|
|
$emails = Array();
|
||
|
|
foreach($inarray as $emailinfo) {
|
||
|
|
$emails[] = $emailinfo->mailbox . '@' . $emailinfo->host;
|
||
|
|
}
|
||
|
|
return $emails;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to convert the encoding of input to target charset.
|
||
|
|
*/
|
||
|
|
static function __convert_encoding($input, $to, $from = false) {
|
||
|
|
if(function_exists('mb_convert_encoding')) {
|
||
|
|
if(!$from) $from = mb_detect_encoding($input);
|
||
|
|
|
||
|
|
if(strtolower(trim($to)) == strtolower(trim($from))) {
|
||
|
|
return $input;
|
||
|
|
} else {
|
||
|
|
return mb_convert_encoding($input, $to, $from);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $input;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* MIME decode function to parse IMAP header or mail information
|
||
|
|
*/
|
||
|
|
static function __mime_decode($input, &$words=null, $targetEncoding='UTF-8') {
|
||
|
|
if(is_null($words)) $words = array();
|
||
|
|
$returnvalue = $input;
|
||
|
|
|
||
|
|
if(preg_match_all('/=\?([^\?]+)\?([^\?]+)\?([^\?]+)\?=/', $input, $matches)) {
|
||
|
|
$totalmatches = count($matches[0]);
|
||
|
|
|
||
|
|
for($index = 0; $index < $totalmatches; ++$index) {
|
||
|
|
$charset = $matches[1][$index];
|
||
|
|
$encoding= strtoupper($matches[2][$index]); // B - base64 or Q - quoted printable
|
||
|
|
$data = $matches[3][$index];
|
||
|
|
|
||
|
|
if($encoding == 'B') {
|
||
|
|
$decodevalue = base64_decode($data);
|
||
|
|
} else if($encoding == 'Q') {
|
||
|
|
$decodevalue = quoted_printable_decode($data);
|
||
|
|
}
|
||
|
|
$value = self::__convert_encoding($decodevalue, $targetEncoding, $charset);
|
||
|
|
array_push($words, $value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if(!empty($words)) {
|
||
|
|
$returnvalue = implode('', $words);
|
||
|
|
}
|
||
|
|
return $returnvalue;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* MIME encode function to prepare input to target charset supported by normal IMAP clients.
|
||
|
|
*/
|
||
|
|
static function __mime_encode($input, $encoding='Q', $charset='iso-8859-1') {
|
||
|
|
$returnvalue = $input;
|
||
|
|
$encoded = false;
|
||
|
|
|
||
|
|
if(strtoupper($encoding) == 'B' ) {
|
||
|
|
$returnvalue = self::__convert_encoding($input, $charset);
|
||
|
|
$returnvalue = base64_encode($returnvalue);
|
||
|
|
$encoded = true;
|
||
|
|
} else {
|
||
|
|
$returnvalue = self::__convert_encoding($input, $charset);
|
||
|
|
if(function_exists('imap_qprint')) {
|
||
|
|
$returnvalue = imap_qprint($returnvalue);
|
||
|
|
$encoded = true;
|
||
|
|
} else {
|
||
|
|
// TODO: Handle case when imap_qprint is not available.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if($encoded) {
|
||
|
|
$returnvalue = "=?$charset?$encoding?$returnvalue?=";
|
||
|
|
}
|
||
|
|
return $returnvalue;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Parse header of the email.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
function __parseHeader($imap, $messageid) {
|
||
|
|
$this->_from = Array();
|
||
|
|
$this->_to = Array();
|
||
|
|
|
||
|
|
$mailheader = imap_headerinfo($imap, $messageid);
|
||
|
|
|
||
|
|
$this->_uniqueid = $mailheader->message_id;
|
||
|
|
|
||
|
|
$this->_from = $this->__getEmailIdList($mailheader->from);
|
||
|
|
$this->_to = $this->__getEmailIdList($mailheader->to);
|
||
|
|
$this->_cc = $this->__getEmailIdList($mailheader->cc);
|
||
|
|
$this->_bcc = $this->__getEmailIdList($mailheader->bcc);
|
||
|
|
|
||
|
|
$this->_date = $mailheader->udate;
|
||
|
|
|
||
|
|
$this->_subject = self::__mime_decode($mailheader->subject);
|
||
|
|
if(!$this->_subject) $this->_subject = 'Untitled';
|
||
|
|
}
|
||
|
|
// Modified: http://in2.php.net/manual/en/function.imap-fetchstructure.php#85685
|
||
|
|
function __parseBody($imap, $messageid) {
|
||
|
|
$structure = imap_fetchstructure($imap, $messageid);
|
||
|
|
|
||
|
|
$this->_plainmessage = '';
|
||
|
|
$this->_htmlmessage = '';
|
||
|
|
$this->_body = '';
|
||
|
|
$this->_isbodyhtml = false;
|
||
|
|
|
||
|
|
if($structure->parts) { /* multipart */
|
||
|
|
foreach($structure->parts as $partno0=>$p) {
|
||
|
|
$this->__getpart($imap, $messageid, $p, $partno0+1);
|
||
|
|
}
|
||
|
|
} else { /* not multipart */
|
||
|
|
$this->__getpart($imap, $messageid, $structure, 0);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Set the body (either plain or html content)
|
||
|
|
if($this->_htmlmessage != '') {
|
||
|
|
$this->_body = $this->_htmlmessage;
|
||
|
|
$this->_isbodyhtml = true;
|
||
|
|
} else {
|
||
|
|
$this->_body = $this->_plainmessage;
|
||
|
|
}
|
||
|
|
|
||
|
|
if($this->_attachments) {
|
||
|
|
$this->log("Attachments: ");
|
||
|
|
$this->log(array_keys($this->_attachments));
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->_bodyparsed = true;
|
||
|
|
}
|
||
|
|
// Modified: http://in2.php.net/manual/en/function.imap-fetchstructure.php#85685
|
||
|
|
function __getpart($imap, $messageid, $p, $partno) {
|
||
|
|
// $partno = '1', '2', '2.1', '2.1.3', etc if multipart, 0 if not multipart
|
||
|
|
|
||
|
|
// DECODE DATA
|
||
|
|
$data = ($partno)?
|
||
|
|
imap_fetchbody($imap,$messageid,$partno): // multipart
|
||
|
|
imap_body($imap,$messageid); // not multipart
|
||
|
|
|
||
|
|
// Any part may be encoded, even plain text messages, so check everything.
|
||
|
|
if ($p->encoding==4) $data = quoted_printable_decode($data);
|
||
|
|
elseif ($p->encoding==3) $data = base64_decode($data);
|
||
|
|
// no need to decode 7-bit, 8-bit, or binary
|
||
|
|
|
||
|
|
// PARAMETERS
|
||
|
|
// get all parameters, like charset, filenames of attachments, etc.
|
||
|
|
$params = array();
|
||
|
|
if ($p->parameters) {
|
||
|
|
foreach ($p->parameters as $x) $params[ strtolower( $x->attribute ) ] = $x->value;
|
||
|
|
}
|
||
|
|
if ($p->dparameters) {
|
||
|
|
foreach ($p->dparameters as $x) $params[ strtolower( $x->attribute ) ] = $x->value;
|
||
|
|
}
|
||
|
|
|
||
|
|
// ATTACHMENT
|
||
|
|
// Any part with a filename is an attachment,
|
||
|
|
// so an attached text file (type 0) is not mistaken as the message.
|
||
|
|
if ($params['filename'] || $params['name']) {
|
||
|
|
// filename may be given as 'Filename' or 'Name' or both
|
||
|
|
$filename = ($params['filename'])? $params['filename'] : $params['name'];
|
||
|
|
// filename may be encoded, so see imap_mime_header_decode()
|
||
|
|
if(!$this->_attachments) $this->_attachments = Array();
|
||
|
|
$this->_attachments[$filename] = $data; // TODO: this is a problem if two files have same name
|
||
|
|
}
|
||
|
|
|
||
|
|
// TEXT
|
||
|
|
elseif ($p->type==0 && $data) {
|
||
|
|
$this->_charset = $params['charset']; // assume all parts are same charset
|
||
|
|
$data = self::__convert_encoding($data, 'UTF-8', $this->_charset);
|
||
|
|
|
||
|
|
// Messages may be split in different parts because of inline attachments,
|
||
|
|
// so append parts together with blank row.
|
||
|
|
if (strtolower($p->subtype)=='plain') $this->_plainmessage .= trim($data) ."\n\n";
|
||
|
|
else $this->_htmlmessage .= $data ."<br><br>";
|
||
|
|
}
|
||
|
|
|
||
|
|
// EMBEDDED MESSAGE
|
||
|
|
// Many bounce notifications embed the original message as type 2,
|
||
|
|
// but AOL uses type 1 (multipart), which is not handled here.
|
||
|
|
// There are no PHP functions to parse embedded messages,
|
||
|
|
// so this just appends the raw source to the main message.
|
||
|
|
elseif ($p->type==2 && $data) {
|
||
|
|
$this->_plainmessage .= trim($data) ."\n\n";
|
||
|
|
}
|
||
|
|
|
||
|
|
// SUBPART RECURSION
|
||
|
|
if ($p->parts) {
|
||
|
|
foreach ($p->parts as $partno0=>$p2)
|
||
|
|
$this->__getpart($imap,$messageid,$p2,$partno.'.'.($partno0+1)); // 1.2, 1.2.1, etc.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
?>
|