5 * code that used to be in Pman (sendTemplate / emailTemplate)
7 * template is in template directory subfolder 'mail'
9 * eg. use 'welcome' as template -> this will use templates/mail/welcome.txt
10 * if you also have templates/mail/welcome.body.html - then that will be used as
17 * require_once 'Pman/Core/Mailer.php';
18 * $x= new Pman_Core_Mailer(array(
20 // if bcc is property of this, then it will be used (BAD DESIGN)
22 'template' => 'your_template',
23 // must be in templates/mail direcotry..
24 // header and plaintext verison in mail/your_template.txt
25 // if you want a html body - use mail/your_template.body.html
27 // 'bcc' => 'xyz@abc.com,abc@xyz.com', // string...
28 // 'contents' => array(), // << keys must be trusted
29 // if bcc is property of contents, then it will be used (BAD DESIGN)
31 // 'html_locale => 'en', // always use the 'english translated verison'
32 // 'cache_images => true, // -- defaults to caching images - set to false to disable.
33 // 'replaceImages => false, // should images be replaced.
34 // 'urlmap => array( // map urls from template to a different location.
35 // 'https://www.mysite.com/' => 'http://localhost/',
37 // 'locale' => 'en', // .... or zh_hk....
39 // 'attachments' => array(
41 // 'file' => '/path/to/file', // file location
42 // name => 'myfile.pdf', // (optional) - uses basename of file
46 // 'mail_method' => 'SMTP', // or SMTPMX
50 * recipents is gathered from the resulting template
58 * $x->toData(); // returns data needed for notify?? - notify should really
59 * // just use this to pass around later..
65 class Pman_Core_Mailer {
67 var $page = false; /* usually a html_flexyframework_page */
68 var $contents = false; /* object or array */
69 var $template = false; /* string */
70 var $replaceImages = false; /* boolean */
72 var $templateDir = false;
73 var $locale = false; // eg. 'en' or 'zh_HK'
74 var $urlmap = array();
79 var $html_locale = false; // eg. 'en' or 'zh_HK'
80 var $images = array(); // generated list of cid images for sending
81 var $attachments = false;
82 var $css_inline = false; // put the css into the html
83 var $css_embed = false; // put the css tags into the body.
85 var $mail_method = 'SMTP';
87 var $cache_images = true;
91 var $body_cls = false;
93 function __construct($args) {
94 foreach($args as $k=>$v) {
98 // allow core mailer debug setting.
99 $ff = HTML_FlexyFramework::get();
101 if (!empty($ff->Core_Mailer['debug'])) {
102 $this->debug = $ff->Core_Mailer['debug'];
104 //$this->log("URL MAP");
105 //$this->log($this->urlmap);
110 * ---------------- Global Tools ---------------
115 $templateFile = $this->template;
116 $args = (array)$this->contents;
117 $content = clone($this->page);
119 foreach($args as $k=>$v) {
123 $content->msgid = empty($content->msgid ) ? md5(time() . rand()) : $content->msgid ;
125 $ff = HTML_FlexyFramework::get();
126 $http_host = isset($_SERVER["HTTP_HOST"]) ? $_SERVER["HTTP_HOST"] : 'pman.HTTP_HOST.not.set';
127 if (isset($ff->Pman['HTTP_HOST']) && $http_host != 'localhost') {
128 $http_host = $ff->Pman['HTTP_HOST'];
131 $content->HTTP_HOST = $http_host;
133 // this should be done by having multiple template sources...!!!
135 require_once 'HTML/Template/Flexy.php';
138 // 'forceCompile' => true,
139 'site_prefix' => false,
140 'multiSource' => true,
143 $fopts = HTML_FlexyFramework::get()->HTML_Template_Flexy;
145 //print_R($fopts);exit;
146 if (!empty($fopts['DB_DataObject_translator'])) {
147 $tmp_opts['DB_DataObject_translator'] = $fopts['DB_DataObject_translator'];
149 if (!empty($fopts['locale'])) {
150 $tmp_opts['locale'] = $fopts['locale'];
152 if (!empty($fopts['templateDir'])) {
153 $tmp_opts['templateDir'] = $fopts['templateDir'];
156 if (!empty($this->templateDir)) {
157 $tmp_opts['templateDir'] = $this->templateDir;
160 // local opt's overwrite
161 if (!empty($this->locale)) {
162 $tmp_opts['locale'] = $this->locale;
166 $html_tmp_opts = $tmp_opts;
167 $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
168 if (is_string($htmltemplate->resolvePath('mail/'.$templateFile.'.body.html')) ) {
169 // then we have a multi-part email...
170 if (!empty($this->html_locale)) {
171 $html_tmp_opts['locale'] = $this->html_locale;
173 $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
175 $htmltemplate->compile('mail/'. $templateFile.'.body.html');
176 $htmlbody = $htmltemplate->bufferedOutputObject($content);
178 $this->htmlbody = $htmlbody;
180 // for the html body, we may want to convert the attachments to images.
181 // var_dump($htmlbody);exit;
183 if(!empty($content->body_cls) && strlen($content->body_cls)){
184 $htmlbody = $this->htmlbodySetClass($htmlbody, $content->body_cls);
187 if ($this->replaceImages) {
188 $htmlbody = $this->htmlbodytoCID($htmlbody);
191 if ($this->css_embed) {
192 $htmlbody = $this->htmlbodyCssEmbed($htmlbody);
195 if ($this->css_inline && strlen($this->css_inline)) {
196 $htmlbody = $this->htmlbodyInlineCss($htmlbody);
200 $tmp_opts['nonHTML'] = true;
201 //$tmp_opts['debug'] = true;
203 // print_R($tmp_opts);
204 // $tmp_opts['force'] = true;
206 $template = new HTML_Template_Flexy( $tmp_opts );
208 $template->compile('mail/'. $templateFile.'.txt');
210 /* use variables from this object to ouput data. */
211 $mailtext = $template->bufferedOutputObject($content);
212 //print_r($mailtext);exit;
216 //echo "<PRE>";print_R($mailtext);
218 /* With the output try and send an email, using a few tricks in Mail_MimeDecode. */
219 require_once 'Mail/mimeDecode.php';
220 require_once 'Mail.php';
222 $decoder = new Mail_mimeDecode($mailtext);
223 $parts = $decoder->getSendArray();
224 if (PEAR::isError($parts)) {
226 //echo "PROBLEM: {$parts->message}";
232 require_once 'Mail/mime.php';
233 $mime = new Mail_mime(array(
235 //'html_encoding' => 'base64',
236 'html_charset' => 'utf-8',
237 'text_charset' => 'utf-8',
238 'head_charset' => 'utf-8',
240 // clean up the headers...
243 $parts[1]['Message-Id'] = '<' . $content->msgid .
244 '@' . $content->HTTP_HOST .'>';
247 if ($htmlbody !== false) {
248 // got a html headers...
250 if (isset($parts[1]['Content-Type'])) {
251 unset($parts[1]['Content-Type']);
253 $mime->setTXTBody($parts[2]);
254 $this->textbody = $parts[2];
255 $mime->setHTMLBody($htmlbody);
257 // var_dump($mime);exit;
258 foreach($this->images as $cid=>$cdata) {
263 $cid.'.'.$cdata['ext'],
271 if(!empty($this->attachments)){
272 //if got a attachments
273 $header = $mime->headers($parts[1]);
275 if (isset($parts[1]['Content-Type'])) {
276 unset($parts[1]['Content-Type']);
281 if(preg_match('/text\/html/', $header['Content-Type'])){
282 $mime->setHTMLBody($parts[2]);
283 $mime->setTXTBody('This message is in HTML only');
284 $this->textbody = 'This message is in HTML only';
286 $mime->setTXTBody($parts[2]);
287 $this->textbody = $parts[2];
288 $mime->setHTMLBody('<PRE>'.htmlspecialchars($parts[2]).'</PRE>');
291 foreach($this->attachments as $attch){
292 $mime->addAttachment(
295 (!empty($attch['name'])) ? $attch['name'] : '',
304 $parts[2] = $mime->get();
305 $parts[1] = $mime->headers($parts[1]);
310 'recipents' => $parts[0],
311 'headers' => $parts[1],
315 if ($this->rcpts !== false) {
316 $ret['recipents'] = $this->rcpts;
318 // if 'to' is empty, then add the recipents in there... (must be an array?
319 if (!empty($ret['recipents']) && is_array($ret['recipents']) &&
320 (empty($ret['headers']['To']) || !strlen(trim($ret['headers']['To'])))) {
321 $ret['headers']['To'] = implode(',', $ret['recipents']);
325 // add bcc if necessary..
326 if (!empty($this->bcc)) {
327 $ret['bcc'] = $this->bcc;
331 function send($email = false)
334 $ff = HTML_FlexyFramework::get();
338 $email = is_array($email) ? $email : $this->toData();
340 if (is_a($email, 'PEAR_Error')) {
341 $pg->addEvent("COREMAILER-FAIL", false, "email toData failed");
347 //$this->log( htmlspecialchars(print_r($email,true)));
349 ///$recipents = array($this->email);
350 // $mailOptions = PEAR::getStaticProperty('Mail','options');
352 $mailOptions = isset($ff->Mail) ? $ff->Mail : array();
353 //print_R($mailOptions);exit;
355 if ($this->mail_method == 'SMTPMX' && empty($mailOptions['mailname'])) {
356 $pg->jerr("Mail[mailname] is not set - this is required for SMTPMX");
360 $mail = Mail::factory($this->mail_method,$mailOptions);
362 $mail->debug = (bool) $this->debug;
365 $email['headers']['Date'] = date('r');
366 if (PEAR::isError($mail)) {
367 $pg->addEvent("COREMAILER-FAIL", false, "mail factory failed");
372 $rcpts = $this->rcpts == false ? $email['recipents'] : $this->rcpts;
376 // this makes contents untrustable...
377 if (!empty($this->contents['bcc']) && is_array($this->contents['bcc'])) {
378 $rcpts =array_merge(is_array($rcpts) ? $rcpts : array($rcpts), $this->contents['bcc']);
381 $oe = error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT);
388 $ret = $mail->send($rcpts,$email['headers'],$email['body']);
389 error_reporting($oe);
391 $pg->addEvent("COREMAILER-SENT", false,
392 'To: ' . ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
393 'Subject: ' . @$email['headers']['Subject']
396 $pg->addEvent("COREMAILER-FAIL", false,
397 "Sending to : " . ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
398 " Error: " . $ret->toString());
405 function htmlbodytoCID($html)
407 $dom = new DOMDocument();
408 // this may raise parse errors as some html may be a component..
409 @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
410 $imgs= $dom->getElementsByTagName('img');
414 foreach ($imgs as $i=>$img) {
415 $url = $img->getAttribute('src');
416 if (preg_match('#^cid:#', $url)) {
419 $me = $img->getAttribute('mailembed');
424 if(!array_key_exists($url, $urls)){
425 $conv = $this->fetchImage($url);
427 $this->images[$conv['contentid']] = $conv;
431 $img->setAttribute('origsrc', $url);
432 $img->setAttribute('src', 'cid:' . $conv['contentid']);
436 return $dom->saveHTML();
439 function htmlbodyCssEmbed($html)
441 $ff = HTML_FlexyFramework::get();
442 $dom = new DOMDocument();
444 // this may raise parse errors as some html may be a component..
445 @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
446 $links = $dom->getElementsByTagName('link');
448 foreach ($links as $link) { // duplicate as links is dynamic and we change it..!
451 //<link rel="stylesheet" type="text/css" href="{rootURL}/roojs1/css-mailer/mailer.css">
453 foreach ($lc as $i=>$link) {
454 //var_dump($link->getAttribute('href'));
456 if ($link->getAttribute('rel') != 'stylesheet') {
459 $url = $link->getAttribute('href');
460 $file = $ff->rootDir . $url;
462 if (!preg_match('#^(http|https)://#', $url)) {
463 $file = $ff->rootDir . $url;
465 if (!file_exists($file)) {
467 $link->setAttribute('href', 'missing:' . $file);
471 $file = $this->mapurl($url);
474 $par = $link->parentNode;
475 $par->removeChild($link);
476 $s = $dom->createElement('style');
477 $e = $dom->createTextNode(file_get_contents($file));
479 $par->appendChild($s);
482 return $dom->saveHTML();
487 function htmlbodyInlineCss($html)
489 $dom = new DOMDocument();
491 @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
493 $html = $dom->getElementsByTagName('html');
494 $head = $dom->getElementsByTagName('head');
495 $body = $dom->getElementsByTagName('body');
498 $head = $dom->createElement('head');
499 $html->item(0)->insertBefore($head, $body->item(0));
500 $head = $dom->getElementsByTagName('head');
503 $s = $dom->createElement('style');
504 $e = $dom->createTextNode($this->css_inline);
506 $head->item(0)->appendChild($s);
508 return $dom->saveHTML();
511 require_once 'HTML/CSS/InlineStyle.php';
513 $doc = new HTML_CSS_InlineStyle($html);
515 $doc->applyStylesheet($this->css_inline);
517 $html = $doc->getHTML();
523 function htmlbodySetClass($html, $cls)
525 $dom = new DOMDocument();
527 @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
529 $body = $dom->getElementsByTagName('body');
530 if (!empty($body->length)) {
531 $body->item(0)->setAttribute('class', $cls);
533 $body = $dom->createElement("body");
534 $body->setAttribute('class', $cls);
535 $dom->appendChild($body);
539 return $dom->saveHTML();
542 function fetchImage($url)
546 $this->log( "FETCH : $url\n");
548 if ($url[0] == '/') {
549 $ff = HTML_FlexyFramework::get();
550 $file = $ff->rootDir . $url;
551 require_once 'File/MimeType.php';
552 $m = new File_MimeType();
553 $mt = $m->fromFilename($file);
554 $ext = $m->toExt($mt);
559 'contentid' => md5($file), // mailer makes md5 cid's' -- cid with attachment-** are done by mailer.
567 //print_R($url); exit;
570 if (preg_match('#^file:///#', $url)) {
571 $file = preg_replace('#^file://#', '', $url);
572 require_once 'File/MimeType.php';
573 $m = new File_MimeType();
574 $mt = $m->fromFilename($file);
575 $ext = $m->toExt($mt);
580 'contentid' => md5($file),
587 // 2 files --- the info file.. and the actual file...
590 $uinfo = posix_getpwuid( posix_getuid () );
591 $user = $uinfo['name'];
593 $cache = ini_get('session.save_path')."/Pman_Core_Mailer-{$user}/" . md5($url);
594 if ($this->cache_images &&
595 file_exists($cache) &&
596 filemtime($cache) > strtotime('NOW - 1 WEEK')
598 $ret = json_decode(file_get_contents($cache), true);
599 $this->log("fetched from cache");
600 $ret['file'] = $cache . '.data';
603 if (!file_exists(dirname($cache))) {
604 mkdir(dirname($cache),0700, true);
607 require_once 'HTTP/Request.php';
609 $real_url = str_replace(' ', '%20', $this->mapurl($url));
610 $a = new HTTP_Request($real_url);
612 $data = $a->getResponseBody();
614 $this->log("got file of size " . strlen($data));
615 $this->log("save contentid " . md5($url));
617 file_put_contents($cache .'.data', $data);
620 $mt = $a->getResponseHeader('Content-Type');
622 require_once 'File/MimeType.php';
623 $m = new File_MimeType();
624 $ext = $m->toExt($mt);
629 'contentid' => md5($url)
633 file_put_contents($cache, json_encode($ret));
634 $ret['file'] = $cache . '.data';
640 foreach($this->urlmap as $o=>$n) {
641 if (strpos($in,$o) === 0) {
642 $ret =$n . substr($in,strlen($o));
643 $this->log("mapURL in $in = $ret");
647 $this->log("mapurl no change - $in");
660 if ($this->debug < 2) {
661 echo '<PRE>' . print_r($val,true). "\n";
664 $fh = fopen('/tmp/core_mailer.log', 'a');
665 fwrite($fh, date('Y-m-d H:i:s -') . json_encode($val) . "\n");