Alternate class.mailfetch.php: Page 2

Alternate class.mailfetch.php

mittra

class.zmailfetch.php (cont) //Convert text to desired encoding..defaults to utf8 function mime_encode($text, $charset=null, $encoding='utf-8') { //Thank in part to afterburner return Format:($text, $charset, $encoding); } function mailbox_encode($mailbox) { if (!$mailbox) return null; // Properly encode the mailbox to UTF-7, according to rfc2060, // section 5.1.3 elseif (function_exists('mb_convert_encoding')) return mb_convert_encoding($mailbox, 'UTF7-IMAP', 'utf-8'); else { $msg_encode = new Zend\Mail\Message($mailbox); return $msg_encode->setEncoding('UTF-7'); } } /** * Mime header value decoder. Usually unicode characters are encoded * according to RFC-2047. This function will decode RFC-2047 encoded * header values as well as detect headers which are not encoded. * * Caveats: * If headers contain non-ascii characters the result of this function * is completely undefined. If osTicket is corrupting your email * headers, your mail software is not encoding the header text * correctly. * * Returns: * Header value, transocded to UTF-8 */ function mime_decode($text, $encoding='utf-8') { // Handle poorly or completely un-encoded header values ( if (function_exists('mb_detect_encoding')) if (($src_enc = mb_detect_encoding($text)) && (strcasecmp($src_enc, 'ASCII') !== 0)) return Format:($text, $src_enc, $encoding); // Handle ASCII text and RFC-2047 encoding $str = ''; $parts = mb_decode_mimeheader($text); foreach ($parts as $part) $str.= $this->mime_encode($part->text, $part->charset, $encoding); if( $str ) { return $str; } else { return iconv_mime_decode($text, 0, 'UTF-8'); } }

mittra

