3 * @file src/Protocol/Email.php
5 namespace Friendica\Protocol;
7 use Friendica\Core\Logger;
8 use Friendica\Content\Text\HTML;
9 use Friendica\Model\Item;
17 * @param string $mailbox The mailbox name
18 * @param string $username The username
19 * @param string $password The password
23 public static function connect($mailbox, $username, $password)
25 if (!function_exists('imap_open')) {
29 $mbox = @imap_open($mailbox, $username, $password);
31 $errors = imap_errors();
32 if (!empty($errors)) {
33 Logger::log('IMAP Errors occured: ' . json_encode($errors));
36 $alerts = imap_alerts();
37 if (!empty($alerts)) {
38 Logger::log('IMAP Alerts occured: ' . json_encode($alerts));
45 * @param resource $mbox mailbox
46 * @param string $email_addr email
50 public static function poll($mbox, $email_addr)
52 if (!$mbox || !$email_addr) {
56 $search1 = @imap_search($mbox, 'FROM "' . $email_addr . '"', SE_UID);
60 Logger::log("Found mails from ".$email_addr, Logger::DEBUG);
63 $search2 = @imap_search($mbox, 'TO "' . $email_addr . '"', SE_UID);
67 Logger::log("Found mails to ".$email_addr, Logger::DEBUG);
70 $search3 = @imap_search($mbox, 'CC "' . $email_addr . '"', SE_UID);
74 Logger::log("Found mails cc ".$email_addr, Logger::DEBUG);
77 $res = array_unique(array_merge($search1, $search2, $search3));
83 * @param array $mailacct mail account
86 public static function constructMailboxName($mailacct)
88 $ret = '{' . $mailacct['server'] . ((intval($mailacct['port'])) ? ':' . $mailacct['port'] : '');
89 $ret .= (($mailacct['ssltype']) ? '/' . $mailacct['ssltype'] . '/novalidate-cert' : '');
90 $ret .= '}' . $mailacct['mailbox'];
95 * @param resource $mbox mailbox
96 * @param integer $uid user id
99 public static function messageMeta($mbox, $uid)
101 $ret = (($mbox && $uid) ? @imap_fetch_overview($mbox, $uid, FT_UID) : [[]]); // POSSIBLE CLEANUP --> array(array()) is probably redundant now
102 return (count($ret)) ? $ret : [];
106 * @param resource $mbox mailbox
107 * @param integer $uid user id
108 * @param string $reply reply
110 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
112 public static function getMessage($mbox, $uid, $reply)
116 $struc = (($mbox && $uid) ? @imap_fetchstructure($mbox, $uid, FT_UID) : null);
122 if (empty($struc->parts)) {
123 $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'html');
124 $html = $ret['body'];
126 if (trim($ret['body']) == '') {
127 $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'plain');
129 $ret['body'] = HTML::toBBCode($ret['body']);
134 foreach ($struc->parts as $ptop => $p) {
135 $x = self::messageGetPart($mbox, $uid, $p, $ptop + 1, 'plain');
140 $x = self::messageGetPart($mbox, $uid, $p, $ptop + 1, 'html');
145 if (trim($html) != '') {
146 $ret['body'] = HTML::toBBCode($html);
148 $ret['body'] = $text;
152 $ret['body'] = self::removeGPG($ret['body']);
153 $msg = self::removeSig($ret['body']);
154 $ret['body'] = $msg['body'];
155 $ret['body'] = self::convertQuote($ret['body'], $reply);
157 if (trim($html) != '') {
158 $ret['body'] = self::removeLinebreak($ret['body']);
161 $ret['body'] = self::unifyAttributionLine($ret['body']);
166 // At the moment - only return plain/text.
167 // Later we'll repackage inline images as data url's and make the HTML safe
169 * @param resource $mbox mailbox
170 * @param integer $uid user id
171 * @param object $p parts
172 * @param integer $partno part number
173 * @param string $subtype sub type
176 private static function messageGetPart($mbox, $uid, $p, $partno, $subtype)
178 // $partno = '1', '2', '2.1', '2.1.3', etc for multipart, 0 if simple
179 global $htmlmsg,$plainmsg,$charset,$attachments;
183 ? @imap_fetchbody($mbox, $uid, $partno, FT_UID|FT_PEEK)
184 : @imap_body($mbox, $uid, FT_UID|FT_PEEK);
186 // Any part may be encoded, even plain text messages, so check everything.
187 if ($p->encoding == 4) {
188 $data = quoted_printable_decode($data);
189 } elseif ($p->encoding == 3) {
190 $data = base64_decode($data);
194 // get all parameters, like charset, filenames of attachments, etc.
196 if ($p->parameters) {
197 foreach ($p->parameters as $x) {
198 $params[strtolower($x->attribute)] = $x->value;
202 if (isset($p->dparameters) && $p->dparameters) {
203 foreach ($p->dparameters as $x) {
204 $params[strtolower($x->attribute)] = $x->value;
209 // Any part with a filename is an attachment,
210 // so an attached text file (type 0) is not mistaken as the message.
212 if ((isset($params['filename']) && $params['filename']) || (isset($params['name']) && $params['name'])) {
213 // filename may be given as 'Filename' or 'Name' or both
214 $filename = ($params['filename'])? $params['filename'] : $params['name'];
215 // filename may be encoded, so see imap_mime_header_decode()
216 $attachments[$filename] = $data; // this is a problem if two files have same name
220 if ($p->type == 0 && $data) {
221 // Messages may be split in different parts because of inline attachments,
222 // so append parts together with blank row.
223 if (strtolower($p->subtype)==$subtype) {
224 $data = iconv($params['charset'], 'UTF-8//IGNORE', $data);
225 return (trim($data) ."\n\n");
230 // $htmlmsg .= $data ."<br><br>";
231 $charset = $params['charset']; // assume all parts are same charset
235 // Many bounce notifications embed the original message as type 2,
236 // but AOL uses type 1 (multipart), which is not handled here.
237 // There are no PHP functions to parse embedded messages,
238 // so this just appends the raw source to the main message.
239 // elseif ($p->type==2 && $data) {
240 // $plainmsg .= $data."\n\n";
244 if (isset($p->parts) && $p->parts) {
246 foreach ($p->parts as $partno0 => $p2) {
247 $x .= self::messageGetPart($mbox, $uid, $p2, $partno . '.' . ($partno0+1), $subtype); // 1.2, 1.2.1, etc.
254 * @param string $in_str in string
255 * @param string $charset character set
258 public static function encodeHeader($in_str, $charset)
261 $need_to_convert = false;
263 for ($x = 0; $x < strlen($in_str); $x ++) {
264 if ((ord($in_str[$x]) == 0) || ((ord($in_str[$x]) > 128))) {
265 $need_to_convert = true;
269 if (!$need_to_convert) {
273 if ($out_str && $charset) {
274 // define start delimimter, end delimiter and spacer
276 $start = "=?" . $charset . "?B?";
277 $spacer = $end . "\r\n " . $start;
279 // determine length of encoded text within chunks
280 // and ensure length is even
281 $length = 75 - strlen($start) - strlen($end);
284 [EDIT BY danbrown AT php DOT net: The following
285 is a bugfix provided by (gardan AT gmx DOT de)
286 on 31-MAR-2005 with the following note:
287 "This means: $length should not be even,
288 but divisible by 4. The reason is that in
289 base64-encoding 3 8-bit-chars are represented
290 by 4 6-bit-chars. These 4 chars must not be
291 split between two encoded words, according
294 $length = $length - ($length % 4);
296 // encode the string and split it into chunks
297 // with spacers after each chunk
298 $out_str = base64_encode($out_str);
299 $out_str = chunk_split($out_str, $length, $spacer);
301 // remove trailing spacer and
302 // add start and end delimiters
303 $spacer = preg_quote($spacer, '/');
304 $out_str = preg_replace("/" . $spacer . "$/", "", $out_str);
305 $out_str = $start . $out_str . $end;
311 * Function send is used by Protocol::EMAIL and Protocol::EMAIL2 code
312 * (not to notify the user, but to send items to email contacts)
314 * @param string $addr address
315 * @param string $subject subject
316 * @param string $headers headers
317 * @param array $item item
321 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
322 * @throws \ImagickException
323 * @todo This could be changed to use the Emailer class
325 public static function send($addr, $subject, $headers, $item)
327 //$headers .= 'MIME-Version: 1.0' . "\n";
328 //$headers .= 'Content-Type: text/html; charset=UTF-8' . "\n";
329 //$headers .= 'Content-Type: text/plain; charset=UTF-8' . "\n";
330 //$headers .= 'Content-Transfer-Encoding: 8bit' . "\n\n";
332 $part = uniqid("", true);
334 $html = Item::prepareBody($item);
336 $headers .= "Mime-Version: 1.0\n";
337 $headers .= 'Content-Type: multipart/alternative; boundary="=_'.$part.'"'."\n\n";
339 $body = "\n--=_".$part."\n";
340 $body .= "Content-Transfer-Encoding: 8bit\n";
341 $body .= "Content-Type: text/plain; charset=utf-8; format=flowed\n\n";
343 $body .= HTML::toPlaintext($html)."\n";
345 $body .= "--=_".$part."\n";
346 $body .= "Content-Transfer-Encoding: 8bit\n";
347 $body .= "Content-Type: text/html; charset=utf-8\n\n";
349 $body .= '<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">'.$html."</body></html>\n";
351 $body .= "--=_".$part."--";
353 //$message = '<html><body>' . $html . '</body></html>';
354 //$message = html2plain($html);
355 Logger::log('notifier: email delivery to ' . $addr);
356 mail($addr, $subject, $body, $headers);
360 * @param string $iri string
363 public static function iri2msgid($iri)
365 if (!strpos($iri, "@")) {
366 $msgid = preg_replace("/urn:(\S+):(\S+)\.(\S+):(\d+):(\S+)/i", "urn!$1!$4!$5@$2.$3", $iri);
375 * @param string $msgid msgid
378 public static function msgid2iri($msgid)
380 if (strpos($msgid, "@")) {
381 $iri = preg_replace("/urn!(\S+)!(\d+)!(\S+)@(\S+)\.(\S+)/i", "urn:$1:$4.$5:$2:$3", $msgid);
389 private static function saveReplace($pattern, $replace, $text)
393 $text = preg_replace($pattern, $replace, $text);
401 private static function unifyAttributionLine($message)
403 $quotestr = ['quote', 'spoiler'];
404 foreach ($quotestr as $quote) {
405 $message = self::saveReplace('/----- Original Message -----\s.*?From: "([^<"].*?)" <(.*?)>\s.*?To: (.*?)\s*?Cc: (.*?)\s*?Sent: (.*?)\s.*?Subject: ([^\n].*)\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
406 $message = self::saveReplace('/----- Original Message -----\s.*?From: "([^<"].*?)" <(.*?)>\s.*?To: (.*?)\s*?Sent: (.*?)\s.*?Subject: ([^\n].*)\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
408 $message = self::saveReplace('/-------- Original-Nachricht --------\s*\['.$quote.'\]\nDatum: (.*?)\nVon: (.*?) <(.*?)>\nAn: (.*?)\nBetreff: (.*?)\n/i', "[".$quote."='$2']\n", $message);
409 $message = self::saveReplace('/-------- Original-Nachricht --------\s*\['.$quote.'\]\sDatum: (.*?)\s.*Von: "([^<"].*?)" <(.*?)>\s.*An: (.*?)\n.*/i', "[".$quote."='$2']\n", $message);
410 $message = self::saveReplace('/-------- Original-Nachricht --------\s*\['.$quote.'\]\nDatum: (.*?)\nVon: (.*?)\nAn: (.*?)\nBetreff: (.*?)\n/i', "[".$quote."='$2']\n", $message);
412 $message = self::saveReplace('/-----Urspr.*?ngliche Nachricht-----\sVon: "([^<"].*?)" <(.*?)>\s.*Gesendet: (.*?)\s.*An: (.*?)\s.*Betreff: ([^\n].*?).*:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
413 $message = self::saveReplace('/-----Urspr.*?ngliche Nachricht-----\sVon: "([^<"].*?)" <(.*?)>\s.*Gesendet: (.*?)\s.*An: (.*?)\s.*Betreff: ([^\n].*?)\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
415 $message = self::saveReplace('/Am (.*?), schrieb (.*?):\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
417 $message = self::saveReplace('/Am .*?, \d+ .*? \d+ \d+:\d+:\d+ \+\d+\sschrieb\s(.*?)\s<(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
419 $message = self::saveReplace('/Am (.*?) schrieb (.*?) <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
420 $message = self::saveReplace('/Am (.*?) schrieb <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
421 $message = self::saveReplace('/Am (.*?) schrieb (.*?):\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
422 $message = self::saveReplace('/Am (.*?) schrieb (.*?)\n(.*?):\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
424 $message = self::saveReplace('/(\d+)\/(\d+)\/(\d+) ([^<"].*?) <(.*?)>\s*\['.$quote.'\]/i', "[".$quote."='$4']\n", $message);
426 $message = self::saveReplace('/On .*?, \d+ .*? \d+ \d+:\d+:\d+ \+\d+\s(.*?)\s<(.*?)>\swrote:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
428 $message = self::saveReplace('/On (.*?) at (.*?), (.*?)\s<(.*?)>\swrote:\s*\['.$quote.'\]/i', "[".$quote."='$3']\n", $message);
429 $message = self::saveReplace('/On (.*?)\n([^<].*?)\s<(.*?)>\swrote:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
430 $message = self::saveReplace('/On (.*?), (.*?), (.*?)\s<(.*?)>\swrote:\s*\['.$quote.'\]/i', "[".$quote."='$3']\n", $message);
431 $message = self::saveReplace('/On ([^,].*?), (.*?)\swrote:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
432 $message = self::saveReplace('/On (.*?), (.*?)\swrote\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
434 // Der loescht manchmal den Body - was eigentlich unmoeglich ist
435 $message = self::saveReplace('/On (.*?),(.*?),(.*?),(.*?), (.*?) wrote:\s*\['.$quote.'\]/i', "[".$quote."='$5']\n", $message);
437 $message = self::saveReplace('/Zitat von ([^<].*?) <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
439 $message = self::saveReplace('/Quoting ([^<].*?) <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
441 $message = self::saveReplace('/From: "([^<"].*?)" <(.*?)>\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
442 $message = self::saveReplace('/From: <(.*?)>\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
444 $message = self::saveReplace('/Du \(([^)].*?)\) schreibst:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
446 $message = self::saveReplace('/--- (.*?) <.*?> schrieb am (.*?):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
447 $message = self::saveReplace('/--- (.*?) schrieb am (.*?):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
449 $message = self::saveReplace('/\* (.*?) <(.*?)> hat geschrieben:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
451 $message = self::saveReplace('/(.*?) <(.*?)> schrieb (.*?)\):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
452 $message = self::saveReplace('/(.*?) <(.*?)> schrieb am (.*?) um (.*):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
453 $message = self::saveReplace('/(.*?) schrieb am (.*?) um (.*):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
454 $message = self::saveReplace('/(.*?) \((.*?)\) schrieb:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
455 $message = self::saveReplace('/(.*?) schrieb:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
457 $message = self::saveReplace('/(.*?) <(.*?)> writes:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
458 $message = self::saveReplace('/(.*?) \((.*?)\) writes:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
459 $message = self::saveReplace('/(.*?) writes:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
461 $message = self::saveReplace('/\* (.*?) wrote:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
462 $message = self::saveReplace('/(.*?) wrote \(.*?\):\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
463 $message = self::saveReplace('/(.*?) wrote:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
465 $message = self::saveReplace('/([^<].*?) <.*?> hat am (.*?)\sum\s(.*)\sgeschrieben:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
467 $message = self::saveReplace('/(\d+)\/(\d+)\/(\d+) ([^<"].*?) <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$4']\n", $message);
468 $message = self::saveReplace('/(\d+)\/(\d+)\/(\d+) (.*?) <(.*?)>\s*\['.$quote.'\]/i', "[".$quote."='$4']\n", $message);
469 $message = self::saveReplace('/(\d+)\/(\d+)\/(\d+) <(.*?)>:\s*\['.$quote.'\]/i', "[".$quote."='$4']\n", $message);
470 $message = self::saveReplace('/(\d+)\/(\d+)\/(\d+) <(.*?)>\s*\['.$quote.'\]/i', "[".$quote."='$4']\n", $message);
472 $message = self::saveReplace('/(.*?) <(.*?)> schrubselte:\s*\['.$quote.'\]/i', "[".$quote."='$1']\n", $message);
473 $message = self::saveReplace('/(.*?) \((.*?)\) schrubselte:\s*\['.$quote.'\]/i', "[".$quote."='$2']\n", $message);
478 private static function removeGPG($message)
480 $pattern = '/(.*)\s*-----BEGIN PGP SIGNED MESSAGE-----\s*[\r\n].*Hash:.*?[\r\n](.*)'.
481 '[\r\n]\s*-----BEGIN PGP SIGNATURE-----\s*[\r\n].*'.
482 '[\r\n]\s*-----END PGP SIGNATURE-----(.*)/is';
484 if (preg_match($pattern, $message, $result)) {
485 $cleaned = trim($result[1].$result[2].$result[3]);
487 $cleaned = str_replace(["\n- --\n", "\n- -"], ["\n-- \n", "\n-"], $cleaned);
495 private static function removeSig($message)
497 $sigpos = strrpos($message, "\n-- \n");
498 $quotepos = strrpos($message, "[/quote]");
501 // Especially for web.de who are using that as a separator
502 $message = str_replace("\n___________________________________________________________\n", "\n-- \n", $message);
503 $sigpos = strrpos($message, "\n-- \n");
504 $quotepos = strrpos($message, "[/quote]");
507 // When the signature separator is inside a quote, we don't separate
508 if (($sigpos < $quotepos) && ($sigpos != 0)) {
509 return ['body' => $message, 'sig' => ''];
512 $pattern = '/(.*)[\r\n]-- [\r\n](.*)/is';
514 preg_match($pattern, $message, $result);
516 if (!empty($result[1]) && !empty($result[2])) {
517 $cleaned = trim($result[1])."\n";
518 $sig = trim($result[2]);
524 return ['body' => $cleaned, 'sig' => $sig];
527 private static function removeLinebreak($message)
529 $arrbody = explode("\n", trim($message));
534 foreach ($arrbody as $i => $line) {
537 while ((strlen($currline)>0) && ((substr($currline, 0, 1) == '>')
538 || (substr($currline, 0, 1) == ' '))) {
539 if (substr($currline, 0, 1) == '>') {
543 $currline = ltrim(substr($currline, 1));
547 $nextline = trim($arrbody[$i + 1] ?? '');
548 while ((strlen($nextline)>0) && ((substr($nextline, 0, 1) == '>')
549 || (substr($nextline, 0, 1) == ' '))) {
550 if (substr($nextline, 0, 1) == '>') {
554 $nextline = ltrim(substr($nextline, 1));
557 if (!empty($lines[$lineno])) {
558 if (substr($lines[$lineno], -1) != ' ') {
559 $lines[$lineno] .= ' ';
562 while ((strlen($line)>0) && ((substr($line, 0, 1) == '>')
563 || (substr($line, 0, 1) == ' '))) {
565 $line = ltrim(substr($line, 1));
568 $lines[$lineno] = '';
571 $lines[$lineno] .= $line;
572 if (((substr($line, -1, 1) != ' '))
573 || ($quotelevel != $currquotelevel)) {
577 return implode("\n", $lines);
580 private static function convertQuote($body, $reply)
583 $arrbody = explode("\n", trim($body));
586 for ($i = 0; $i < count($arrbody); $i++) {
588 $quoteline = $arrbody[$i];
590 while ((strlen($quoteline)>0) and ((substr($quoteline, 0, 1) == '>')
591 || (substr($quoteline, 0, 1) == ' '))) {
592 if (substr($quoteline, 0, 1) == '>')
595 $quoteline = ltrim(substr($quoteline, 1));
598 $arrlevel[$i] = $quotelevel;
599 $arrbody[$i] = $quoteline;
605 for ($i = 0; $i < count($arrbody); $i++) {
606 $previousquote = $quotelevel;
607 $quotelevel = $arrlevel[$i];
609 while ($previousquote < $quotelevel) {
611 $arrbody[$i] = $quote.$arrbody[$i];
615 while ($previousquote > $quotelevel) {
616 $arrbody[$i] = '[/quote]'.$arrbody[$i];
620 $arrbodyquoted[] = $arrbody[$i];
622 while ($quotelevel > 0) {
623 $arrbodyquoted[] = '[/quote]';
627 $body = implode("\n", $arrbodyquoted);
629 if (strlen($body) > 0) {
630 $body = $body."\n\n";
634 $body = self::removeToFu($body);
640 private static function removeToFu($message)
642 $message = trim($message);
645 $oldmessage = $message;
646 $message = preg_replace('=\[/quote\][\s](.*?)\[quote\]=i', '$1', $message);
647 $message = str_replace("[/quote][quote]", "", $message);
648 } while ($message != $oldmessage);
656 while (($pos = strpos($message, '[quote', $start)) > 0) {
665 while (($pos = strpos($message, '[/quote]', $start)) > 0) {
670 while ($endquotes < $startquotes) {
671 $message .= '[/quote]';
677 while (($pos = strpos($message, '[/quote]', $start)) > 0) {
682 if (strtolower(substr($message, -8)) != '[/quote]')
689 foreach ($quotes as $index => $quote) {
690 $quotelevel += $quote;
692 if (($quotelevel == 0) and ($quotestart == 0))
693 $quotestart = $index;
696 if ($quotestart != 0) {
697 $message = trim(substr($message, 0, $quotestart))."\n[spoiler]".substr($message, $quotestart+7, -8).'[/spoiler]';