src/Protocol/Email.php

   1 <?php
   2 /**
   3  * @file src/Protocol/Email.php
   4  */
   5 namespace Friendica\Protocol;
   6
   7 require_once 'include/html2plain.php';
   8 require_once 'include/msgclean.php';
   9 require_once 'include/quoteconvert.php';
  10
  11 /**
  12  * @brief Email class
  13  */
  14 class Email
  15 {
  16         /**
  17          * @param string $mailbox  The mailbox name
  18          * @param string $username The username
  19          * @param string $password The password
  20          * @return object
  21          */
  22         public static function connect($mailbox, $username, $password)
  23         {
  24                 if (! function_exists('imap_open')) {
  25                         return false;
  26                 }
  27
  28                 $mbox = @imap_open($mailbox, $username, $password);
  29
  30                 return $mbox;
  31         }
  32
  33         /**
  34          * @param object $mbox       mailbox
  35          * @param string $email_addr email
  36          * @return array
  37          */
  38         public static function poll($mbox, $email_addr)
  39         {
  40                 if (! ($mbox && $email_addr))
  41                         return array();
  42
  43                 $search1 = @imap_search($mbox, 'FROM "' . $email_addr . '"', SE_UID);
  44                 if (!$search1) {
  45                         $search1 = array();
  46                 } else {
  47                         logger("Found mails from ".$email_addr, LOGGER_DEBUG);
  48                 }
  49
  50                 $search2 = @imap_search($mbox, 'TO "' . $email_addr . '"', SE_UID);
  51                 if (!$search2) {
  52                         $search2 = array();
  53                 } else {
  54                         logger("Found mails to ".$email_addr, LOGGER_DEBUG);
  55                 }
  56
  57                 $search3 = @imap_search($mbox, 'CC "' . $email_addr . '"', SE_UID);
  58                 if (!$search3) {
  59                         $search3 = array();
  60                 } else {
  61                         logger("Found mails cc ".$email_addr, LOGGER_DEBUG);
  62                 }
  63
  64                 $res = array_unique(array_merge($search1, $search2, $search3));
  65
  66                 return $res;
  67         }
  68
  69         /**
  70          * @param array $mailacct mail account
  71          * @return object
  72          */
  73         public static function constructMailboxName($mailacct)
  74         {
  75                 $ret = '{' . $mailacct['server'] . ((intval($mailacct['port'])) ? ':' . $mailacct['port'] : '');
  76                 $ret .= (($mailacct['ssltype']) ?  '/' . $mailacct['ssltype'] . '/novalidate-cert' : '');
  77                 $ret .= '}' . $mailacct['mailbox'];
  78                 return $ret;
  79         }
  80
  81         /**
  82          * @param object  $mbox mailbox
  83          * @param integer $uid  user id
  84          * @return mixed
  85          */
  86         public static function messageMeta($mbox, $uid)
  87         {
  88                 $ret = (($mbox && $uid) ? @imap_fetch_overview($mbox, $uid, FT_UID) : array(array())); // POSSIBLE CLEANUP --> array(array()) is probably redundant now
  89                 return (count($ret)) ? $ret : array();
  90         }
  91
  92         /**
  93          * @param object  $mbox  mailbox
  94          * @param integer $uid   user id
  95          * @param string  $reply reply
  96          * @return array
  97          */
  98         public static function getMessage($mbox, $uid, $reply)
  99         {
 100                 $ret = array();
 101
 102                 $struc = (($mbox && $uid) ? @imap_fetchstructure($mbox, $uid, FT_UID) : null);
 103
 104                 if (! $struc) {
 105                         return $ret;
 106                 }
 107
 108                 if (! $struc->parts) {
 109                         $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'html');
 110                         $html = $ret['body'];
 111
 112                         if (trim($ret['body']) == '') {
 113                                 $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'plain');
 114                         } else {
 115                                 $ret['body'] = html2bbcode($ret['body']);
 116                         }
 117                 } else {
 118                         $text = '';
 119                         $html = '';
 120                         foreach ($struc->parts as $ptop => $p) {
 121                                 $x = self::messageGetPart($mbox, $uid, $p, $ptop + 1, 'plain');
 122                                 if ($x) {
 123                                         $text .= $x;
 124                                 }
 125
 126                                 $x = self::messageGetPart($mbox, $uid, $p, $ptop + 1, 'html');
 127                                 if ($x) {
 128                                         $html .= $x;
 129                                 }
 130                         }
 131                         if (trim($html) != '') {
 132                                 $ret['body'] = html2bbcode($html);
 133                         } else {
 134                                 $ret['body'] = $text;
 135                         }
 136                 }
 137
 138                 $ret['body'] = removegpg($ret['body']);
 139                 $msg = removesig($ret['body']);
 140                 $ret['body'] = $msg['body'];
 141                 $ret['body'] = convertquote($ret['body'], $reply);
 142
 143                 if (trim($html) != '') {
 144                         $ret['body'] = removelinebreak($ret['body']);
 145                 }
 146
 147                 $ret['body'] = unifyattributionline($ret['body']);
 148
 149                 return $ret;
 150         }
 151
 152         // At the moment - only return plain/text.
 153         // Later we'll repackage inline images as data url's and make the HTML safe
 154         /**
 155          * @param object  $mbox    mailbox
 156          * @param integer $uid     user id
 157          * @param object  $p       parts
 158          * @param integer $partno  part number
 159          * @param string  $subtype sub type
 160          * @return string
 161          */
 162         private static function messageGetPart($mbox, $uid, $p, $partno, $subtype)
 163         {
 164                 // $partno = '1', '2', '2.1', '2.1.3', etc for multipart, 0 if simple
 165                 global $htmlmsg,$plainmsg,$charset,$attachments;
 166
 167                 //echo $partno."\n";
 168
 169                 // DECODE DATA
 170                 $data = ($partno)
 171                         ? @imap_fetchbody($mbox, $uid, $partno, FT_UID|FT_PEEK)
 172                 : @imap_body($mbox, $uid, FT_UID|FT_PEEK);
 173
 174                 // Any part may be encoded, even plain text messages, so check everything.
 175                 if ($p->encoding==4) {
 176                         $data = quoted_printable_decode($data);
 177                 } elseif ($p->encoding==3) {
 178                         $data = base64_decode($data);
 179                 }
 180
 181                 // PARAMETERS
 182                 // get all parameters, like charset, filenames of attachments, etc.
 183                 $params = array();
 184                 if ($p->parameters) {
 185                         foreach ($p->parameters as $x) {
 186                                 $params[strtolower($x->attribute)] = $x->value;
 187                         }
 188                 }
 189
 190                 if (isset($p->dparameters) && $p->dparameters) {
 191                         foreach ($p->dparameters as $x) {
 192                                 $params[strtolower($x->attribute)] = $x->value;
 193                         }
 194                 }
 195
 196                 // ATTACHMENT
 197                 // Any part with a filename is an attachment,
 198                 // so an attached text file (type 0) is not mistaken as the message.
 199
 200                 if ((isset($params['filename']) && $params['filename']) || (isset($params['name']) && $params['name'])) {
 201                         // filename may be given as 'Filename' or 'Name' or both
 202                         $filename = ($params['filename'])? $params['filename'] : $params['name'];
 203                         // filename may be encoded, so see imap_mime_header_decode()
 204                         $attachments[$filename] = $data;  // this is a problem if two files have same name
 205                 }
 206
 207                 // TEXT
 208                 if ($p->type == 0 && $data) {
 209                         // Messages may be split in different parts because of inline attachments,
 210                         // so append parts together with blank row.
 211                         if (strtolower($p->subtype)==$subtype) {
 212                                 $data = iconv($params['charset'], 'UTF-8//IGNORE', $data);
 213                                 return (trim($data) ."\n\n");
 214                         } else {
 215                                 $data = '';
 216                         }
 217
 218                         // $htmlmsg .= $data ."<br><br>";
 219                         $charset = $params['charset'];  // assume all parts are same charset
 220                 }
 221
 222                 // EMBEDDED MESSAGE
 223                 // Many bounce notifications embed the original message as type 2,
 224                 // but AOL uses type 1 (multipart), which is not handled here.
 225                 // There are no PHP functions to parse embedded messages,
 226                 // so this just appends the raw source to the main message.
 227                 //      elseif ($p->type==2 && $data) {
 228                 //              $plainmsg .= $data."\n\n";
 229                 //      }
 230
 231                 // SUBPART RECURSION
 232                 if (isset($p->parts) && $p->parts) {
 233                         $x = "";
 234                         foreach ($p->parts as $partno0 => $p2) {
 235                                 $x .=  self::messageGetPart($mbox, $uid, $p2, $partno . '.' . ($partno0+1), $subtype);  // 1.2, 1.2.1, etc.
 236                                 //if ($x) {
 237                                 //      return $x;
 238                                 //}
 239                         }
 240                         return $x;
 241                 }
 242         }
 243
 244         /**
 245          * @param string $in_str  in string
 246          * @param string $charset character set
 247          * @return string
 248          */
 249         public static function encodeHeader($in_str, $charset)
 250         {
 251                 $out_str = $in_str;
 252                 $need_to_convert = false;
 253
 254                 for ($x = 0; $x < strlen($in_str); $x ++) {
 255                         if ((ord($in_str[$x]) == 0) || ((ord($in_str[$x]) > 128))) {
 256                                 $need_to_convert = true;
 257                         }
 258                 }
 259
 260                 if (! $need_to_convert) {
 261                         return $in_str;
 262                 }
 263
 264                 if ($out_str && $charset) {
 265                         // define start delimimter, end delimiter and spacer
 266                         $end = "?=";
 267                         $start = "=?" . $charset . "?B?";
 268                         $spacer = $end . "\r\n " . $start;
 269
 270                         // determine length of encoded text within chunks
 271                         // and ensure length is even
 272                         $length = 75 - strlen($start) - strlen($end);
 273
 274                         /*
 275                                 [EDIT BY danbrown AT php DOT net: The following
 276                                 is a bugfix provided by (gardan AT gmx DOT de)
 277                                 on 31-MAR-2005 with the following note:
 278                                 "This means: $length should not be even,
 279                                 but divisible by 4. The reason is that in
 280                                 base64-encoding 3 8-bit-chars are represented
 281                                 by 4 6-bit-chars. These 4 chars must not be
 282                                 split between two encoded words, according
 283                                 to RFC-2047.
 284                         */
 285                         $length = $length - ($length % 4);
 286
 287                         // encode the string and split it into chunks
 288                         // with spacers after each chunk
 289                         $out_str = base64_encode($out_str);
 290                         $out_str = chunk_split($out_str, $length, $spacer);
 291
 292                         // remove trailing spacer and
 293                         // add start and end delimiters
 294                         $spacer = preg_quote($spacer, '/');
 295                         $out_str = preg_replace("/" . $spacer . "$/", "", $out_str);
 296                         $out_str = $start . $out_str . $end;
 297                 }
 298                 return $out_str;
 299         }
 300
 301         /**
 302          * Function send is used by NETWORK_EMAIL and NETWORK_EMAIL2 code
 303          * (not to notify the user, but to send items to email contacts)
 304          *
 305          * @param string $addr    address
 306          * @param string $subject subject
 307          * @param string $headers headers
 308          * @param array  $item    item
 309          *
 310          * @return void
 311          *
 312          * @todo This could be changed to use the Emailer class
 313          */
 314         public static function send($addr, $subject, $headers, $item)
 315         {
 316                 //$headers .= 'MIME-Version: 1.0' . "\n";
 317                 //$headers .= 'Content-Type: text/html; charset=UTF-8' . "\n";
 318                 //$headers .= 'Content-Type: text/plain; charset=UTF-8' . "\n";
 319                 //$headers .= 'Content-Transfer-Encoding: 8bit' . "\n\n";
 320
 321                 $part = uniqid("", true);
 322
 323                 $html    = prepare_body($item);
 324
 325                 $headers .= "Mime-Version: 1.0\n";
 326                 $headers .= 'Content-Type: multipart/alternative; boundary="=_'.$part.'"'."\n\n";
 327
 328                 $body = "\n--=_".$part."\n";
 329                 $body .= "Content-Transfer-Encoding: 8bit\n";
 330                 $body .= "Content-Type: text/plain; charset=utf-8; format=flowed\n\n";
 331
 332                 $body .= html2plain($html)."\n";
 333
 334                 $body .= "--=_".$part."\n";
 335                 $body .= "Content-Transfer-Encoding: 8bit\n";
 336                 $body .= "Content-Type: text/html; charset=utf-8\n\n";
 337
 338                 $body .= '<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">'.$html."</body></html>\n";
 339
 340                 $body .= "--=_".$part."--";
 341
 342                 //$message = '<html><body>' . $html . '</body></html>';
 343                 //$message = html2plain($html);
 344                 logger('notifier: email delivery to ' . $addr);
 345                 mail($addr, $subject, $body, $headers);
 346         }
 347
 348         /**
 349          * @param string $iri string
 350          * @return string
 351          */
 352         public static function iri2msgid($iri)
 353         {
 354                 if (!strpos($iri, "@")) {
 355                         $msgid = preg_replace("/urn:(\S+):(\S+)\.(\S+):(\d+):(\S+)/i", "urn!$1!$4!$5@$2.$3", $iri);
 356                 } else {
 357                         $msgid = $iri;
 358                 }
 359
 360                 return($msgid);
 361         }
 362
 363         /**
 364          * @param string $msgid msgid
 365          * @return string
 366          */
 367         public static function msgid2iri($msgid)
 368         {
 369                 if (strpos($msgid, "@")) {
 370                         $iri = preg_replace("/urn!(\S+)!(\d+)!(\S+)@(\S+)\.(\S+)/i", "urn:$1:$4.$5:$2:$3", $msgid);
 371                 } else {
 372                         $iri = $msgid;
 373                 }
 374
 375                 return($iri);
 376         }
 377 }