/**
* Route all mail kinds: emails, notes, drafts (in that order) processing "To:" and "Cc:" headers
*
* @param string &$full_message
* @return array|bool
*/
public static function route(&$full_message)
{
$structure = Mime_Helper::decode($full_message, false, true);
$addresses = array();
if (isset($structure->headers['to'])) {
$addresses[] = $structure->headers['to'];
}
if (isset($structure->headers['cc'])) {
$addresses[] = $structure->headers['cc'];
}
// free memory
unset($structure);
$types = array('email', 'note', 'draft');
foreach ($addresses as $address) {
foreach ($types as $type) {
if (Routing::getMatchingIssueIDs($address, $type) === false) {
continue;
}
$method = "route_{$type}s";
$return = Routing::$method($full_message);
if ($return === true || is_array($return)) {
return $return;
}
}
}
// did not handle anything
return false;
}
/**
* Method used to get the information about a specific message
* from a given mailbox.
*
* XXX this function does more than that.
*
* @param resource $mbox The mailbox
* @param array $info The support email account information
* @param integer $num The index of the message
* @return void
*/
public static function getEmailInfo($mbox, $info, $num)
{
Auth::createFakeCookie(APP_SYSTEM_USER_ID);
// check if the current message was already seen
if ($info['ema_get_only_new']) {
list($overview) = @imap_fetch_overview($mbox, $num);
if ($overview->seen || $overview->deleted || $overview->answered) {
return;
}
}
$email = @imap_headerinfo($mbox, $num);
$headers = imap_fetchheader($mbox, $num);
$body = imap_body($mbox, $num);
// check for mysterious blank messages
if (empty($body) and empty($headers)) {
// XXX do some error reporting?
return;
}
$message_id = Mail_Helper::getMessageID($headers, $body);
$message = $headers . $body;
// we don't need $body anymore -- free memory
unset($body);
// if message_id already exists, return immediately -- nothing to do
if (self::exists($message_id) || Note::exists($message_id)) {
return;
}
$structure = Mime_Helper::decode($message, true, true);
$message_body = $structure->body;
if (Mime_Helper::hasAttachments($structure)) {
$has_attachments = 1;
} else {
$has_attachments = 0;
}
// pass in $email by reference so it can be modified
$workflow = Workflow::preEmailDownload($info['ema_prj_id'], $info, $mbox, $num, $message, $email, $structure);
if ($workflow === -1) {
return;
}
// route emails if necessary
if ($info['ema_use_routing'] == 1) {
$setup = Setup::load();
// we create addresses array so it can be reused
$addresses = array();
if (isset($email->to)) {
foreach ($email->to as $address) {
$addresses[] = $address->mailbox . '@' . $address->host;
}
}
if (isset($email->cc)) {
foreach ($email->cc as $address) {
$addresses[] = $address->mailbox . '@' . $address->host;
}
}
if (@$setup['email_routing']['status'] == 'enabled') {
$res = Routing::getMatchingIssueIDs($addresses, 'email');
if ($res != false) {
$return = Routing::route_emails($message);
if ($return === true) {
self::deleteMessage($info, $mbox, $num);
return;
}
// TODO: handle errors?
return;
}
}
if (@$setup['note_routing']['status'] == 'enabled') {
$res = Routing::getMatchingIssueIDs($addresses, 'note');
if ($res != false) {
$return = Routing::route_notes($message);
// if leave copy of emails on IMAP server is off we can
// bounce on note that user had no permission to write
// here.
// otherwise proper would be to create table -
// eventum_bounce: bon_id, bon_message_id, bon_error
if ($info['ema_leave_copy']) {
if ($return === true) {
self::deleteMessage($info, $mbox, $num);
}
} else {
if ($return !== true) {
// in case of error, create bounce, but still
// delete email not to send bounce in next process :)
self::bounceMessage($email, $return);
}
self::deleteMessage($info, $mbox, $num);
}
return;
}
}
if (@$setup['draft_routing']['status'] == 'enabled') {
$res = Routing::getMatchingIssueIDs($addresses, 'draft');
if ($res != false) {
$return = Routing::route_drafts($message);
// if leave copy of emails on IMAP server is off we can
// bounce on note that user had no permission to write
// here.
// otherwise proper would be to create table -
// eventum_bounce: bon_id, bon_message_id, bon_error
if ($info['ema_leave_copy']) {
if ($return === true) {
self::deleteMessage($info, $mbox, $num);
}
} else {
if ($return !== true) {
// in case of error, create bounce, but still
// delete email not to send bounce in next process :)
self::bounceMessage($email, $return);
}
self::deleteMessage($info, $mbox, $num);
}
return;
}
}
// TODO:
// disabling return here allows routing and issue auto creating from same account
// but it will download email store it in database and do nothing
// with it if it does not match support@ address.
//return;
}
$sender_email = Mail_Helper::getEmailAddress($email->fromaddress);
if (Misc::isError($sender_email)) {
$sender_email = 'Error Parsing Email <>';
}
$t = array('ema_id' => $info['ema_id'], 'message_id' => $message_id, 'date' => Date_Helper::convertDateGMTByTS($email->udate), 'from' => $sender_email, 'to' => @$email->toaddress, 'cc' => @$email->ccaddress, 'subject' => @$structure->headers['subject'], 'body' => @$message_body, 'full_email' => @$message, 'has_attachment' => $has_attachments, 'headers' => @$structure->headers);
$subject = Mime_Helper::decodeQuotedPrintable(@$structure->headers['subject']);
$should_create_array = self::createIssueFromEmail($info, $headers, $message_body, $t['date'], $sender_email, $subject, $t['to'], $t['cc']);
$should_create_issue = $should_create_array['should_create_issue'];
if (!empty($should_create_array['issue_id'])) {
$t['issue_id'] = $should_create_array['issue_id'];
// figure out if we should change to a different email account
$iss_prj_id = Issue::getProjectID($t['issue_id']);
if ($info['ema_prj_id'] != $iss_prj_id) {
$new_ema_id = Email_Account::getEmailAccount($iss_prj_id);
if (!empty($new_ema_id)) {
$t['ema_id'] = $new_ema_id;
}
}
}
if (!empty($should_create_array['customer_id'])) {
$t['customer_id'] = $should_create_array['customer_id'];
}
if (empty($t['issue_id'])) {
$t['issue_id'] = 0;
} else {
$prj_id = Issue::getProjectID($t['issue_id']);
Auth::createFakeCookie(APP_SYSTEM_USER_ID, $prj_id);
}
if ($should_create_array['type'] == 'note') {
// assume that this is not a valid note
$res = -1;
if ($t['issue_id'] != 0) {
// check if this is valid user
$usr_id = User::getUserIDByEmail($sender_email);
if (!empty($usr_id)) {
$role_id = User::getRoleByUser($usr_id, $prj_id);
if ($role_id > User::getRoleID('Customer')) {
// actually a valid user so insert the note
Auth::createFakeCookie($usr_id, $prj_id);
$users = Project::getUserEmailAssocList($prj_id, 'active', User::getRoleID('Customer'));
$user_emails = array_map(function ($s) {
return strtolower($s);
}, array_values($users));
$users = array_flip($users);
$addresses = array();
$to_addresses = Mail_Helper::getEmailAddresses(@$structure->headers['to']);
if (count($to_addresses)) {
$addresses = $to_addresses;
}
$cc_addresses = Mail_Helper::getEmailAddresses(@$structure->headers['cc']);
if (count($cc_addresses)) {
$addresses = array_merge($addresses, $cc_addresses);
}
$cc_users = array();
foreach ($addresses as $email) {
if (in_array(strtolower($email), $user_emails)) {
$cc_users[] = $users[strtolower($email)];
}
}
// XXX FIXME, this is not nice thing to do
$_POST = array('title' => Mail_Helper::removeExcessRe($t['subject']), 'note' => $t['body'], 'note_cc' => $cc_users, 'add_extra_recipients' => 'yes', 'message_id' => $t['message_id'], 'parent_id' => $should_create_array['parent_id']);
$res = Note::insertFromPost($usr_id, $t['issue_id']);
// need to handle attachments coming from notes as well
if ($res != -1) {
Support::extractAttachments($t['issue_id'], $structure, true, $res);
}
}
}
}
} else {
// check if we need to block this email
if ($should_create_issue == true || !self::blockEmailIfNeeded($t)) {
if (!empty($t['issue_id'])) {
list($t['full_email'], $t['headers']) = Mail_Helper::rewriteThreadingHeaders($t['issue_id'], $t['full_email'], $t['headers'], 'email');
}
// make variable available for workflow to be able to detect whether this email created new issue
$t['should_create_issue'] = $should_create_array['should_create_issue'];
$res = self::insertEmail($t, $structure, $sup_id);
if ($res != -1) {
// only extract the attachments from the email if we are associating the email to an issue
if (!empty($t['issue_id'])) {
self::extractAttachments($t['issue_id'], $structure);
// notifications about new emails are always external
$internal_only = false;
$assignee_only = false;
// special case when emails are bounced back, so we don't want a notification to customers about those
if (Notification::isBounceMessage($sender_email)) {
// broadcast this email only to the assignees for this issue
$internal_only = true;
$assignee_only = true;
} elseif ($should_create_issue == true) {
// if a new issue was created, only send a copy of the email to the assignee (if any), don't resend to the original TO/CC list
$assignee_only = true;
$internal_only = true;
}
if (Workflow::shouldAutoAddToNotificationList($info['ema_prj_id'])) {
self::addExtraRecipientsToNotificationList($info['ema_prj_id'], $t, $should_create_issue);
}
if (self::isAllowedToEmail($t['issue_id'], $sender_email)) {
Notification::notifyNewEmail(Auth::getUserID(), $t['issue_id'], $t, $internal_only, $assignee_only, '', $sup_id);
}
// try to get usr_id of sender, if not, use system account
$addr = Mail_Helper::getEmailAddress($structure->headers['from']);
if (Misc::isError($addr)) {
// XXX should we log or is this expected?
Error_Handler::logError(array($addr->getMessage() . " addr: {$addr}", $addr->getDebugInfo()), __FILE__, __LINE__);
$usr_id = APP_SYSTEM_USER_ID;
} else {
$usr_id = User::getUserIDByEmail($addr);
if (!$usr_id) {
$usr_id = APP_SYSTEM_USER_ID;
}
}
// mark this issue as updated
if (!empty($t['customer_id']) && $t['customer_id'] != 'NULL' && (empty($usr_id) || User::getRoleByUser($usr_id, $prj_id) == User::getRoleID('Customer'))) {
Issue::markAsUpdated($t['issue_id'], 'customer action');
} else {
if (!empty($usr_id) && User::getRoleByUser($usr_id, $prj_id) > User::getRoleID('Customer')) {
Issue::markAsUpdated($t['issue_id'], 'staff response');
} else {
Issue::markAsUpdated($t['issue_id'], 'user response');
}
}
// log routed email
History::add($t['issue_id'], $usr_id, 'email_routed', 'Email routed from {from}', array('from' => $structure->headers['from']));
}
}
} else {
$res = 1;
}
}
if ($res > 0) {
// need to delete the message from the server?
if (!$info['ema_leave_copy']) {
@imap_delete($mbox, $num);
} else {
// mark the message as already read
@imap_setflag_full($mbox, $num, '\\Seen');
}
}
}