class.zmailfetch.php (cont) function getLastError() { $last_error = error_get_last(); $last_error_msg = $last_error; return $last_error_msg; } function getMimeType($struct) { $mimeType = array('TEXT', 'MULTIPART', 'MESSAGE', 'APPLICATION', 'AUDIO', 'IMAGE', 'VIDEO', 'OTHER'); if(!$struct || !$struct->subtype) return 'TEXT/PLAIN'; return $mimeType.'/'.$struct->subtype; } function getHeaderInfo($mid) { $mailmsg = $zmail_storage->getMessage($mid); if(!($headerinfo=$mailmsg->getHeader()) || !$headerinfo->from) return null; $sender=$headerinfo->from; //Just what we need... $header=array('name' =>@$sender->personal, 'email' => trim(strtolower($sender->mailbox).'@'.$sender->host), 'subject'=>@$headerinfo->subject, 'mid' => trim(@$headerinfo->message_id), 'header' => $this->getHeader($mid), 'in-reply-to' => $headerinfo->in_reply_to, 'references' => $headerinfo->references, ); if ($replyto = $headerinfo->reply_to) { $header = $replyto->mailbox.'@'.$replyto->host; $header = $replyto->personal; } //Try to determine target email - useful when fetched inbox has // aliases that are independent emails within osTicket. $emailId = 0; $tolist = array(); if($headerinfo->to) $tolist = array_merge($tolist, $headerinfo->to); if($headerinfo->cc) $tolist = array_merge($tolist, $headerinfo->cc); if($headerinfo->bcc) $tolist = array_merge($tolist, $headerinfo->bcc); foreach($tolist as $addr) if(($emailId=Email:(strtolower($addr->mailbox).'@'.$addr->host))) break; $header = $emailId; // Ensure we have a message-id. If unable to read it out of the // email, use the hash of the entire email headers if (!$header && $header) if (!($header = Mail_Parse:($header, 'message-id'))) $header = '<' . md5($header) . '@local>'; return $header; }

mittra

class.zmailfetch.php (cont) //search for specific mime type parts....encoding is the desired encoding. function getPart($mid, $mimeType, $encoding=false, $struct=null, $partNumber=false) { $mailmsg = $zmail_storage->getMessage($mid); if(!$struct && $mid) $struct = @[deleted]($mailmsg); //Match the mime type. if($struct && strcasecmp($mimeType, $this->getMimeType($struct))==0 && (!$struct->ifdparameters || !$this->findFilename($struct->dparameters))) { $partNumber=$partNumber?$partNumber; if($text = $mailmsg->getPart($partNumber)) { if($struct->encoding==3 or $struct->encoding==4) //base64 and qp decode. $text=$this->decode($text, $struct->encoding); $charset=null; if ($encoding) { //Convert text to desired mime encoding... if ($struct->ifparameters && $struct->parameters) { foreach ($struct->parameters as $p) { if (!strcasecmp($p->attribute, 'charset')) { $charset = trim($p->value); break; } } } $text = $this->mime_encode($text, $charset, $encoding); } return $text; } } //Do recursive search $text=''; if($struct && $struct->parts) { while(list($i, $substruct) = each($struct->parts)) { if($partNumber) $prefix = $partNumber . '.'; if(($result=$this->getPart($mid, $mimeType, $encoding, $substruct, $prefix.($i+1)))) $text.=$result; } } return $text; }

mittra

class.zmailfetch.php (cont) /** * Searches the attribute list for a possible filename attribute. If * found, the attribute value is returned. If the attribute uses rfc5987 * to encode the attribute value, the value is returned properly decoded * if possible * * Attribute Search Preference: * filename * filename* * name * name* */ function findFilename($attributes) { foreach (array('filename', 'name') as $pref) { foreach ($attributes as $a) { if (strtolower($a->attribute) == $pref) return $a->value; // Allow the RFC5987 specification of the filename elseif (strtolower($a->attribute) == $pref.'*') return Format:($a->value); } } return false; }

mittra

class.zmailfetch.php (cont) /* getAttachments search and return a hashtable of attachments.... NOTE: We're not actually fetching the body of the attachment - we'll do it on demand to save some memory. */ function getAttachments($part, $index=0) { if($part && !$part->parts) { //Check if the part is an attachment. $filename = false; if ($part->ifdisposition && $part->ifdparameters && in_array(strtolower($part->disposition), array('attachment', 'inline'))) { $filename = $this->findFilename($part->dparameters); } // Inline attachments without disposition. if (!$filename && $part->ifparameters && $part->parameters && $part->type > 0) { $filename = $this->findFilename($part->parameters); } if ($content_id = ($part->ifid)) rtrim(ltrim($part->id, '<'), '>'); else false; if($filename) { return array( array( 'name' => $this->mime_decode($filename), 'type' => $this->getMimeType($part), 'encoding' => $part->encoding, 'index' => ($index?$index), 'cid' => $content_id, ) ); } } //Recursive attachment search! $attachments = array(); if($part && $part->parts) { foreach($part->parts as $k=>$struct) { if($index) $prefix = $index.'.'; $attachments = array_merge($attachments, $this->getAttachments($struct, $prefix.($k+1))); } } return $attachments; }

mittra

class.zmailfetch.php (cont) function getHeader($mid) { $mailmsg = $zmail_storage->getMessage($mid); return $mailmsg->getHeader(); } function getPriority($mid) { return Mail_Parse:($this->getHeader($mid)); } function getBody($mid) { global $cfg; if ($cfg->isHtmlThreadEnabled()) { if ($body=$this->getPart($mid, 'text/html', $this->charset)) { //Cleanup the html. $body = (trim($body, " <>br/\t\n\r")) ? Format:($body) : '--'; } elseif ($body=$this->getPart($mid, 'text/plain', $this->charset)) { $body = trim($body) ? sprintf('<pre>%s</pre>', Format:($body)) : '--'; } } else { if (!($body=$this->getPart($mid, 'text/plain', $this->charset))) { if ($body=$this->getPart($mid, 'text/html', $this->charset)) { $body = Format:(Format:($body), 100, false); } } $body = trim($body) ? $body : '--'; } return $body; }

mittra

class.zmailfetch.php (cont) function createTicket($mid) { global $ost; if(!($mailinfo = $this->getHeaderInfo($mid))) return false; //Is the email address banned? if($mailinfo && TicketFilter:($mailinfo)) { //We need to let admin know... $ost->logWarning('Ticket denied', 'Banned email - '.$mailinfo, false); return true; //Report success (moved or delete) } $vars = $mailinfo; $vars=$this->mime_decode($mailinfo); $vars=$mailinfo?$this->mime_decode($mailinfo):''; $vars=Format:($this->getBody($mid)); $vars=$mailinfo?$mailinfo:$this->getEmailId(); //Missing FROM name - use email address. if(!$vars) $vars = $vars; //An email with just attachments can have empty body. if(!$vars) $vars = '-'; if($ost->getConfig()->useEmailPriority()) $vars=$this->getPriority($mid); $ticket=null; $newticket=true; $errors=array(); $seen = false; // Fetch attachments if any. $mailmsg = $zmail_storage->getMessage($mid); if($ost->getConfig()->allowEmailAttachments() && ($struct = @[deleted]($mailmsg)) && ($attachments=$this->getAttachments($struct))) { $vars = array(); foreach($attachments as $a ) { $file = array('name' => $a, 'type' => $a); //Check the file type if(!$ost->isFileTypeAllowed($file)) { $file = 'Invalid file type (ext) for '.Format:($file); } else { // only fetch the body if necessary $self = $this; $file = function() use ($self, $mid, $a) { return $self->decode($mailmsg->getPart($a), $a); }; } // Include the Content-Id if specified (for inline images) $file = isset($a) ? $a : false; $vars = $file; } }

mittra

class.zmailfetch.php (cont) $seen = false; if (($thread = ThreadEntry:($vars, $seen)) && ($message = $thread->postEmail($vars))) { if (!$message instanceof ThreadEntry) // Email has been processed previously return $message; $ticket = $message->getTicket(); } elseif ($seen) { // Already processed, but for some reason (like rejection), no // thread item was created. Ignore the email return true; } elseif (($ticket=Ticket:($vars, $errors, 'Email'))) { $message = $ticket->getLastMessage(); } else { //Report success if the email was absolutely rejected. if(isset($errors) && $errors == 403) { // Never process this email again! ThreadEntry:(0, $vars); return true; } # check if it's a bounce! if($vars && TicketFilter:($vars)) { $ost->logWarning('Bounced email', $vars, false); return true; } //TODO: Log error.. return null; } return $ticket; }

mittra

class.zmailfetch.php (cont) function fetchEmails() { if(!$zmail_open) $this->open(); $archiveFolder = $this->getArchiveFolder(); $delete = $this->canDeleteEmails(); $max = $this->getMaxFetch(); if (strcasecmp($zmail_config,'Imap')){ $zmail_storage = new Zend\Mail\Storage\Imap($this->getHost(), $this->getPort(), $this->getEncryption(), $this->getUsername(), $this->getPassword() ); } else { $zmail_storage = new Zend\Mail\Storage\Pop3($this->getHost(), $this->getPort(), $this->getEncryption(), $this->getUsername(), $this->getPassword() ); } $nummsgs = $zmail_storage->countMessages(); $msgs = $errors = 0; for($i = $nummsgs; $i > 0; $i--) { //process messages in reverse. if($this->createTicket($i)) { $ui = $zmail_storage->getUniqueId($i); $zmail_storage->setFlags($ui, Zend\Mail\Storage:); //IMAP only?? if((!$archiveFolder || !$zmail_storage->moveMessage($ui,$archiveFolder)) && $delete) $zmail_storage->removeMessage($ui); $msgs++; $errors=0; //We are only interested in consecutive errors. } else { $errors++; } if($max && ($msgs>=$max || $errors>($max*0.8))) break; }

mittra

class.zmailfetch.php (cont) //Warn on excessive errors if($errors>$msgs) { $warn=sprintf('Excessive errors processing emails for %s/%s. Please manually check the inbox.', $this->getHost(), $this->getUsername()); $this->log($warn); } return $msgs; } function log($error) { global $ost; $ost->logWarning('Mail Fetcher', $error); }

mittra

class.zmailfetch.php (cont) function run() { global $ost; if(!$ost->getConfig()->isEmailPollingEnabled()) return; //We require ZendMail to fetch emails via IMAP/POP3 //We check here just in case the ZendFramework gets moved post email config... if(!class_exists('Zend\Mail\Storage')) { $msg='osTicket requires Zend Class \"Zend\\Mail\\Storage\" for IMAP/POP3 email fetch to work!'; $ost->logWarning('Mail Fetch Error', $msg); return; } //Hardcoded error control... $MAXERRORS = 5; //Max errors before we start delayed fetch attempts $TIMEOUT = 10; //Timeout in minutes after max errors is reached. $sql=' SELECT email_id, mail_errors FROM '.EMAIL_TABLE .' WHERE mail_active=1 ' .' AND (mail_errors<='.$MAXERRORS.' OR (TIME_TO_SEC(TIMEDIFF(NOW(), mail_lasterror))>'.($TIMEOUT*60).') )' .' AND (mail_lastfetch IS NULL OR TIME_TO_SEC(TIMEDIFF(NOW(), mail_lastfetch))>mail_fetchfreq*60)' .' ORDER BY mail_lastfetch DESC' .' LIMIT 10'; //Processing up to 10 emails at a time. if(!($res=db_query($sql)) || !db_num_rows($res)) return; /* Failed query (get's logged) or nothing to do... */ while(list($emailId, $errors)=db_fetch_row($res)) { $fetcher = new MailFetcher($emailId); if($fetcher->connect()) { db_query('UPDATE '.EMAIL_TABLE.' SET mail_errors=0, mail_lastfetch=NOW() WHERE email_id='.db_input($emailId)); $fetcher->fetchEmails(); $fetcher->close(); } else { db_query('UPDATE '.EMAIL_TABLE.' SET mail_errors=mail_errors+1, mail_lasterror=NOW() WHERE email_id='.db_input($emailId)); if(++$errors>=$MAXERRORS) { //We've reached the MAX consecutive errors...will attempt logins at delayed intervals $msg="\nosTicket is having trouble fetching emails from the following mail account: \n". "\nUser: ".$fetcher->getUsername(). "\nHost: ".$fetcher->getHost(). "\nError: ".$fetcher->getLastError(). "\n\n ".$errors.' consecutive errors. Maximum of '.$MAXERRORS. ' allowed'. "\n\n This could be connection issues related to the mail server. Next delayed login attempt in approx. $TIMEOUT minutes"; $ost->alertAdmin('Mail Fetch Failure Alert', $msg, true); } } } //end while. } } //end Class MailFetcher?>

mittra

Well that was a huge PITA. :) Like I said, I think the problem is I'm not passing the login credentials correctly between the scripts and across the functions. I would be hugely appreciative if I had a road map through the scripts explaining what each does in what order and how/what gets passed along each time. Thanks!

« Previous Page