archive/salesagility_SuiteCRM
0
0
Fork 0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2024-11-21 23:47:57 +00:00
Code Issues Projects Releases Wiki Activity
master
salesagility_SuiteCRM/modules/InboundEmail/InboundEmail.php

8745 lines
316 KiB
PHP
Executable File
Raw Permalink Blame History

<?php
/**
*
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2019 SalesAgility Ltd.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
if (!defined('sugarEntry') || !sugarEntry) {
die('Not A Valid Entry Point');
}
use ZBateson\MailMimeParser\MailMimeParser;
require_once __DIR__ . '/../../include/Imap/ImapHandlerFactory.php';
require_once __DIR__ . '/../../include/OutboundEmail/OutboundEmail.php';
require_once __DIR__ . '/../../modules/InboundEmail/Overview.php';
require_once __DIR__ . '/../../modules/InboundEmail/temp.php';
#[\AllowDynamicProperties]
class InboundEmail extends SugarBean
{
// Module specific
public $conn;
public $purifier;
public $email;
public $id;
public $deleted;
public $date_entered;
public $date_modified;
public $modified_user_id;
public $created_by;
public $created_by_name;
public $modified_by_name;
public $name;
public $status;
public $server_url;
public $email_user;
public $email_password;
public $port;
public $service;
public $mailbox;
public $mailboxarray;
public $delete_seen;
public $mailbox_type;
public $template_id;
public $stored_options;
public $email_body_filtering;
public $group_id;
public $is_personal;
public $groupfolder_id;
// Email 2.0
public $pop3socket;
public $outboundInstance;
public $autoImport;
public $iconFlagged = 'F';
public $iconDraft = 'D';
public $iconAnswered = 'A';
public $iconDeleted = 'del';
public $isAutoImport = false;
public $smarty;
public $attachmentCount = 0;
public $tempAttachment = [];
public $unsafeChars = ['&', '!', "'", '"', '\\', '/', '<', '>', '|', '$',];
public $currentCache;
public $defaultSort = 'date';
public $defaultDirection = 'DESC';
public $hrSort = [
0 => 'flagged',
1 => 'status',
2 => 'from',
3 => 'subj',
4 => 'date',
];
public $hrSortLocal = [
'flagged' => 'flagged',
'status' => 'answered',
'from' => 'fromaddr',
'subject' => 'subject',
'date' => 'senddate',
];
public $transferEncoding = [
0 => '7BIT',
1 => '8BIT',
2 => 'BINARY',
3 => 'BASE64',
4 => 'QUOTED-PRINTABLE',
5 => 'OTHER'
];
// concatenation of messageID and deliveredToEmail
public $compoundMessageId;
public $serverConnectString;
public $disable_row_level_security = true;
public $InboundEmailCachePath;
public $EmailCachePath;
public $InboundEmailCacheFile = 'InboundEmail.cache.php';
public $object_name = 'InboundEmail';
public $module_dir = 'InboundEmail';
public $table_name = 'inbound_email';
public $new_schema = true;
public $process_save_dates = true;
public $order_by;
public $dbManager;
public $field_defs;
public $column_fields;
public $required_fields = [
'name' => 'name',
'server_url' => 'server_url',
'mailbox' => 'mailbox',
'user' => 'user',
'port' => 'port',
];
public $imageTypes = ['JPG', 'JPEG', 'GIF', 'PNG'];
public $inlineImages = [];
public $defaultEmailNumAutoreplies24Hours = 10;
public $maxEmailNumAutoreplies24Hours = 10;
// Custom ListView attributes
public $mailbox_type_name;
public $global_personal_string;
// Service attributes
public $tls;
public $ca;
public $ssl;
public $protocol;
public $keyForUsersDefaultIEAccount = 'defaultIEAccount';
// Prefix to use when importing inline images in emails
public $imagePrefix;
public $job_name = 'function::pollMonitoredInboxes';
/**
*
* @var ImapHandlerInterface
*/
protected $imap;
/**
* @var MailMimeParser
*/
private $mailParser;
/**
* @var Overview
*/
private $overview;
/**
* @var string|null
*/
public $from_addr;
/**
* @var string|null
*/
public $from_name;
/**
* @var string|null
*/
public $reply_to_name;
/**
* @var string|null
*/
public $reply_to_addr;
/**
* @var string|null
*/
public $only_since;
/**
* @var string|null
*/
public $filter_domain;
/**
* @var string|null
*/
public $trashFolder;
/**
* @var string|null
*/
public $sentFolder;
/**
* @var string|null
*/
public $distrib_method;
/**
* @var string|null
*/
public $distribution_user_id;
/**
* @var string|null
*/
public $distribution_options;
/**
* @var string|null
*/
public $create_case_template_id;
/**
* @var int|null
*/
public $email_num_autoreplies_24_hours;
/**
* @var bool|null
*/
public $is_auto_import;
/**
* @var bool|null
*/
public $is_create_case;
/**
* @var bool|string|null
*/
public $allow_outbound_group_usage;
/**
* @var string|null
*/
public $outbound_email_id;
/**
* @var bool|string|null
*/
public $leave_messages_on_mail_server;
/**
* @var string|null
*/
public $type;
/**
* @var int|null
*/
public $is_default;
/**
* @var string|null
*/
public $external_oauth_connection_id;
/**
* @var string|null
*/
public $auth_type;
/**
* @var string|null
*/
public $connection_string;
/**
* @var bool|null
*/
public $move_messages_to_trash_after_import;
/**
* Email constructor
* @param ImapHandlerInterface|null $imapHandler
* @param MailMimeParser|null $mailParser
* @throws ImapHandlerException
*/
public function __construct(ImapHandlerInterface $imapHandler = null, MailMimeParser $mailParser = null)
{
global $sugar_config;
if (null === $mailParser) {
$mailParser = new MailMimeParser();
}
$this->mailParser = $mailParser;
if (!empty($imapHandler)) {
$this->imap = $imapHandler;
}
$this->InboundEmailCachePath = sugar_cached('modules/InboundEmail');
$this->EmailCachePath = sugar_cached('modules/Emails');
parent::__construct();
$this->smarty = new Sugar_Smarty();
$this->overview = new Overview();
if (isset($sugar_config['site_url'])) {
$this->imagePrefix = $sugar_config['site_url'] . '/cache/images/';
}
}
/**
*
* @param ImapHandlerInterface|null $imap
* @return ImapHandlerInterface
* @throws ImapHandlerException
*/
public function getImap(ImapHandlerInterface $imap = null)
{
if (null === $this->imap) {
if (null === $imap) {
$imapFactory = new ImapHandlerFactory();
$handlerType = $this->getImapHandlerType();
$imap = $imapFactory->getImapHandler(null, $handlerType);
if ($imap->isAvailable()) {
/*
* 1: Open
* 2: Read
* 3: Write
* 4: Close
*/
$imap->setTimeout(1, 5);
$imap->setTimeout(2, 5);
$imap->setTimeout(3, 5);
}
}
$this->imap = $imap;
}
return $this->imap;
}
/**
* retrieves I-E bean
* @param int $id
* @param bool $encode
* @param bool $deleted
* @return object Bean
*/
public function retrieve($id = -1, $encode = true, $deleted = true)
{
$ret = parent::retrieve($id, $encode, $deleted);
// If I-E bean exist
if ($ret !== null) {
$this->email_password = blowfishDecode(blowfishGetKey('InboundEmail'), $this->email_password);
$this->retrieveMailBoxFolders();
}
if (!empty($ret) && !$this->hasAccessToPersonalAccount()) {
$this->logPersonalAccountAccessDenied('retrieve');
return null;
}
return $ret;
}
/**
* wraps SugarBean->save()
* @param string ID of saved bean
*/
public function save($check_notify = false)
{
if (!$this->hasAccessToPersonalAccount()) {
$this->logPersonalAccountAccessDenied('save');
throw new RuntimeException('Access Denied');
}
$this->clearAuthTypeDependantFields();
$this->keepWriteOnlyFieldValues();
// generate cache table for email 2.0
$multiDImArray = $this->generateMultiDimArrayFromFlatArray(
explode(",", $this->mailbox),
$this->retrieveDelimiter()
);
$raw = $this->generateFlatArrayFromMultiDimArray($multiDImArray, $this->retrieveDelimiter());
sort($raw);
$raw = $this->filterMailBoxFromRaw(explode(",", $this->mailbox), $raw);
$this->mailbox = implode(',', $raw);
if (!empty($this->email_password)) {
$this->email_password = blowfishEncode(blowfishGetKey('InboundEmail'), $this->email_password);
}
$ret = parent::save($check_notify);
return $ret;
}
/**
* Check if user has access to personal account
* @return bool
*/
public function hasAccessToPersonalAccount() : bool {
global $current_user;
if (is_admin($current_user)) {
return true;
}
if (!isTrue($this->is_personal ?? false)) {
return true;
}
if (empty($this->created_by)) {
return true;
}
if($this->created_by === $current_user->id) {
return true;
}
return false;
}
/**
* Log personal account access denied
* @param string $action
* @return void
*/
public function logPersonalAccountAccessDenied(string $action) : void {
global $log, $current_user;
$log->fatal("InboundEmail | Access denied. Non-admin user trying to access personal account. Action: '" . $action . "' | Current user id: '" . $current_user->id . "' | record: '" . $this->id . "'" );
}
/**
* @inheritDoc
*/
public function ACLAccess($view, $is_owner = 'not_set', $in_group = 'not_set')
{
global $current_user;
$isNotAllowAction = $this->isNotAllowedAction($view);
if ($isNotAllowAction === true) {
return false;
}
if (!$this->hasAccessToPersonalAccount()) {
$this->logPersonalAccountAccessDenied("ACLAccess-$view");
return false;
}
$isPersonal = isTrue($this->is_personal);
$isAdmin = is_admin($current_user);
if ($isPersonal === true && $this->hasAccessToPersonalAccount()) {
return true;
}
$isAdminOnlyAction = $this->isAdminOnlyAction($view);
if (!$isPersonal && !$isAdmin && $isAdminOnlyAction === true) {
return false;
}
$hasActionAclsDefined = has_group_action_acls_defined('InboundEmail', 'view');
$isSecurityGroupBasedAction = $this->isSecurityGroupBasedAction($view);
if (!$isPersonal && !$isAdmin && !$hasActionAclsDefined && $isSecurityGroupBasedAction === true) {
return false;
}
return parent::ACLAccess($view, $is_owner, $in_group);
}
/**
* @return void
*/
protected function keepWriteOnlyFieldValues(): void
{
if (empty($this->fetched_row)) {
return;
}
foreach ($this->field_defs as $field => $field_def) {
if (empty($field_def['display']) || $field_def['display'] !== 'writeonly') {
continue;
}
if (empty($this->fetched_row[$field])) {
continue;
}
if (!empty($this->$field)) {
continue;
}
$this->$field = $this->fetched_row[$field];
}
}
/**
* @return void
*/
protected function clearAuthTypeDependantFields(): void
{
if (empty($this->auth_type)) {
return;
}
if ($this->auth_type === 'basic') {
$this->external_oauth_connection_id = '';
}
if ($this->auth_type === 'oauth') {
$this->email_password = '';
}
}
public function filterMailBoxFromRaw($mailboxArray, $rawArray)
{
$newArray = array_intersect($mailboxArray, $rawArray);
sort($newArray);
return $newArray;
} // fn
/**
* Overrides SugarBean's mark_deleted() to drop the related cache table
* @param string $id GUID of I-E instance
*/
public function mark_deleted($id)
{
parent::mark_deleted($id);
//bug52021 we need to keep the reference to the folders table in order for emails module to function properly
$this->deleteCache();
}
/**
* Mark cached email answered (replied)
* @param string $mailid (uid for imap, message_id for pop3)
*/
public function mark_answered($mailid, $type = 'smtp')
{
switch ($type) {
case 'smtp':
$q = "update email_cache set answered = 1 WHERE imap_uid = $mailid and ie_id = '{$this->id}'";
$this->db->query($q);
break;
case 'pop3':
$q = "update email_cache set answered = 1 WHERE message_id = '$mailid' and ie_id = '{$this->id}'";
$this->db->query($q);
break;
}
}
/**
* Renames an IMAP mailbox
* @param string $newName
*/
public function renameFolder($oldName, $newName)
{
//$this->mailbox = "INBOX"
$this->connectMailserver();
$oldConnect = $this->getConnectString('', $oldName);
$newConnect = $this->getConnectString('', $newName);
$errorLevelStored = error_reporting();
error_reporting(0);
$imapRenameMailbox = $this->getImap()->renameMailbox($oldConnect, $newConnect);
error_reporting($errorLevelStored);
if (!$imapRenameMailbox) {
$GLOBALS['log']->debug("***INBOUNDEMAIL: failed to rename mailbox [ {$oldConnect} ] to [ {$newConnect} ]");
} else {
$this->mailbox = str_replace($oldName, $newName, (string) $this->mailbox);
$this->save();
$sessionFoldersString = $this->getSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol
);
$sessionFoldersString = str_replace($oldName, $newName, (string) $sessionFoldersString);
$this->setSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
$sessionFoldersString
);
}
return $imapRenameMailbox;
}
/**
* @return bool
*/
public function isPersonalEmailAccount()
{
return (bool)$this->is_personal;
}
/**
* @return bool
*/
public function isGroupEmailAccount()
{
return !$this->isPersonalEmailAccount();
}
/**
* @param int $offset
* @param int $pageSize
* @param array $order
* @param array $filter
* @return array
*/
public function checkWithPagination(
$offset = 0,
$pageSize = 20,
$order = array(),
$filter = array(),
$columns = array()
) {
--$pageSize;
$mailboxInfo = array('Nmsgs' => 0);
if ($this->connectMailserver() !== 'true') {
LoggerManager::getLogger()->error('Unable to connect to IMAP server.');
return false;
}
[$sortCriteria, $sortCRM, $sortOrder] = $this->getSortCriteria($order);
$filterCriteria = $this->getFilterCriteria($filter);
$emailHeaders = $this->getImap()->getMessageList(
$filterCriteria,
$sortCriteria,
$sortOrder,
$offset,
$pageSize,
$mailboxInfo,
$columns,
$this->auth_type
);
return array(
"data" => $emailHeaders,
"mailbox_info" => json_decode(json_encode($mailboxInfo), true),
);
}
/**
* @param $imapStructure
* @return bool
*/
public function messageStructureHasAttachment($imapStructure)
{
if(empty($imapStructure)){
return false;
}
if (($imapStructure->type !== 0) && ($imapStructure->type !== 1)) {
return true;
}
$attachments = [];
if(empty($imapStructure->parts)){
return false;
}
foreach ($imapStructure->parts as $i => $part) {
if(empty($part->dparameters)){
continue;
}
if (is_string($part->dparameters[0]->value)) {
$attachments[] = $part->dparameters[0]->value;
}
}
return !empty($attachments);
}
///////////////////////////////////////////////////////////////////////////
//// CUSTOM LOGIC HOOKS
/**
* Called from $this->getMessageText()
* Allows upgrade-safe custom processing of message text.
*
* To use:
* 1. Create a directory path: ./custom/modules/InboundEmail if it does not exist
* 2. Create a file in the ./custom/InboundEmail/ folder called "getMessageText.php"
* 3. Define a function named "custom_getMessageText()" that takes a string as an argument and returns a string
*
* @param string $msgPart
* @return string
*/
public function customGetMessageText($msgPart)
{
$custom = "custom/modules/InboundEmail/getMessageText.php";
if (file_exists($custom)) {
include_once($custom);
if (function_exists("custom_getMessageText")) {
$GLOBALS['log']->debug("*** INBOUND EMAIL-CUSTOM_LOGIC: calling custom_getMessageText()");
$msgPart = custom_getMessageText($msgPart);
}
}
return $msgPart;
}
//// END CUSTOM LOGIC HOOKS
///////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////
//// EMAIL 2.0 SPECIFIC
/**
* constructs a nicely formatted version of raw source
* @param int $uid UID of email
* @return string
*/
public function getFormattedRawSource($uid)
{
global $app_strings;
if (empty($this->id)) {
$q = "SELECT raw_source FROM emails_text WHERE email_id = '" . $this->db->quote($uid) . "'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
$ret = array();
// Protect against the database fetch failing.
if ($a === false) {
$raw = null;
} else {
$raw = $this->convertToUtf8($a['raw_source']);
}
if (empty($raw)) {
$raw = $app_strings['LBL_EMAIL_ERROR_VIEW_RAW_SOURCE'];
}
} else {
if ($this->isPop3Protocol()) {
$uid = $this->getCorrectMessageNoForPop3($uid);
}
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email connection is not a resource for getting Formatted Raw Source');
return null;
}
$raw = $this->getImap()->fetchHeader($uid, FT_UID + FT_PREFETCHTEXT);
$raw .= $this->convertToUtf8($this->getImap()->getBody($uid, FT_UID));
} // else
$raw = to_html($raw);
$raw = nl2br($raw);
//}
return $raw;
}
/**
* helper method to convert text to utf-8 if necessary
*
* @param string $input text
* @return string output text
*/
public function convertToUtf8($input)
{
$charset = $GLOBALS['locale']->detectCharset($input, true);
// we haven't a clue due to missing package?, just return as itself
if ($charset === false) {
return $input;
}
// convert if we can or must
return $this->handleCharsetTranslation($input, $charset);
}
/**
* constructs a nicely formatted version of email headers.
* @param int $uid
* @return string
*/
public function getFormattedHeaders($uid)
{
global $app_strings;
//if($this->protocol == 'pop3') {
// $header = $app_strings['LBL_EMAIL_VIEW_UNSUPPORTED'];
//} else {
if ($this->isPop3Protocol()) {
$uid = $this->getCorrectMessageNoForPop3($uid);
}
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email connection is not a resource');
return null;
}
$headers = $this->getImap()->fetchHeader($uid, FT_UID);
$lines = explode("\n", $headers);
$header = "<table cellspacing='0' cellpadding='2' border='0' width='100%'>";
foreach ($lines as $line) {
$line = trim($line);
if (!empty($line)) {
$key = trim(substr($line, 0, strpos($line, ":")));
$key = strip_tags($key);
$value = trim(substr($line, strpos($line, ":") + 1));
$value = to_html($value);
$header .= "<tr>";
$header .= "<td class='displayEmailLabel' NOWRAP><b>{$key}</b>&nbsp;</td>";
$header .= "<td class='displayEmailValueWhite'>{$value}&nbsp;</td>";
$header .= "</tr>";
}
}
$header .= "</table>";
//}
return $header;
}
/**
* Empties Trash folders
*/
public function emptyTrash()
{
global $sugar_config;
$this->mailbox = $this->get_stored_options("trashFolder");
if (empty($this->mailbox)) {
$this->mailbox = 'INBOX.Trash';
}
$this->connectMailserver();
if ($this->getImap()->isValidStream($this->conn)) {
$uids = $this->getImap()->search("ALL", SE_UID);
} else {
LoggerManager::getLogger()->warn('connection is not a valid resource to empty trush');
$uids = array();
}
foreach ($uids as $uid) {
if (!$this->getImap()->delete($uid, FT_UID)) {
$lastError = $this->getImap()->getLastError();
$GLOBALS['log']->warn("INBOUNDEMAIL: emptyTrash() Could not delete message [ {$uid} ] from [ {$this->mailbox} ]. IMAP_ERROR [ {$lastError} ]");
}
}
// remove local cache file
$q = "DELETE FROM email_cache WHERE mbox = '{$this->mailbox}' AND ie_id = '{$this->id}'";
$r = $this->db->query($q);
}
/**
* Fetches a timestamp
*/
public function getCacheTimestamp($mbox)
{
$key = $this->db->quote("{$this->id}_{$mbox}");
$q = "SELECT ie_timestamp FROM inbound_email_cache_ts WHERE id = '{$key}'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
if (empty($a)) {
return -1;
}
return $a['ie_timestamp'];
}
/**
* sets the cache timestamp
* @param string mbox
*/
public function setCacheTimestamp($mbox)
{
$key = $this->db->quote("{$this->id}_{$mbox}");
$ts = time();
$tsOld = $this->getCacheTimestamp($mbox);
if ($tsOld < 0) {
$q = "INSERT INTO inbound_email_cache_ts (id, ie_timestamp) VALUES ('{$key}', {$ts})";
} else {
$q = "UPDATE inbound_email_cache_ts SET ie_timestamp = {$ts} WHERE id = '{$key}'";
}
$r = $this->db->query($q, true);
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: setting timestamp query [ {$q} ]");
}
/**
* Gets a count of all rows that are flagged seen = 0
* @param string $mbox
* @return int
*/
public function getCacheUnreadCount($mbox)
{
$q = "SELECT count(*) c FROM email_cache WHERE mbox = '" . $this->db->quote($mbox) . "' AND seen = 0 AND ie_id = '" . $this->db->quote($this->id) . "'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
return $a['c'];
}
/**
* Returns total number of emails for a mailbox
* @param string mbox
* @return int
*/
public function getCacheCount($mbox)
{
$q = "SELECT count(*) c FROM email_cache WHERE mbox = '" . $this->db->quote($mbox) . "' AND ie_id = '" . $this->db->quote($this->id) . "'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
return $a['c'];
}
public function getCacheUnread($mbox)
{
$q = "SELECT count(*) c FROM email_cache WHERE mbox = '" . $this->db->quote($mbox) . "' AND ie_id = '" . $this->db->quote($this->id) . "' AND seen = '0'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
return $a['c'];
}
/**
* Deletes all rows for a given instance
*/
public function deleteCache()
{
$q = "DELETE FROM email_cache WHERE ie_id = '" . $this->db->quote($this->id) . "'";
$GLOBALS['log']->info("INBOUNDEMAIL: deleting cache using query [ {$q} ]");
$r = $this->db->query($q);
}
/**
* Deletes all the pop3 data which has been deleted from server
*/
public function deletePop3Cache()
{
global $sugar_config;
$UIDLs = $this->pop3_getUIDL();
$cacheUIDLs = $this->pop3_getCacheUidls();
foreach ($cacheUIDLs as $msgNo => $msgId) {
if (!in_array($msgId, $UIDLs)) {
$md5msgIds = md5($msgId);
$file = "{$this->EmailCachePath}/{$this->id}/messages/INBOX{$md5msgIds}.PHP";
$GLOBALS['log']->debug("INBOUNDEMAIL: deleting file [ {$file} ] ");
if (file_exists($file)) {
if (!unlink($file)) {
$GLOBALS['log']->debug("INBOUNDEMAIL: Could not delete [ {$file} ] ");
} // if
} // if
$q = "DELETE from email_cache where imap_uid = {$msgNo} AND msgno = {$msgNo} AND ie_id = '{$this->id}' AND message_id = '{$msgId}'";
$r = $this->db->query($q);
} // if
} // for
} // fn
/**
* Retrieves cached headers
* @return array
*/
public function getCacheValueForUIDs($mbox, $UIDs)
{
if (!is_array($UIDs) || empty($UIDs)) {
return array();
}
$q = "SELECT * FROM email_cache WHERE ie_id = '{$this->db->quote($this->id)}' AND mbox = '{$this->db->quote($mbox)}' AND ";
$startIndex = 0;
$endIndex = 5;
$slicedArray = array_slice($UIDs, $startIndex, $endIndex);
$columnName = ($this->isPop3Protocol() ? "message_id" : "imap_uid");
$ret = array(
'timestamp' => $this->getCacheTimestamp($mbox),
'uids' => array(),
'retArr' => array(),
);
while (!empty($slicedArray)) {
$messageIdString = implode(',', $slicedArray);
$GLOBALS['log']->debug("sliced array = {$messageIdString}");
$extraWhere = "{$columnName} IN (";
$i = 0;
foreach ($slicedArray as $UID) {
if ($i != 0) {
$extraWhere = $extraWhere . ",";
} // if
$i++;
$extraWhere = "{$extraWhere} '{$UID}'";
} // foreach
$newQuery = $q . $extraWhere . ")";
$r = $this->db->query($newQuery);
while ($a = $this->db->fetchByAssoc($r)) {
if (isset($a['uid'])) {
if ($this->isPop3Protocol()) {
$ret['uids'][] = $a['message_id'];
} else {
$ret['uids'][] = $a['uid'];
}
}
$overview = new Overview();
foreach ($a as $k => $v) {
$k = strtolower($k);
switch ($k) {
case "imap_uid":
$overview->imap_uid = $v;
if ($this->isPop3Protocol()) {
$overview->uid = $a['message_id'];
} else {
$overview->uid = $v;
}
break;
case "toaddr":
$overview->to = from_html($v);
break;
case "fromaddr":
$overview->from = from_html($v);
break;
case "mailsize":
$overview->size = $v;
break;
case "senddate":
$overview->date = $v;
break;
default:
$overview->$k = from_html($v);
break;
} // switch
} // foreach
$ret['retArr'][] = $overview;
} // while
$startIndex = $startIndex + $endIndex;
$slicedArray = array_slice($UIDs, $startIndex, $endIndex);
$messageIdString = implode(',', $slicedArray);
$GLOBALS['log']->debug("sliced array = {$messageIdString}");
} // while
return $ret;
}
/**
* Retrieves cached headers
* @return array
*/
public function getCacheValue($mbox, $limit = 20, $page = 1, $sort = '', $direction = '')
{
// try optimizing this call as we don't want repeat queries
if (!empty($this->currentCache)) {
return $this->currentCache;
}
$sort = (empty($sort)) ? $this->defaultSort : $sort;
if (!in_array(strtolower($direction), array('asc', 'desc'))) {
$direction = $this->defaultDirection;
}
if (!empty($this->hrSortLocal[$sort])) {
$order = " ORDER BY {$this->db->quote($this->hrSortLocal[$sort])} {$this->db->quote($direction)}";
} else {
$order = "";
}
$q = "SELECT * FROM email_cache WHERE ie_id = '{$this->db->quote($this->id)}' AND mbox = '{$this->db->quote($mbox)}' {$order}";
if (!empty($limit)) {
$start = ($page - 1) * $limit;
$r = $this->db->limitQuery($q, $start, $limit);
} else {
$r = $this->db->query($q);
}
$ret = array(
'timestamp' => $this->getCacheTimestamp($mbox),
'uids' => array(),
'retArr' => array(),
);
while ($a = $this->db->fetchByAssoc($r)) {
if (isset($a['uid'])) {
if ($this->isPop3Protocol()) {
$ret['uids'][] = $a['message_id'];
} else {
$ret['uids'][] = $a['uid'];
}
}
$overview = new Overview();
foreach ($a as $k => $v) {
$k = strtolower($k);
switch ($k) {
case "imap_uid":
$overview->imap_uid = $v;
if ($this->isPop3Protocol()) {
$overview->uid = $a['message_id'];
} else {
$overview->uid = $v;
}
break;
case "toaddr":
$overview->to = from_html($v);
break;
case "fromaddr":
$overview->from = from_html($v);
break;
case "mailsize":
$overview->size = $v;
break;
case "senddate":
$overview->date = $v;
break;
default:
$overview->$k = from_html($v);
break;
}
}
$ret['retArr'][] = $overview;
}
$this->currentCache = $ret;
return $ret;
}
/**
* Sets cache values
*/
public function setCacheValue($mbox, $insert, $update = array(), $remove = array())
{
if (empty($mbox)) {
return;
}
global $timedate;
// reset in-memory cache
$this->currentCache = null;
$table = $this->db->quote('email_cache');
$where = "WHERE ie_id = '{$this->db->quote($this->id)}' AND mbox = '{$this->db->quote($mbox)}'";
// handle removed rows
if (!empty($remove)) {
$removeIds = '';
foreach ($remove as $overview) {
if (!empty($removeIds)) {
$removeIds .= ",";
}
$removeIds .= "'{$this->db->quote($overview->imap_uid)}'";
}
$q = "DELETE FROM {$table} {$where} AND imap_uid IN ({$removeIds})";
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: delete query [ {$q} ]");
$r = $this->db->query($q, true, $q);
}
// handle insert rows
if (!empty($insert)) {
$q = "SELECT imap_uid FROM {$table} {$where}";
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: filter UIDs query [ {$q} ]");
$r = $this->db->query($q);
$uids = array();
while ($a = $this->db->fetchByAssoc($r)) {
$uids[] = $a['imap_uid'];
}
$count = count($uids);
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: found [ {$count} ] UIDs to filter against");
$tmp = '';
foreach ($uids as $uid) {
if (!empty($tmp)) {
$tmp .= ", ";
}
$tmp .= (string)($uid);
}
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: filter UIDs: [ {$tmp} ]");
$cols = "";
foreach ($this->overview->fieldDefs as $colDef) {
if (!empty($cols)) {
$cols .= ",";
}
$cols .= (string)($colDef['name']);
}
foreach ($insert as $overview) {
if (in_array($overview->imap_uid, $uids)) {
// fixing bug #49543: setting 'mbox' property for the following updating of other items in this box
if (!isset($overview->mbox)) {
$overview->mbox = $mbox;
}
$update[] = $overview;
continue;
}
$values = '';
foreach ($this->overview->fieldDefs as $colDef) {
if (!empty($values)) {
$values .= ", ";
}
$fieldName = $colDef['name'];
// trim values for Oracle/MSSql
if (isset($colDef['len']) && !empty($colDef['len']) &&
isset($colDef['type']) && !empty($colDef['type']) &&
$colDef['type'] == 'varchar'
) {
if (isset($overview->$fieldName)) {
$overview->$fieldName = substr((string) $overview->$fieldName, 0, $colDef['len']);
}
}
switch ($fieldName) {
case "imap_uid":
if (isset($overview->uid) && !empty($overview->uid)) {
$this->imap_uid = $overview->uid;
}
if (!isset($this->imap_uid)) {
LoggerManager::getLogger()->warn('Inbound email has not imap uid for setting cache value.');
$values .= "''";
} else {
$values .= "'{$this->imap_uid}'";
}
break;
case "ie_id":
$values .= "'{$this->id}'";
break;
case "toaddr":
$values .= $this->db->quoted($overview->to);
break;
case "fromaddr":
$values .= $this->db->quoted($overview->from);
break;
case "message_id":
$values .= $this->db->quoted($overview->message_id);
break;
case "mailsize":
$values .= $overview->size;
break;
case "senddate":
$conv = $timedate->fromString($overview->date);
if (!empty($conv)) {
$values .= $this->db->quoted($conv->asDb());
} else {
$values .= "NULL";
}
break;
case "mbox":
$values .= "'{$mbox}'";
break;
default:
$overview->$fieldName = SugarCleaner::cleanHtml(from_html($overview->$fieldName));
$values .= $this->db->quoted($overview->$fieldName);
break;
}
}
$q = "INSERT INTO {$table} ({$cols}) VALUES ({$values})";
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: insert query [ {$q} ]");
$r = $this->db->query($q, true, $q);
}
}
// handle update rows
if (!empty($update)) {
$cols = "";
foreach ($this->overview->fieldDefs as $colDef) {
if (!empty($cols)) {
$cols .= ",";
}
$cols .= (string)($colDef['name']);
}
foreach ($update as $overview) {
$q = "UPDATE {$table} SET ";
$set = '';
foreach ($this->overview->fieldDefs as $colDef) {
$fieldName = $colDef['name'];
switch ($fieldName) {
case "toaddr":
case "fromaddr":
case "mailsize":
case "senddate":
case "mbox":
case "ie_id":
break;
default:
if (!empty($set)) {
$set .= ",";
}
$value = '';
if (isset($overview->$fieldName)) {
$value = $this->db->quoted($overview->$fieldName);
} else {
$value = $this->db->quoted($value);
}
$set .= "{$fieldName} = " . $value;
break;
}
}
$q .= $set . " WHERE ie_id = '{$this->db->quote($this->id)}' AND mbox = '{$this->db->quote($overview->mbox)}' AND imap_uid = '{$overview->imap_uid}'";
$GLOBALS['log']->info("INBOUNDEMAIL-CACHE: update query [ {$q} ]");
$r = $this->db->query($q, true, $q);
}
}
}
/**
* Opens a socket connection to the pop3 server
* @return bool
*/
public function pop3_open()
{
if (!is_resource($this->pop3socket)) {
$GLOBALS['log']->info("*** INBOUNDEMAIL: opening socket connection");
$exServ = explode('::', $this->service);
$socket = (isset($exServ[2]) && $exServ[2] == 'ssl') ? "ssl://" : "tcp://";
$socket .= $this->server_url;
if (!$this->server_url) {
LoggerManager::getLogger()->fatal('Empty host name for pop3_open');
} else {
$this->pop3socket = fsockopen($socket, $this->port);
}
} else {
$GLOBALS['log']->info("*** INBOUNDEMAIL: REUSING socket connection");
return true;
}
if (!is_resource($this->pop3socket)) {
$GLOBALS['log']->debug("*** INBOUNDEMAIL: unable to open socket connection");
return false;
}
// clear buffer
$ret = trim(fgets($this->pop3socket, 1024));
$GLOBALS['log']->info("*** INBOUNDEMAIL: got socket connection [ {$ret} ]");
return true;
}
/**
* Closes connections and runs clean-up routines
*/
public function pop3_cleanUp()
{
$GLOBALS['log']->info("*** INBOUNDEMAIL: cleaning up socket connection");
if (!is_resource($this->pop3socket)) {
LoggerManager::getLogger()->fatal('POP 3 sould be a valid resource');
return false;
}
fwrite($this->pop3socket, "QUIT\r\n");
$buf = fgets($this->pop3socket, 1024);
fclose($this->pop3socket);
return true;
}
/**
* sends a command down to the POP3 server
* @param string command
* @param string args
* @param bool return
* @return string
*/
public function pop3_sendCommand($command, $args = '', $return = true)
{
$command .= " {$args}";
$command = trim($command);
$GLOBALS['log']->info("*** INBOUNDEMAIL: pop3_sendCommand() SEND [ {$command} ]");
$command .= "\r\n";
if (!is_resource($this->pop3socket)) {
LoggerManager::getLogger()->fatal('Invalid POP 3 Socket');
return false;
}
fwrite($this->pop3socket, $command);
if ($return) {
$ret = trim(fgets($this->pop3socket, 1024));
$GLOBALS['log']->info("*** INBOUNDEMAIL: pop3_sendCommand() RECEIVE [ {$ret} ]");
return $ret;
}
}
public function getPop3NewMessagesToDownload()
{
$pop3UIDL = $this->pop3_getUIDL();
$cacheUIDLs = $this->pop3_getCacheUidls();
// new email cache values we should deal with
$diff = array_diff_assoc($pop3UIDL, $cacheUIDLs);
// this is msgNo to UIDL array
$diff = $this->pop3_shiftCache($diff, $cacheUIDLs);
// get all the keys which are msgnos;
return array_keys($diff);
}
public function getPop3NewMessagesToDownloadForCron()
{
$pop3UIDL = $this->pop3_getUIDL();
$cacheUIDLs = $this->pop3_getCacheUidls();
// new email cache values we should deal with
$diff = array_diff_assoc($pop3UIDL, $cacheUIDLs);
// this is msgNo to UIDL array
$diff = $this->pop3_shiftCache($diff, $cacheUIDLs);
// insert data into email_cache
if ($this->groupfolder_id != null && $this->groupfolder_id != "" && $this->isPop3Protocol()) {
$searchResults = array_keys($diff);
$concatResults = implode(",", $searchResults);
if ($this->connectMailserver() == 'true') {
$fetchedOverviews = $this->getImap()->fetchOverview($concatResults);
// clean up cache entry
foreach ($fetchedOverviews as $k => $overview) {
$overview->message_id = trim($diff[$overview->msgno]);
$fetchedOverviews[$k] = $overview;
}
$this->updateOverviewCacheFile($fetchedOverviews);
}
} // if
return $diff;
}
/**
* This method returns all the UIDL for this account. This should be called if the protocol is pop3
* @return array od messageno to UIDL array
*/
public function pop3_getUIDL()
{
$UIDLs = array();
if ($this->pop3_open()) {
// authenticate
$this->pop3_sendCommand("USER", $this->email_user);
$this->pop3_sendCommand("PASS", $this->email_password);
// get UIDLs
$this->pop3_sendCommand("UIDL", '', false); // leave socket buffer alone until the while()
fgets($this->pop3socket, 1024); // handle "OK+";
$UIDLs = array();
$buf = '!';
if (is_resource($this->pop3socket)) {
while (!feof($this->pop3socket)) {
$buf = fgets(
$this->pop3socket,
1024
); // 8kb max buffer - shouldn't be more than 80 chars via pop3...
if (trim($buf) == '.') {
$GLOBALS['log']->debug("*** GOT '.'");
break;
}
// format is [msgNo] [UIDL]
$exUidl = explode(" ", $buf);
$UIDLs[$exUidl[0]] = trim($exUidl[1]);
} // while
} // if
$this->pop3_cleanUp();
} // if
return $UIDLs;
} // fn
/**
* Special handler for POP3 boxes. Standard IMAP commands are useless.
* This will fetch only partial emails for POP3 and hence needs to be call again and again based on status it returns
*/
public function pop3_checkPartialEmail($synch = false)
{
require_once('include/utils/array_utils.php');
global $current_user;
global $sugar_config;
$cacheDataExists = false;
$diff = array();
$results = array();
$cacheFilePath = clean_path("{$this->EmailCachePath}/{$this->id}/folders/MsgNOToUIDLData.php");
if (file_exists($cacheFilePath)) {
$cacheDataExists = true;
if ($fh = @fopen($cacheFilePath, "rb")) {
$data = "";
$chunksize = 1 * (1024 * 1024); // how many bytes per chunk
while (!feof($fh)) {
$buf = fgets($fh, $chunksize); // 8kb max buffer - shouldn't be more than 80 chars via pop3...
$data = $data . $buf;
flush();
} // while
fclose($fh);
$diff = unserialize($data);
if (!empty($diff)) {
if ((is_countable($diff) ? count($diff) : 0) > 50) {
$newDiff = array_slice($diff, 50, is_countable($diff) ? count($diff) : 0, true);
} else {
$newDiff = array();
}
$results = array_slice(array_keys($diff), 0, 50);
$data = serialize($newDiff);
if ($fh = @fopen($cacheFilePath, 'wb')) {
fwrite($fh, $data);
fclose($fh);
} // if
}
} // if
} // if
if (!$cacheDataExists) {
if ($synch) {
$this->deletePop3Cache();
}
$UIDLs = $this->pop3_getUIDL();
if (count($UIDLs) > 0) {
// get cached UIDLs
$cacheUIDLs = $this->pop3_getCacheUidls();
// new email cache values we should deal with
$diff = array_diff_assoc($UIDLs, $cacheUIDLs);
$diff = $this->pop3_shiftCache($diff, $cacheUIDLs);
require_once('modules/Emails/EmailUI.php');
EmailUI::preflightEmailCache("{$this->EmailCachePath}/{$this->id}");
if ((is_countable($diff) ? count($diff) : 0) > 50) {
$newDiff = array_slice($diff, 50, is_countable($diff) ? count($diff) : 0, true);
} else {
$newDiff = array();
}
$results = array_slice(array_keys($diff), 0, 50);
$data = serialize($newDiff);
if ($fh = @fopen($cacheFilePath, 'wb')) {
fwrite($fh, $data);
fclose($fh);
} // if
} else {
$GLOBALS['log']->debug("*** INBOUNDEMAIL: could not open socket connection to POP3 server");
return "could not open socket connection to POP3 server";
} // else
} // if
// build up msgNo request
if ((is_countable($diff) ? count($diff) : 0) > 0) {
// remove dirty cache entries
$startingNo = 0;
if (isset($_REQUEST['currentCount']) && $_REQUEST['currentCount'] > -1) {
$startingNo = $_REQUEST['currentCount'];
}
$this->mailbox = 'INBOX';
$this->connectMailserver();
//$searchResults = array_keys($diff);
//$fetchedOverviews = array();
//$chunkArraySerachResults = array_chunk($searchResults, 50);
$concatResults = implode(",", $results);
$GLOBALS['log']->info('$$$$ ' . $concatResults);
$GLOBALS['log']->info("[EMAIL] Start POP3 fetch overview on mailbox [{$this->mailbox}] for user [{$current_user->user_name}] on 50 data");
$fetchedOverviews = $this->getImap()->fetchOverview($concatResults);
$GLOBALS['log']->info("[EMAIL] End POP3 fetch overview on mailbox [{$this->mailbox}] for user [{$current_user->user_name}] on "
. (is_countable($fetchedOverviews) ? count($fetchedOverviews) : 0) . " data");
// clean up cache entry
foreach ($fetchedOverviews as $k => $overview) {
$overview->message_id = trim($diff[$overview->msgno]);
$fetchedOverviews[$k] = $overview;
}
$GLOBALS['log']->info("[EMAIL] Start updating overview cache for pop3 mailbox [{$this->mailbox}] for user [{$current_user->user_name}]");
$this->updateOverviewCacheFile($fetchedOverviews);
$GLOBALS['log']->info("[EMAIL] Start updating overview cache for pop3 mailbox [{$this->mailbox}] for user [{$current_user->user_name}]");
return array(
'status' => "In Progress",
'mbox' => $this->mailbox,
'count' => (count($results) + $startingNo),
'totalcount' => is_countable($diff) ? count($diff) : 0,
'ieid' => $this->id
);
} // if
unlink($cacheFilePath);
return array('status' => "done");
}
/**
* Special handler for POP3 boxes. Standard IMAP commands are useless.
*/
public function pop3_checkEmail()
{
if ($this->pop3_open()) {
// authenticate
$this->pop3_sendCommand("USER", $this->email_user);
$this->pop3_sendCommand("PASS", $this->email_password);
// get UIDLs
$this->pop3_sendCommand("UIDL", '', false); // leave socket buffer alone until the while()
fgets($this->pop3socket, 1024); // handle "OK+";
$UIDLs = array();
$buf = '!';
if (is_resource($this->pop3socket)) {
while (!feof($this->pop3socket)) {
$buf = fgets(
$this->pop3socket,
1024
); // 8kb max buffer - shouldn't be more than 80 chars via pop3...
if (trim($buf) == '.') {
$GLOBALS['log']->debug("*** GOT '.'");
break;
}
// format is [msgNo] [UIDL]
$exUidl = explode(" ", $buf);
$UIDLs[$exUidl[0]] = trim($exUidl[1]);
}
}
$this->pop3_cleanUp();
// get cached UIDLs
$cacheUIDLs = $this->pop3_getCacheUidls();
// new email cache values we should deal with
$diff = array_diff_assoc($UIDLs, $cacheUIDLs);
// remove dirty cache entries
$diff = $this->pop3_shiftCache($diff, $cacheUIDLs);
// build up msgNo request
if (!empty($diff)) {
$this->mailbox = 'INBOX';
$this->connectMailserver();
$searchResults = array_keys($diff);
$concatResults = implode(",", $searchResults);
$fetchedOverviews = $this->getImap()->fetchOverview($concatResults);
// clean up cache entry
foreach ($fetchedOverviews as $k => $overview) {
$overview->message_id = trim($diff[$overview->msgno]);
$fetchedOverviews[$k] = $overview;
}
$this->updateOverviewCacheFile($fetchedOverviews);
}
} else {
$GLOBALS['log']->debug("*** INBOUNDEMAIL: could not open socket connection to POP3 server");
return false;
}
}
/**
* Iterates through msgno and message_id to remove dirty cache entries
* @param array diff
*/
public function pop3_shiftCache($diff, $cacheUIDLs)
{
$msgNos = "";
$msgIds = "";
$newArray = array();
foreach ($diff as $msgNo => $msgId) {
if (in_array($msgId, $cacheUIDLs)) {
$q1 = "UPDATE email_cache SET imap_uid = {$msgNo}, msgno = {$msgNo} WHERE ie_id = '{$this->id}' AND message_id = '{$msgId}'";
$this->db->query($q1);
} else {
$newArray[$msgNo] = $msgId;
}
}
return $newArray;
}
/**
* retrieves cached uidl values.
* When dealing with POP3 accounts, the message_id column in email_cache will contain the UIDL.
* @return array
*/
public function pop3_getCacheUidls()
{
$q = "SELECT msgno, message_id FROM email_cache WHERE ie_id = '{$this->id}'";
$r = $this->db->query($q);
$ret = array();
while ($a = $this->db->fetchByAssoc($r)) {
$ret[$a['msgno']] = $a['message_id'];
}
return $ret;
}
/**
* This function is used by cron job for group mailbox without group folder
* @param string $msgno for pop
* @param string $uid for imap
*/
public function getMessagesInEmailCache($msgno, $uid)
{
$fetchedOverviews = array();
if ($this->isPop3Protocol()) {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Connection is not a valid resource but it is a POP3 Protocol');
} else {
$fetchedOverviews = $this->getImap()->fetchOverview($msgno);
foreach ($fetchedOverviews as $k => $overview) {
$overview->message_id = $uid;
$fetchedOverviews[$k] = $overview;
}
}
} else {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Connection is not a valid resource');
} else {
$fetchedOverviews = $this->getImap()->fetchOverview($uid, FT_UID);
}
} // else
$this->updateOverviewCacheFile($fetchedOverviews);
} // fn
/**
* Checks email (local caching too) for one mailbox
* @param string $mailbox IMAP Mailbox path
* @param bool $prefetch Flag to prefetch email body on check
*/
public function checkEmailOneMailbox($mailbox, $prefetch = true, $synchronize = false)
{
global $sugar_config;
global $current_user;
global $app_strings;
$result = 1;
$GLOBALS['log']->info("INBOUNDEMAIL: checking mailbox [ {$mailbox} ]");
$this->mailbox = $mailbox;
$this->connectMailserver();
$checkTime = '';
$shouldProcessRules = true;
$timestamp = $this->getCacheTimestamp($mailbox);
if ($timestamp > 0) {
$checkTime = date('r', $timestamp);
}
/* first time through, process ALL emails */
if (empty($checkTime) || $synchronize) {
// do not process rules for the first time or sunchronize
$shouldProcessRules = false;
$criteria = "UNSEEN";
$prefetch = false; // do NOT prefetch emails on a brand new account - timeouts happen.
$GLOBALS['log']->info("INBOUNDEMAIL: new account detected - not prefetching email bodies.");
} else {
$criteria = "SINCE \"{$checkTime}\" UNDELETED"; // not using UNSEEN
}
$this->setCacheTimestamp($mailbox);
$GLOBALS['log']->info("[EMAIL] Performing IMAP search using criteria [{$criteria}] on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->warn('checkEmailOneMailbox: connection is not a valid resource');
$searchResults = null;
} else {
$searchResults = $this->getImap()->search($criteria, SE_UID);
}
$GLOBALS['log']->info("[EMAIL] Done IMAP search on mailbox [{$mailbox}] for user [{$current_user->user_name}]. Result count = " . (is_countable($searchResults) ? count($searchResults) : 0));
if (!empty($searchResults)) {
$concatResults = implode(",", $searchResults);
$GLOBALS['log']->info("[EMAIL] Start IMAP fetch overview on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$fetchedOverview = $this->getImap()->fetchOverview($concatResults, FT_UID);
$GLOBALS['log']->info("[EMAIL] Done IMAP fetch overview on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$GLOBALS['log']->info("[EMAIL] Start updating overview cache for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$this->updateOverviewCacheFile($fetchedOverview);
$GLOBALS['log']->info("[EMAIL] Done updating overview cache for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
// prefetch emails
if ($prefetch == true) {
$GLOBALS['log']->info("[EMAIL] Start fetching emails for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
if (!$this->fetchCheckedEmails($fetchedOverview)) {
$result = 0;
}
$GLOBALS['log']->info("[EMAIL] Done fetching emails for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
}
} else {
$GLOBALS['log']->info("INBOUNDEMAIL: no results for mailbox [ {$mailbox} ]");
$result = 1;
}
/**
* To handle the use case where an external client is also connected, deleting emails, we need to clear our
* local cache of all emails with the "DELETED" flag
*/
$criteria = 'DELETED';
$criteria .= (!empty($checkTime)) ? " SINCE \"{$checkTime}\"" : "";
$GLOBALS['log']->info("INBOUNDEMAIL: checking for deleted emails using [ {$criteria} ]");
$trashFolder = $this->get_stored_options("trashFolder");
if (empty($trashFolder)) {
$trashFolder = "INBOX.Trash";
}
if ($this->mailbox != $trashFolder) {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->warn('connection is not a valid resource for checkEmailOneMailbox()');
$searchResults = null;
} else {
$searchResults = $this->getImap()->search($criteria, SE_UID);
}
if (!empty($searchResults)) {
$uids = implode($app_strings['LBL_EMAIL_DELIMITER'], $searchResults);
$GLOBALS['log']->info("INBOUNDEMAIL: removing UIDs found deleted [ {$uids} ]");
$this->getOverviewsFromCacheFile($uids, $mailbox, true);
}
}
return $result;
}
/**
* Checks email (local caching too) for one mailbox
* @param string $mailbox IMAP Mailbox path
* @param bool $prefetch Flag to prefetch email body on check
*/
public function checkEmailOneMailboxPartial($mailbox, $prefetch = true, $synchronize = false, $start = 0, $max = -1)
{
global $sugar_config;
global $current_user;
global $app_strings;
$GLOBALS['log']->info("INBOUNDEMAIL: checking mailbox [ {$mailbox} ]");
$this->mailbox = $mailbox;
$this->connectMailserver();
$checkTime = '';
$shouldProcessRules = true;
$timestamp = $this->getCacheTimestamp($mailbox);
if ($timestamp > 0) {
$checkTime = date('r', $timestamp);
}
/* first time through, process ALL emails */
if (empty($checkTime) || $synchronize) {
// do not process rules for the first time or sunchronize
$shouldProcessRules = false;
$criteria = "ALL UNDELETED";
$prefetch = false; // do NOT prefetch emails on a brand new account - timeouts happen.
$GLOBALS['log']->info("INBOUNDEMAIL: new account detected - not prefetching email bodies.");
} else {
$criteria = "SINCE \"{$checkTime}\" UNDELETED"; // not using UNSEEN
}
$this->setCacheTimestamp($mailbox);
$GLOBALS['log']->info("[EMAIL] Performing IMAP search using criteria [{$criteria}] on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$searchResults = $this->getCachedIMAPSearch($criteria);
if (!empty($searchResults)) {
$total = is_countable($searchResults) ? count($searchResults) : 0;
$searchResults = array_slice($searchResults, $start, $max);
$GLOBALS['log']->info("INBOUNDEMAIL: there are $total messages in [{$mailbox}], we are on $start");
$GLOBALS['log']->info("INBOUNDEMAIL: getting the next " . count($searchResults) . " messages");
$concatResults = implode(",", $searchResults);
$GLOBALS['log']->info("INBOUNDEMAIL: Start IMAP fetch overview on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$fetchedOverview = $this->getImap()->fetchOverview($concatResults, FT_UID);
$GLOBALS['log']->info("INBOUNDEMAIL: Done IMAP fetch overview on mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$GLOBALS['log']->info("INBOUNDEMAIL: Start updating overview cache for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$this->updateOverviewCacheFile($fetchedOverview);
$GLOBALS['log']->info("INBOUNDEMAIL: Done updating overview cache for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
// prefetch emails
if ($prefetch == true) {
$GLOBALS['log']->info("INBOUNDEMAIL: Start fetching emails for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
$this->fetchCheckedEmails($fetchedOverview);
$GLOBALS['log']->info("INBOUNDEMAIL: Done fetching emails for mailbox [{$mailbox}] for user [{$current_user->user_name}]");
}
$status = ($total > $start + count($searchResults)) ? 'continue' : 'done';
$ret = array(
'status' => $status,
'count' => $start + count($searchResults),
'mbox' => $mailbox,
'totalcount' => $total
);
$GLOBALS['log']->info("INBOUNDEMAIL: $status : Downloaded " . ($start + count($searchResults)) . " messages of $total");
} else {
$GLOBALS['log']->info("INBOUNDEMAIL: no results for mailbox [ {$mailbox} ]");
$ret = array('status' => 'done');
}
if ($ret['status'] == 'done') {
//Remove the cached search if we are done with this mailbox
$cacheFilePath = clean_path("{$this->EmailCachePath}/{$this->id}/folders/SearchData.php");
if (file_exists($cacheFilePath)) {
unlink($cacheFilePath);
}
/**
* To handle the use case where an external client is also connected, deleting emails, we need to clear our
* local cache of all emails with the "DELETED" flag
*/
$criteria = 'DELETED';
$criteria .= (!empty($checkTime)) ? " SINCE \"{$checkTime}\"" : "";
$GLOBALS['log']->info("INBOUNDEMAIL: checking for deleted emails using [ {$criteria} ]");
$trashFolder = $this->get_stored_options("trashFolder");
if (empty($trashFolder)) {
$trashFolder = "INBOX.Trash";
}
if ($this->mailbox != $trashFolder) {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->warn('mailbox != trash folder but connection is not a valid resource for checkEmailOneMailbox()');
$searchResults = null;
} else {
$searchResults = $this->getImap()->search($criteria, SE_UID);
}
if (!empty($searchResults)) {
$uids = implode($app_strings['LBL_EMAIL_DELIMITER'], $searchResults);
$GLOBALS['log']->info("INBOUNDEMAIL: removing UIDs found deleted [ {$uids} ]");
$this->getOverviewsFromCacheFile($uids, $mailbox, true);
}
}
}
return $ret;
}
public function getCachedIMAPSearch($criteria)
{
global $current_user;
global $sugar_config;
$cacheDataExists = false;
$diff = array();
$results = array();
$cacheFolderPath = clean_path("{$this->EmailCachePath}/{$this->id}/folders");
if (!file_exists($cacheFolderPath)) {
mkdir_recursive($cacheFolderPath);
}
$cacheFilePath = $cacheFolderPath . '/SearchData.php';
$GLOBALS['log']->info("INBOUNDEMAIL: Cache path is $cacheFilePath");
if (file_exists($cacheFilePath)) {
$cacheDataExists = true;
if ($fh = @fopen($cacheFilePath, "rb")) {
$data = "";
$chunksize = 1 * (1024 * 1024); // how many bytes per chunk
while (!feof($fh)) {
$buf = fgets($fh, $chunksize); // 8kb max buffer - shouldn't be more than 80 chars via pop3...
$data = $data . $buf;
flush();
} // while
fclose($fh);
$results = unserialize($data);
} // if
} // if
if (!$cacheDataExists) {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email Connection is not a valid resource.');
} else {
$searchResults = $this->getImap()->search($criteria, SE_UID);
if ((is_countable($searchResults) ? count($searchResults) : 0) > 0) {
$results = $searchResults;
$data = serialize($searchResults);
if ($fh = @fopen($cacheFilePath, 'wb')) {
fwrite($fh, $data);
fclose($fh);
} // if
}
}
} // if
return $results;
}
public function checkEmailIMAPPartial($prefetch = true, $synch = false)
{
$GLOBALS['log']->info("*****************INBOUNDEMAIL: at IMAP check partial");
global $sugar_config;
$result = $this->connectMailserver();
if ($result == 'false') {
return array(
'status' => 'error',
'message' => 'Email server is down'
);
}
$mailboxes = $this->getMailboxes(true);
if (!in_array('INBOX', $mailboxes)) {
$mailboxes[] = 'INBOX';
}
sort($mailboxes);
if (isset($_REQUEST['mbox']) && !empty($_REQUEST['mbox']) && isset($_REQUEST['currentCount'])) {
$GLOBALS['log']->info("INBOUNDEMAIL: Picking up from where we left off");
$mbox = $_REQUEST['mbox'];
$count = $_REQUEST['currentCount'];
} else {
if ($synch) {
$GLOBALS['log']->info("INBOUNDEMAIL: Cleaning out the cache");
$this->cleanOutCache();
}
$mbox = $mailboxes[0];
$count = 0;
}
$GLOBALS['log']->info("INBOUNDEMAIL:found " . count($mailboxes) . " Mailboxes");
$index = array_search($mbox, $mailboxes, true) + 1;
$ret = $this->checkEmailOneMailboxPartial($mbox, $prefetch, $synch, $count, 100);
while ($ret['status'] == 'done' && $index < count($mailboxes)) {
if ($ret['count'] > 100) {
$ret['mbox'] = $mailboxes[$index];
$ret['status'] = 'continue';
return $ret;
}
$GLOBALS['log']->info("INBOUNDEMAIL: checking account [ $index => $mbox : $count]");
$mbox = $mailboxes[$index];
$ret = $this->checkEmailOneMailboxPartial($mbox, $prefetch, $synch, 0, 100);
$index++;
}
return $ret;
}
public function checkEmail2_meta()
{
global $sugar_config;
$this->connectMailserver();
$mailboxes = $this->getMailboxes(true);
$mailboxes[] = 'INBOX';
sort($mailboxes);
$GLOBALS['log']->info("INBOUNDEMAIL: checking account [ {$this->name} ]");
$mailboxes_meta = array();
foreach ($mailboxes as $mailbox) {
$mailboxes_meta[$mailbox] = $this->getMailboxProcessCount($mailbox);
}
$ret = array();
$ret['mailboxes'] = $mailboxes_meta;
foreach ($mailboxes_meta as $count) {
if (!isset($ret['processCount'])) {
$ret['processCount'] = 0;
}
$ret['processCount'] += $count;
}
return $ret;
}
public function getMailboxProcessCount($mailbox)
{
global $sugar_config;
$GLOBALS['log']->info("INBOUNDEMAIL: checking mailbox [ {$mailbox} ]");
$this->mailbox = $mailbox;
$this->connectMailserver();
$timestamp = $this->getCacheTimestamp($mailbox);
$checkTime = '';
if ($timestamp > 0) {
$checkTime = date('r', $timestamp);
}
/* first time through, process ALL emails */
if (empty($checkTime)) {
$criteria = "ALL UNDELETED";
$prefetch = false; // do NOT prefetch emails on a brand new account - timeouts happen.
$GLOBALS['log']->info("INBOUNDEMAIL: new account detected - not prefetching email bodies.");
} else {
$criteria = "SINCE \"{$checkTime}\" UNDELETED"; // not using UNSEEN
}
$GLOBALS['log']->info("INBOUNDEMAIL: using [ {$criteria} ]");
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->warn('connection is not a valid resource for getMailboxProcessCount()');
$searchResults = null;
} else {
$searchResults = $this->getImap()->fetchOverview($criteria, SE_UID);
}
if (!empty($searchResults)) {
$concatResults = implode(",", $searchResults);
} else {
$GLOBALS['log']->info("INBOUNDEMAIL: no results for mailbox [ {$mailbox} ]");
}
if (empty($searchResults)) {
return 0;
}
return is_countable($searchResults) ? count($searchResults) : 0;
}
/**
* update INBOX
*/
public function checkEmail($prefetch = true, $synch = false)
{
global $sugar_config;
if ($this->protocol == 'pop3') {
$this->pop3_checkEmail();
} else {
$this->connectMailserver();
$mailboxes = $this->getMailboxes(true);
if (!is_array($mailboxes)) {
LoggerManager::getLogger()->warn('mailboxes is not an array for check email');
$mailboxes = (array)$mailboxes;
} else {
sort($mailboxes);
}
$GLOBALS['log']->info("INBOUNDEMAIL: checking account [ {$this->name} ]");
foreach ($mailboxes as $mailbox) {
$this->checkEmailOneMailbox($mailbox, $prefetch, $synch);
}
}
}
/**
* full synchronization
*/
public function syncEmail()
{
global $sugar_config;
global $current_user;
$showFolders = sugar_unserialize(base64_decode($current_user->getPreference('showFolders', 'Emails')));
if (empty($showFolders)) {
$showFolders = array();
}
$email = BeanFactory::newBean('Emails');
$email->email2init();
// personal accounts
if ($current_user->hasPersonalEmail()) {
$personals = $this->retrieveByGroupId($current_user->id);
foreach ($personals as $personalAccount) {
if (in_array($personalAccount->id, $showFolders)) {
$personalAccount->email = $email;
if ($personalAccount->isPop3Protocol()) {
$personalAccount->deletePop3Cache();
continue;
}
$personalAccount->cleanOutCache();
$personalAccount->connectMailserver();
$mailboxes = $personalAccount->getMailboxes(true);
$mailboxes[] = 'INBOX';
sort($mailboxes);
$GLOBALS['log']->info("[EMAIL] Start checking account [{$personalAccount->name}] for user [{$current_user->user_name}]");
foreach ($mailboxes as $mailbox) {
$GLOBALS['log']->info("[EMAIL] Start checking mailbox [{$mailbox}] of account [{$personalAccount->name}] for user [{$current_user->user_name}]");
$personalAccount->checkEmailOneMailbox($mailbox, false, true);
$GLOBALS['log']->info("[EMAIL] Done checking mailbox [{$mailbox}] of account [{$personalAccount->name}] for user [{$current_user->user_name}]");
}
$GLOBALS['log']->info("[EMAIL] Done checking account [{$personalAccount->name}] for user [{$current_user->user_name}]");
}
}
}
// group accounts
$beans = $this->retrieveAllByGroupId($current_user->id, false);
foreach ($beans as $k => $groupAccount) {
if (in_array($groupAccount->id, $showFolders)) {
$groupAccount->email = $email;
$groupAccount->cleanOutCache();
$groupAccount->connectMailserver();
$mailboxes = $groupAccount->getMailboxes(true);
$mailboxes[] = 'INBOX';
sort($mailboxes);
$GLOBALS['log']->info("INBOUNDEMAIL: checking account [ {$groupAccount->name} ]");
foreach ($mailboxes as $mailbox) {
$groupAccount->checkEmailOneMailbox($mailbox, false, true);
}
}
}
}
/**
* Deletes cached messages when moving from folder to folder
* @param string $uids
* @param string $fromFolder
* @param string $toFolder
*/
public function deleteCachedMessages($uids, $fromFolder)
{
global $sugar_config;
if (!isset($this->email) && !isset($this->email->et)) {
$this->email = BeanFactory::newBean('Emails');
$this->email->email2init();
}
$uids = $this->email->et->_cleanUIDList($uids);
foreach ((array)$uids as $uid) {
$file = "{$this->EmailCachePath}/{$this->id}/messages/{$fromFolder}{$uid}.php";
if (file_exists($file)) {
if (!unlink($file)) {
$GLOBALS['log']->debug("INBOUNDEMAIL: Could not delete [ {$file} ]");
}
}
}
}
/**
* similar to imap_fetch_overview, but it gets overviews from a local cache
* file.
* @param string $uids UIDs in comma-delimited format
* @param string $mailbox The mailbox in focus, will default to $this->mailbox
* @param bool $remove Default false
* @return array
*/
public function getOverviewsFromCacheFile($uids, $mailbox = '', $remove = false)
{
global $app_strings;
if (!isset($this->email) && !isset($this->email->et)) {
$this->email = BeanFactory::newBean('Emails');
$this->email->email2init();
}
$uids = $this->email->et->_cleanUIDList($uids, true);
// load current cache file
$mailbox = empty($mailbox) ? $this->mailbox : $mailbox;
$cacheValue = $this->getCacheValue($mailbox);
$ret = array();
// prep UID array
$exUids = explode($app_strings['LBL_EMAIL_DELIMITER'], $uids);
foreach ($exUids as $k => $uid) {
$exUids[$k] = trim($uid);
}
// fill $ret will requested $uids
foreach ($cacheValue['retArr'] as $k => $overview) {
if (in_array($overview->imap_uid, $exUids)) {
$ret[] = $overview;
}
}
// remove requested $uids from current cache file (move_mail() type action)
if ($remove) {
$this->setCacheValue($mailbox, array(), array(), $ret);
}
return $ret;
}
/**
* merges new info with the saved cached file
* @param array $array Array of email Overviews
* @param string $type 'append' or 'remove'
* @param string $mailbox Target mai lbox if not current assigned
*/
public function updateOverviewCacheFile($array, $type = 'append', $mailbox = '')
{
$mailbox = empty($mailbox) ? $this->mailbox : $mailbox;
$cacheValue = $this->getCacheValue($mailbox);
$uids = $cacheValue['uids'];
$updateRows = array();
$insertRows = array();
$removeRows = array();
// update values
if ($type == 'append') { // append
/* we are adding overviews to the cache file */
foreach ($array as $overview) {
if (isset($overview->uid)) {
$overview->imap_uid = $overview->uid; // coming from imap_fetch_overview() call
}
if (!in_array($overview->imap_uid, $uids)) {
$insertRows[] = $overview;
}
}
} else {
$updatedCacheOverviews = array();
// compare against generated list
/* we are removing overviews from the cache file */
foreach ($cacheValue['retArr'] as $cacheOverview) {
if (!in_array($cacheOverview->imap_uid, $uids)) {
$insertRows[] = $cacheOverview;
} else {
$removeRows[] = $cacheOverview;
}
}
$cacheValue['retArr'] = $updatedCacheOverviews;
}
$this->setCacheValue($mailbox, $insertRows, $updateRows, $removeRows);
}
/**
* Check email prefetches email bodies for quicker display
* @param array array of fetched overviews
*/
public function fetchCheckedEmails($fetchedOverviews)
{
global $sugar_config;
if (is_array($fetchedOverviews) && !empty($fetchedOverviews)) {
foreach ($fetchedOverviews as $overview) {
if ($overview->size < 10000) {
$uid = isset($overview->imap_uid) ? $overview->imap_uid : null;
if (!empty($uid)) {
$file = "{$this->mailbox}{$uid}.php";
$cacheFile = clean_path("{$this->EmailCachePath}/{$this->id}/messages/{$file}");
if (!file_exists($cacheFile)) {
$GLOBALS['log']->info("INBOUNDEMAIL: Prefetching email [ {$file} ]");
$this->setEmailForDisplay($uid);
$out = $this->displayOneEmail($uid, $this->mailbox);
$this->email->et->writeCacheFile(
'out',
$out,
$this->id,
'messages',
"{$this->mailbox}{$uid}.php"
);
} else {
$GLOBALS['log']->debug("INBOUNDEMAIL: Trying to prefetch an email we already fetched! [ {$cacheFile} ]");
}
} else {
$GLOBALS['log']->debug("*** INBOUNDEMAIL: prefetch has a message with no UID");
}
return true;
}
$GLOBALS['log']->debug("INBOUNDEMAIL: skipping email prefetch - size too large [ {$overview->size} ]");
}
}
return false;
}
/**
* Sets flags on emails. Assumes that connection is live, correct folder is
* set.
* @param string|array $uids Sequence of UIDs, comma separated string or array
* @param string $type Flag to mark
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function markEmails($uids, $type)
{
// repair uids value (confert to string)
if (is_array($uids)) {
$uids = implode(',', $uids);
}
// validate for comma separated and numeric UIDs
$splits = explode(',', $uids);
if (!$splits) {
$GLOBALS['log']->fatal("No IMAP uids");
return false;
}
foreach ($splits as $uid) {
if (!is_numeric($uid)) {
$GLOBALS['log']->fatal("Incorrect UID format");
return false;
}
}
// validate for IMAP flag type
if (!$type) {
$GLOBALS['log']->fatal("IMAP flag type doesn't set");
return false;
}
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email connection is not a valid resource for marking Emails');
return false;
}
switch ($type) {
case 'unread':
$result = $this->getImap()->clearFlagFull($uids, '\\SEEN', ST_UID);
break;
case 'read':
$result = $this->getImap()->setFlagFull($uids, '\\SEEN', ST_UID);
break;
case 'flagged':
$result = $this->getImap()->setFlagFull($uids, '\\FLAGGED', ST_UID);
break;
case 'unflagged':
$result = $this->getImap()->clearFlagFull($uids, '\\FLAGGED', ST_UID);
break;
case 'answered':
$result = $this->getImap()->setFlagFull($uids, '\\Answered', ST_UID);
break;
default:
// Logging of incorrect (unknown) IMap flag type
$GLOBALS['log']->fatal("Unknown IMap flag type: $type");
return false;
}
if (!$result) {
$GLOBALS['log']->fatal("Some emails doesn't marked as $type");
}
return $result;
}
//// END EMAIL 2.0 SPECIFIC
///////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////
//// SERVER MANIPULATION METHODS
/**
* Deletes the specified folder
* @param string $mbox "::" delimited IMAP mailbox path, ie, INBOX.saved.stuff
* @return bool
*/
public function deleteFolder($mbox)
{
$returnArray = array();
if ($this->getCacheCount($mbox) > 0) {
$returnArray['status'] = false;
$returnArray['errorMessage'] = "Can not delete {$mbox} as it has emails.";
return $returnArray;
}
$connectString = $this->getConnectString('', $mbox);
//Remove Folder cache
global $sugar_config;
$file = "{$this->EmailCachePath}/{$this->id}/folders/folders.php";
if (file_exists($file)) {
unlink($file);
}
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inboun Email Connenction is not a valid resource for deleting Folder');
} elseif ($this->getImap()->unsubscribe($this->getImap()->utf7Encode($connectString))) {
if ($this->getImap()->deleteMailbox($connectString)) {
$this->mailbox = str_replace(("," . $mbox), "", (string) $this->mailbox);
$this->save();
$sessionFoldersString = $this->getSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol
);
$sessionFoldersString = str_replace(("," . $mbox), "", (string) $sessionFoldersString);
$this->setSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
$sessionFoldersString
);
$returnArray['status'] = true;
return $returnArray;
}
$GLOBALS['log']->error("*** ERROR: EMAIL2.0 - could not delete IMAP mailbox with path: [ {$connectString} ]");
$returnArray['status'] = false;
$returnArray['errorMessage'] = "NOOP: could not delete folder: {$connectString}";
return $returnArray;
return false;
}
$GLOBALS['log']->error("*** ERROR: EMAIL2.0 - could not unsubscribe from folder, {$connectString} before deletion.");
$returnArray['status'] = false;
$returnArray['errorMessage'] = "NOOP: could not unsubscribe from folder, {$connectString} before deletion.";
return $returnArray;
}
/**
* Saves new folders
* @param string $name Name of new IMAP mailbox
* @param string $mbox "::" delimited IMAP mailbox path, ie, INBOX.saved.stuff
* @return bool True on success
*/
public function saveNewFolder($name, $mbox)
{
global $sugar_config;
//Remove Folder cache
global $sugar_config;
//unlink("{$this->EmailCachePath}/{$this->id}/folders/folders.php");
//$mboxImap = $this->getImapMboxFromSugarProprietary($mbox);
$delimiter = $this->get_stored_options('folderDelimiter');
if (!$delimiter) {
$delimiter = '.';
}
$newFolder = $mbox . $delimiter . $name;
$mbox .= $delimiter . str_replace($delimiter, "_", $name);
$connectString = $this->getConnectString('', $mbox);
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inboun Email Connectrion is not a valid resource for saving new folder');
} elseif ($this->getImap()->createMailbox($this->getImap()->utf7Encode($connectString))) {
$this->getImap()->subscribe($this->getImap()->utf7Encode($connectString));
$status = $this->getImap()->getStatus(str_replace("{$delimiter}{$name}", "", $connectString), SA_ALL);
$this->mailbox = $this->mailbox . "," . $newFolder;
$this->save();
$sessionFoldersString = $this->getSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol
);
$sessionFoldersString = $sessionFoldersString . "," . $newFolder;
$this->setSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
$sessionFoldersString
);
echo json_encode($status);
return true;
}
$GLOBALS['log']->error("*** ERROR: EMAIL2.0 - could not create IMAP mailbox with path: [ {$connectString} ]");
return false;
}
/**
* Constructs an IMAP c-client compatible folder path from Sugar proprietary
* @param string $mbox "::" delimited IMAP mailbox path, ie, INBOX.saved.stuff
* @return string
*/
public function getImapMboxFromSugarProprietary($mbox)
{
$exMbox = explode("::", $mbox);
$mboxImap = '';
$exMboxCount = count($exMbox);
for ($i = 2; $i < $exMboxCount; $i++) {
if (!empty($mboxImap)) {
$mboxImap .= ".";
}
$mboxImap .= $exMbox[$i];
}
return $mboxImap;
}
/**
* Searches IMAP (and POP3?) accounts/folders for emails with qualifying criteria
*/
public function search($ieId, $subject = '', $from = '', $to = '', $body = '', $dateFrom = '', $dateTo = '')
{
global $current_user;
global $app_strings;
global $timedate;
$beans = array();
$bean = BeanFactory::newBean('InboundEmail');
$bean->retrieve($ieId);
$beans[] = $bean;
//$beans = $this->retrieveAllByGroupId($current_user->id, true);
$subject = urldecode($subject);
$criteria = "";
$criteria .= (!empty($subject)) ? 'SUBJECT ' . from_html($subject) . '' : "";
$criteria .= (!empty($from)) ? ' FROM "' . $from . '"' : "";
$criteria .= (!empty($to)) ? ' FROM "' . $to . '"' : "";
$criteria .= (!empty($body)) ? ' TEXT "' . $body . '"' : "";
$criteria .= (!empty($dateFrom)) ? ' SINCE "' . $timedate->fromString($dateFrom)->format('d-M-Y') . '"' : "";
$criteria .= (!empty($dateTo)) ? ' BEFORE "' . $timedate->fromString($dateTo)->format('d-M-Y') . '"' : "";
//$criteria .= (!empty($from)) ? ' FROM "'.$from.'"' : "";
$showFolders = sugar_unserialize(base64_decode($current_user->getPreference('showFolders', 'Emails')));
if (!$showFolders) {
LoggerManager::getLogger()->fatal('User preferences contains incorrect email folder(s)');
}
$out = array();
if ($showFolders) {
foreach ($beans as $bean) {
if (!in_array($bean->id, $showFolders)) {
continue;
}
$GLOBALS['log']->info("*** INBOUNDEMAIL: searching [ {$bean->name} ] for [ {$subject}{$from}{$to}{$body}{$dateFrom}{$dateTo} ]");
$group = (!$bean->is_personal) ? 'group.' : '';
$bean->connectMailServer();
$mailboxes = $bean->getMailboxes(true);
if (!in_array('INBOX', $mailboxes)) {
$mailboxes[] = 'INBOX';
}
$totalHits = 0;
foreach ($mailboxes as $mbox) {
$bean->mailbox = $mbox;
$searchOverviews = array();
if ($bean->protocol == 'pop3') {
$pop3Criteria = "SELECT * FROM email_cache WHERE ie_id = '{$bean->id}' AND mbox = '{$mbox}'";
$pop3Criteria .= (!empty($subject)) ? ' AND subject like "%' . $bean->db->quote($subject) . '%"' : "";
$pop3Criteria .= (!empty($from)) ? ' AND fromaddr like "%' . $from . '%"' : "";
$pop3Criteria .= (!empty($to)) ? ' AND toaddr like "%' . $to . '%"' : "";
$pop3Criteria .= (!empty($dateFrom)) ? ' AND senddate > "' . $dateFrom . '"' : "";
$pop3Criteria .= (!empty($dateTo)) ? ' AND senddate < "' . $dateTo . '"' : "";
$GLOBALS['log']->info("*** INBOUNDEMAIL: searching [ {$mbox} ] using criteria [ {$pop3Criteria} ]");
$r = $bean->db->query($pop3Criteria);
while ($a = $bean->db->fetchByAssoc($r)) {
$overview = new Overview();
foreach ($a as $k => $v) {
$k = strtolower($k);
switch ($k) {
case "imap_uid":
$overview->imap_uid = $v;
$overview->uid = $a['message_id'];
break;
case "toaddr":
$overview->to = from_html($v);
break;
case "fromaddr":
$overview->from = from_html($v);
break;
case "mailsize":
$overview->size = $v;
break;
case "senddate":
$overview->date = $timedate->fromString($v)->format('r');
break;
default:
$overview->$k = from_html($v);
break;
} // sqitch
} // foreach
$searchOverviews[] = $overview;
} // while
} else {
$bean->connectMailServer();
$searchResult = $bean->imap->search($criteria, SE_UID);
if (!empty($searchResult)) {
$searchOverviews = $bean->imap->fetchOverview(implode(',', $searchResult), FT_UID);
} // if
} // else
$numHits = is_countable($searchOverviews) ? count($searchOverviews) : 0;
if ($numHits > 0) {
$totalHits = $totalHits + $numHits;
$ret = $bean->sortFetchedOverview($searchOverviews, 'date', 'desc', true);
$mbox = "{$bean->id}.SEARCH";
$out = array_merge($out, $bean->displayFetchedSortedListXML($ret, $mbox, false));
}
}
}
}
$metadata = array();
$metadata['mbox'] = $app_strings['LBL_EMAIL_SEARCH_RESULTS_TITLE'];
$metadata['ieId'] = $this->id;
$metadata['name'] = $this->name;
$metadata['unreadChecked'] = ($current_user->getPreference('showUnreadOnly', 'Emails') == 1) ? 'CHECKED' : '';
$metadata['out'] = $out;
return $metadata;
}
/**
* repairs the encrypted password for a given I-E account
* @return bool True on success
*/
public function repairAccount()
{
for ($i = 0; $i < 3; $i++) {
if ($i != 0) { // decode is performed on retrieve already
$this->email_password = blowfishDecode(blowfishGetKey('InboundEmail'), $this->email_password);
}
if ($this->connectMailserver() == 'true') {
$this->save(); // save decoded password (is encoded on save())
return true;
}
}
return false;
}
/**
* soft deletes a User's personal inbox
* @param string id I-E id
* @param string user_name User name of User in focus, NOT current_user
* @return bool True on success
*/
public function deletePersonalEmailAccount($id, $user_name)
{
$q = "SELECT ie.id FROM inbound_email ie LEFT JOIN users u ON ie.group_id = u.id WHERE u.user_name = '{$user_name}'";
$r = $this->db->query($q, true);
while ($a = $this->db->fetchByAssoc($r)) {
if (!empty($a) && $a['id'] == $id) {
$this->retrieve($id);
$this->deleted = 1;
$this->save();
return true;
}
}
return false;
}
/**
* @param $teamIds
* @return mixed
*/
public function getTeamSetIdForTeams($teamIds)
{
if (!is_array($teamIds)) {
$teamIds = array($teamIds);
} // if
$teamSet = new TeamSet();
$team_set_id = $teamSet->addTeams($teamIds);
return $team_set_id;
} // fn
/**
* Parses the core dynamic folder query
* @param string $type 'inbound', 'draft', etc.
* @param string $userId
* @return string
*/
public function generateDynamicFolderQuery($type, $userId)
{
if (!isset($this->coreDynamicFolderQuery)) {
$this->coreDynamicFolderQuery = null;
LoggerManager::getLogger()->warn('Attempt to generate dynamic folder query with an unset core dynamic folder query?!');
}
$q = $this->coreDynamicFolderQuery;
$status = $type;
if ($type == "sent") {
$type = "out";
}
$replacee = array("::TYPE::", "::STATUS::", "::USER_ID::");
$replacer = array($type, $status, $userId);
$ret = str_replace($replacee, $replacer, (string) $q);
if ($type == 'inbound') {
$ret .= " AND status NOT IN ('sent', 'archived', 'draft') AND type NOT IN ('out', 'archived', 'draft')";
} else {
$ret .= " AND status NOT IN ('archived') AND type NOT IN ('archived')";
}
return $ret;
}
/**
* Saves Personal Inbox settings for Users
* @param string userId ID of user to assign all emails for this account
* @param strings userName Name of account, for Sugar purposes
* @param bool forceSave Default true. Flag to save errored settings.
* @return boolean true on success, false on fail
*/
public function savePersonalEmailAccount($userId = '', $userName = '', $forceSave = true)
{
global $mod_strings;
$groupId = $userId;
$accountExists = false;
if (isset($_REQUEST['ie_id']) && !empty($_REQUEST['ie_id'])) {
$this->retrieve($_REQUEST['ie_id']);
$accountExists = true;
}
$ie_name = $_REQUEST['ie_name'];
$stored_options = $this->getStoredOptions();
$stored_options['outbound_email'] = isset($_REQUEST['outbound_email']) ? $_REQUEST['outbound_email'] : null;
$this->setStoredOptions($stored_options);
$this->is_personal = 1;
$this->name = $ie_name;
$this->group_id = $groupId;
$this->status = $_REQUEST['ie_status'];
$this->server_url = trim($_REQUEST['server_url']);
$this->email_user = trim($_REQUEST['email_user']);
if (!empty($_REQUEST['email_password'])) {
$this->email_password = html_entity_decode((string) $_REQUEST['email_password'], ENT_QUOTES);
}
$this->port = trim(isset($_REQUEST['port']) ? $_REQUEST['port'] : '');
$this->protocol = isset($_REQUEST['protocol']) ? $_REQUEST['protocol'] : null;
if ($this->protocol == "pop3") {
$_REQUEST['mailbox'] = "INBOX";
}
$this->mailbox = $_REQUEST['mailbox'];
$inboxFolders = explode(',', $this->mailbox);
$this->mailbox_type = 'pick'; // forcing this
if (isset($_REQUEST['ssl']) && $_REQUEST['ssl'] == 1) {
$useSsl = true;
} else {
$useSsl = false;
}
$this->service = '::::::::::';
if ($forceSave) {
$id = $this->save(); // saving here to prevent user from having to re-enter all the info in case of error
$this->retrieve($id);
}
$this->protocol = isset($_REQUEST['protocol']) ? $_REQUEST['protocol'] : null; // need to set this again since we safe the "service" string to empty explode values
$opts = $this->getSessionConnectionString($this->server_url, $this->email_user, $this->port, $this->protocol);
$detectedOpts = $this->findOptimumSettings($useSsl);
//If $detectedOpts is empty, there was an error connecting, so clear $opts. If $opts was empty, use $detectedOpts
if (empty($opts) || empty($detectedOpts) || (empty($detectedOpts['good']) && empty($detectedOpts['serial']))) {
$opts = $detectedOpts;
}
$delimiter = $this->getSessionInboundDelimiterString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol
);
if (isset($opts['serial']) && !empty($opts['serial'])) {
$this->service = $opts['serial'];
if (isset($_REQUEST['mark_read']) && $_REQUEST['mark_read'] == 1) {
$this->delete_seen = 0;
} else {
$this->delete_seen = 1;
}
// handle stored_options serialization
if (isset($_REQUEST['only_since']) && $_REQUEST['only_since'] == 1) {
$onlySince = true;
} else {
$onlySince = false;
}
$focusUser = BeanFactory::newBean('Users');
$focusUser->retrieve($groupId);
$mailerId = (isset($_REQUEST['outbound_email'])) ? $_REQUEST['outbound_email'] : "";
$oe = new OutboundEmail();
if ($mailerId != "") {
$oe->retrieve($mailerId);
} else {
$oe->getSystemMailerSettings();
}
$stored_options = array();
if ($oe->id != "") {
$stored_options['from_name'] = trim($oe->smtp_from_name);
$stored_options['from_addr'] = trim($oe->smtp_from_addr);
isValidEmailAddress($stored_options['from_addr']);
} else {
$stored_options['from_name'] = trim($_REQUEST['from_name']);
$stored_options['from_addr'] = trim($_REQUEST['from_addr']);
isValidEmailAddress($stored_options['from_addr']);
}
$stored_options['reply_to_addr'] = trim($_REQUEST['reply_to_addr']);
if (!$this->isPop3Protocol()) {
$stored_options['mailbox'] = (isset($_REQUEST['mailbox']) ? trim($_REQUEST['mailbox']) : "");
$stored_options['trashFolder'] = (isset($_REQUEST['trashFolder']) ? trim($_REQUEST['trashFolder']) : "");
$stored_options['sentFolder'] = (isset($_REQUEST['sentFolder']) ? trim($_REQUEST['sentFolder']) : "");
} // if
$stored_options['only_since'] = $onlySince;
$stored_options['filter_domain'] = '';
$stored_options['folderDelimiter'] = $delimiter;
$stored_options['outbound_email'] = (isset($_REQUEST['outbound_email'])) ? $_REQUEST['outbound_email'] : $oe->id;
$this->stored_options = base64_encode(serialize($stored_options));
$ieId = $this->save();
// Folders
$foldersFound = $this->db->query(
'SELECT folders.id FROM folders WHERE folders.id LIKE "' . $this->db->quote($this->id) . '"'
);
$row = $this->db->fetchByAssoc($foldersFound);
if (empty($row)) {
$this->createFolder(
$inboxFolders[0] . ' (' . $this->name . ')',
"inbound",
$focusUser,
$this->id
);
foreach ($inboxFolders as $key => $folder) {
if ($key == 0) {
continue;
}
if ($this->folderIsRequestTrashOrSent($folder)) {
continue;
}
$this->createFolder(
$folder,
"inbound",
$focusUser
);
}
$this->createFolder(
$mod_strings['LNK_MY_DRAFTS'] . ' (' . $stored_options['sentFolder'] . ')',
"draft",
$focusUser
);
$this->createFolder(
$mod_strings['LNK_SENT_EMAIL_LIST'] . ' (' . $stored_options['sentFolder'] . ')',
"sent",
$focusUser
);
$this->createFolder(
$mod_strings['LBL_LIST_TITLE_MY_ARCHIVES'],
"archived",
$focusUser
);
} else {
// Update folders
$foldersFound = $this->db->query(
'SELECT * FROM folders WHERE deleted = 0 AND (folders.id LIKE "' . $this->db->quote($this->id) . '" OR ' .
'folders.parent_folder LIKE "' . $this->db->quote($this->id) . '")'
);
$inboxNames = array_splice($inboxFolders, 1);
while ($row = $this->db->fetchRow($foldersFound)) {
$name = '';
$folder = new SugarFolder();
$folder->retrieve($row['id']);
switch ($row['folder_type']) {
case 'inbound':
if (!$row['has_child']) {
if (in_array($row['name'], $inboxNames)) {
// We have the folder, all is good
unset($inboxNames[array_search($row['name'], $inboxNames, true)]);
} else {
// We have a folder we shouldn't have
$folder->id = $row['id'];
$folder->delete();
}
} else {
$name = $inboxFolders[0] . ' (' . $this->name . ')';
}
break;
case 'draft':
$name = $mod_strings['LNK_MY_DRAFTS'] . ' (' . $stored_options['sentFolder'] . ')';
break;
case 'sent':
$name = $mod_strings['LNK_SENT_EMAIL_LIST'] . ' (' . $stored_options['sentFolder'] . ')';
break;
case 'archived':
$name = $mod_strings['LBL_LIST_TITLE_MY_ARCHIVES'];
break;
}
if ($name) {
$folder->name = $name;
$folder->save();
}
}
// Any inbox folder we don't have yet we need to create
foreach ($inboxNames as $newInboxFolder) {
if ($this->folderIsRequestTrashOrSent($newInboxFolder)) {
continue;
}
$this->createFolder(
$newInboxFolder,
"inbound",
$focusUser
);
}
}
//If this is the first personal account the user has setup mark it as default for them.
$currentIECount = $this->getUserPersonalAccountCount($focusUser);
if ($currentIECount == 1) {
$this->setUsersDefaultOutboundServerId($focusUser, $ieId);
}
return true;
}
// could not find opts, no save
$GLOBALS['log']->debug('-----> InboundEmail could not find optimums for User: ' . $ie_name);
return false;
}
/**
* @param $name
* @param $type
* @param $focusUser
* @param int $id
* @return int
*/
private function createFolder($name, $type, $focusUser, $id = 0)
{
$folder = new SugarFolder();
$folder->name = $name;
$folder->folder_type = $type;
$folder->has_child = $id ? 1 : 0;
$folder->is_dynamic = 1;
$folder->dynamic_query = $this->generateDynamicFolderQuery("sent", $focusUser->id);
$folder->created_by = $focusUser->id;
$folder->modified_by = $focusUser->id;
if ($id) {
$folder->new_with_id = false;
$folder->id = $id;
} else {
$folder->parent_folder = $this->id;
}
$folder->save();
return $folder->id;
}
/**
* @param $folderName
* @return bool
*/
private function folderIsRequestTrashOrSent($folderName)
{
return $folderName == $_REQUEST['trashFolder'] || $folderName == $_REQUEST['sentFolder'];
}
/**
* Determines if this instance of I-E is for a Group Inbox or Personal Inbox
*/
public function handleIsPersonal()
{
$qp = 'SELECT users.id, users.user_name FROM users WHERE users.is_group = 0 AND users.deleted = 0 AND users.status = \'active\' AND users.id = \'' . $this->group_id . '\'';
$rp = $this->db->query($qp, true);
$personalBox = array();
while ($ap = $this->db->fetchByAssoc($rp)) {
$personalBox[] = array($ap['id'], $ap['user_name']);
}
if (count($personalBox) > 0) {
return true;
}
return false;
}
public function getUserNameFromGroupId()
{
$r = $this->db->query(
'SELECT users.user_name FROM users WHERE deleted=0 AND id=\'' . $this->group_id . '\'',
true
);
while ($a = $this->db->fetchByAssoc($r)) {
return $a['user_name'];
}
return '';
}
public function getFoldersListForMailBox()
{
global $mod_strings;
$msg = $this->connectMailserver(true);
$return = [];
if (strpos($msg, "successfully")) {
$foldersList = $this->getSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol
);
$return['status'] = true;
$return['foldersList'] = $foldersList;
$return['statusMessage'] = "";
} else {
$return['status'] = false;
$return['statusMessage'] = $msg;
} // else
return $return;
} // fn
/**
* Programatically determines best-case settings for imap_open()
*/
public function findOptimumSettings(
$useSsl = false,
$user = '',
$pass = '',
$server = '',
$port = '',
$prot = '',
$mailbox = ''
) {
global $mod_strings;
$serviceArr = array();
$returnService = array();
$badService = array();
$goodService = array();
$errorArr = array();
$goodStr = [];
$raw = array();
$retArray = array(
'good' => $goodService,
'bad' => $badService,
'err' => $errorArr
);
if (!$this->getImap()->isAvailable()) {
$retArray['err'][0] = $mod_strings['ERR_NO_IMAP'];
return $retArray;
}
$this->getImap()->getErrors(); // clearing error stack
//error_reporting(0); // turn off notices from IMAP
if (isset($_REQUEST['ssl']) && $_REQUEST['ssl'] == 1) {
$useSsl = true;
}
$exServ = explode('::', $this->service);
if (!isset($exServ[1])) {
LoggerManager::getLogger()->warn('incorrect service given: ' . $this->service);
$service = '/';
} else {
$service = '/' . $exServ[1];
}
$nonSsl = array(
'both-secure' => '/notls/novalidate-cert/secure',
'both' => '/notls/novalidate-cert',
'nocert-secure' => '/novalidate-cert/secure',
'nocert' => '/novalidate-cert',
'notls-secure' => '/notls/secure',
'secure' => '/secure', // for POP3 servers that force CRAM-MD5
'notls' => '/notls',
'none' => '', // try default nothing
);
$ssl = array(
'ssl-both-on-secure' => '/ssl/tls/validate-cert/secure',
'ssl-both-on' => '/ssl/tls/validate-cert',
'ssl-cert-secure' => '/ssl/validate-cert/secure',
'ssl-cert' => '/ssl/validate-cert',
'ssl-tls-secure' => '/ssl/tls/secure',
'ssl-tls' => '/ssl/tls',
'ssl-both-off-secure' => '/ssl/notls/novalidate-cert/secure',
'ssl-both-off' => '/ssl/notls/novalidate-cert',
'ssl-nocert-secure' => '/ssl/novalidate-cert/secure',
'ssl-nocert' => '/ssl/novalidate-cert',
'ssl-notls-secure' => '/ssl/notls/secure',
'ssl-notls' => '/ssl/notls',
'ssl-secure' => '/ssl/secure',
'ssl-none' => '/ssl',
);
if (isset($user) && !empty($user) && isset($pass) && !empty($pass)) {
$this->email_password = $pass;
$this->email_user = $user;
$this->server_url = $server;
$this->port = $port;
$this->protocol = $prot;
$this->mailbox = $mailbox;
}
// in case we flip from IMAP to POP3
if ($this->protocol == 'pop3') {
$this->mailbox = 'INBOX';
}
//If user has selected multiple mailboxes, we only need to test the first mailbox for the connection string.
$a_mailbox = explode(",", $this->mailbox);
$tmpMailbox = isset($a_mailbox[0]) ? $a_mailbox[0] : "";
if ($useSsl == true) {
foreach ($ssl as $k => $service) {
$returnService[$k] = 'foo' . $service;
$serviceArr[$k] = '{' . $this->server_url . ':' . $this->port . '/service=' . $this->protocol . $service . '}' . $tmpMailbox;
}
} else {
foreach ($nonSsl as $k => $service) {
$returnService[$k] = 'foo' . $service;
$serviceArr[$k] = '{' . $this->server_url . ':' . $this->port . '/service=' . $this->protocol . $service . '}' . $tmpMailbox;
}
}
$GLOBALS['log']->debug('---------------STARTING FINDOPTIMUMS LOOP----------------');
$l = 1;
//php imap library will capture c-client library warnings as errors causing good connections to be ignored.
//Check against known warnings to ensure good connections are used.
$acceptableWarnings = array(
"SECURITY PROBLEM: insecure server advertised AUTH=PLAIN", //c-client auth_pla.c
"Mailbox is empty"
);
$login = $this->email_user;
$imapConnectionOptions = 0;
[$passw, $imapConnectionOptions] = $this->getOAuthCredentials($this->email_password, $imapConnectionOptions);
if (!empty($this->connection_string)) {
$returnService = [];
$serviceArr = [];
$this->overrideConnectionConfigs($returnService, $serviceArr, $tmpMailbox);
}
$foundGoodConnection = false;
foreach ($serviceArr as $k => $serviceTest) {
$errors = '';
$alerts = '';
$GLOBALS['log']->debug($l . ': I-E testing string: ' . $serviceTest);
// Open the connection and try the test string
$this->conn = $this->getImapConnection($serviceTest, $login, $passw, $imapConnectionOptions);
if (($errors = $this->getImap()->getLastError()) || ($alerts = $this->getImap()->getAlerts()) || !$this->conn) {
// login failure means don't bother trying the rest
if ($errors == 'Too many login failures'
|| $errors == '[CLOSED] IMAP connection broken (server response)'
// @link http://tools.ietf.org/html/rfc5530#section-3
|| strpos((string) $errors, '[AUTHENTICATIONFAILED]') !== false
// MS Exchange 2010
|| (strpos((string) $errors, 'AUTHENTICATE') !== false && strpos((string) $errors, 'failed') !== false)
) {
$GLOBALS['log']->debug($l . ': I-E failed using [' . $serviceTest . ']');
$retArray['err'][$k] = $mod_strings['ERR_BAD_LOGIN_PASSWORD'];
$retArray['bad'][$k] = $serviceTest;
$GLOBALS['log']->debug($l . ': I-E ERROR: $ie->findOptimums() failed due to bad user credentials for user login: ' . $this->email_user);
return $retArray;
} elseif (in_array($errors, $acceptableWarnings, true)) { // false positive
$GLOBALS['log']->debug($l . ': I-E found good connection but with warnings [' . $serviceTest . '] Errors:' . $errors);
$retArray['good'][$k] = $returnService[$k];
$foundGoodConnection = true;
} else {
$GLOBALS['log']->debug($l . ': I-E failed using [' . $serviceTest . '] - error: ' . $errors);
$retArray['err'][$k] = $errors;
$retArray['bad'][$k] = $serviceTest;
return $retArray;
}
} else {
$GLOBALS['log']->debug($l . ': I-E found good connect using [' . $serviceTest . ']');
$retArray['good'][$k] = $returnService[$k];
$foundGoodConnection = true;
}
if ($this->getImap()->isValidStream($this->getImap()->getConnection())) {
if (!$this->isPop3Protocol()) {
$serviceTest = str_replace("INBOX", "", (string) $serviceTest);
$boxes = $this->getImap()->getMailboxes($serviceTest, "*");
$delimiter = '.';
// clean MBOX path names
foreach ($boxes as $k => $mbox) {
$raw[] = $mbox->name;
if ($mbox->delimiter) {
$delimiter = $mbox->delimiter;
} // if
} // foreach
$this->setSessionInboundDelimiterString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
$delimiter
);
} // if
if (!$this->getImap()->close()) {
$GLOBALS['log']->debug('imap_close() failed!');
}
}
$GLOBALS['log']->debug($l . ': I-E clearing error and alert stacks.');
$this->getImap()->getErrors(); // clear stacks
$this->getImap()->getAlerts();
// If you find a good connection, then don't do any further testing to find URL
if ($foundGoodConnection) {
break;
} // if
$l++;
}
$GLOBALS['log']->debug('---------------end FINDOPTIMUMS LOOP----------------');
if (!empty($retArray['good'])) {
$newTls = '';
$newCert = '';
$newSsl = '';
$newNotls = '';
$secure = '';
$newNovalidate_cert = '';
$good = array_pop($retArray['good']); // get most complete string
$exGood = explode('/', $good);
foreach ($exGood as $v) {
switch ($v) {
case 'ssl':
$newSsl = 'ssl';
break;
case 'tls':
$newTls = 'tls';
break;
case 'notls':
$newNotls = 'notls';
break;
case 'cert':
$newCert = 'validate-cert';
break;
case 'novalidate-cert':
$newNovalidate_cert = 'novalidate-cert';
break;
case 'secure':
$secure = 'secure';
break;
}
}
$goodStr['serial'] = $newTls . '::' . $newCert . '::' . $newSsl . '::' . $this->protocol . '::' .
$newNovalidate_cert . '::' . $newNotls . '::' . $secure;
$goodStr['service'] = $good;
$testConnectString = str_replace('foo', '', (string) $good);
$testConnectString = '{' . $this->server_url . ':' . $this->port . '/service=' . $this->protocol .
$testConnectString . '}';
if (!empty($this->connection_string)) {
$testConnectString = '{' . $this->connection_string . '}';
}
$this->setSessionConnectionString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
$goodStr
);
$i = 0;
// $raw given values only if pop3 is set
foreach ($raw as $mbox) {
$raw[$i] = str_replace(
$testConnectString,
"",
(string) $GLOBALS['locale']->translateCharset($mbox, "UTF7-IMAP", "UTF8")
);
$i++;
} // foreach
sort($raw);
$this->setSessionInboundFoldersString(
$this->server_url,
$this->email_user,
$this->port,
$this->protocol,
implode(",", $raw)
);
return $goodStr;
}
return false;
}
public function getSessionConnectionString($server_url, $email_user, $port, $protocol)
{
$sessionConnectionString = $server_url . $email_user . $port . $protocol;
return (isset($_SESSION[$sessionConnectionString]) ? $_SESSION[$sessionConnectionString] : "");
}
public function setSessionConnectionString($server_url, $email_user, $port, $protocol, $goodStr)
{
$sessionConnectionString = $server_url . $email_user . $port . $protocol;
$_SESSION[$sessionConnectionString] = $goodStr;
}
public function getSessionInboundDelimiterString($server_url, $email_user, $port, $protocol)
{
$sessionInboundDelimiterString = $server_url . $email_user . $port . $protocol . "delimiter";
return (isset($_SESSION[$sessionInboundDelimiterString]) ? $_SESSION[$sessionInboundDelimiterString] : "");
}
public function setSessionInboundDelimiterString($server_url, $email_user, $port, $protocol, $delimiter)
{
$sessionInboundDelimiterString = $server_url . $email_user . $port . $protocol . "delimiter";
$_SESSION[$sessionInboundDelimiterString] = $delimiter;
}
public function getSessionInboundFoldersString($server_url, $email_user, $port, $protocol)
{
$sessionInboundFoldersListString = $server_url . $email_user . $port . $protocol . "foldersList";
return (isset($_SESSION[$sessionInboundFoldersListString]) ? $_SESSION[$sessionInboundFoldersListString] : "");
}
public function setSessionInboundFoldersString($server_url, $email_user, $port, $protocol, $foldersList)
{
$sessionInboundFoldersListString = $server_url . $email_user . $port . $protocol . "foldersList";
$_SESSION[$sessionInboundFoldersListString] = $foldersList;
}
/**
* Checks for duplicate Group User names when creating a new one at save()
* @return GUID returns GUID of Group User if user_name match is
* found
* @return boolean false if NO DUPE IS FOUND
*/
public function groupUserDupeCheck()
{
$q = "SELECT u.id FROM users u WHERE u.deleted=0 AND u.is_group=1 AND u.user_name = '" . $this->name . "'";
$r = $this->db->query($q, true);
$uid = '';
while ($a = $this->db->fetchByAssoc($r)) {
$uid = $a['id'];
}
if (strlen((string) $uid) > 0) {
return $uid;
}
return false;
}
/**
* Returns <option> markup with the contents of Group users
* @param array $groups default empty array
* @return string HTML options
*/
public function getGroupsWithSelectOptions($groups = array())
{
$r = $this->db->query('SELECT id, user_name FROM users WHERE users.is_group = 1 AND deleted = 0', true);
if (is_resource($r)) {
while ($a = $this->db->fetchByAssoc($r)) {
$groups[$a['id']] = $a['user_name'];
}
}
$selectOptions = get_select_options_with_id_separate_key($groups, $groups, $this->group_id);
return $selectOptions;
}
/**
* handles auto-responses to inbound emails
*
* @param object email Email passed as reference
*/
public function handleAutoresponse(&$email, &$contactAddr)
{
$storedOptions = [];
$aName = [];
$aAddr = [];
$to = [];
if ($this->template_id) {
$GLOBALS['log']->debug('found auto-reply template id - prefilling and mailing response');
if ($this->getAutoreplyStatus($contactAddr)
&& $this->checkOutOfOffice($email->name)
&& $this->checkFilterDomain($email)
) { // if we haven't sent this user 10 replies in 24hours
if (!empty($this->stored_options)) {
$storedOptions = sugar_unserialize(base64_decode($this->stored_options));
}
// get FROM NAME
if (!empty($storedOptions['from_name'])) {
$from_name = $storedOptions['from_name'];
$GLOBALS['log']->debug('got from_name from storedOptions: ' . $from_name);
} else { // use system default
$rName = $this->db->query('SELECT value FROM config WHERE name = \'fromname\'', true);
if (is_resource($rName)) {
$aName = $this->db->fetchByAssoc($rName);
}
if (!empty($aName['value'])) {
$from_name = $aName['value'];
} else {
$from_name = '';
}
}
// get FROM ADDRESS
if (!empty($storedOptions['from_addr'])) {
$from_addr = $storedOptions['from_addr'];
isValidEmailAddress($from_addr);
} else {
$rAddr = $this->db->query('SELECT value FROM config WHERE name = \'fromaddress\'', true);
if (is_resource($rAddr)) {
$aAddr = $this->db->fetchByAssoc($rAddr);
}
if (!empty($aAddr['value'])) {
$from_addr = $aAddr['value'];
isValidEmailAddress($from_addr);
} else {
$from_addr = '';
}
}
$replyToName = (!empty($storedOptions['reply_to_name'])) ? from_html($storedOptions['reply_to_name']) : $from_name;
$replyToAddr = (!empty($storedOptions['reply_to_addr'])) ? $storedOptions['reply_to_addr'] : $from_addr;
isValidEmailAddress($replyToAddr);
if (!empty($email->reply_to_email)) {
$to[0]['email'] = $email->reply_to_email;
} else {
$to[0]['email'] = $email->from_addr;
}
isValidEmailAddress($to[0]['email']);
// handle to name: address, prefer reply-to
if (!empty($email->reply_to_name)) {
$to[0]['display'] = $email->reply_to_name;
} elseif (!empty($email->from_name)) {
$to[0]['display'] = $email->from_name;
}
$et = BeanFactory::newBean('EmailTemplates');
$et->retrieve($this->template_id);
if (empty($et->subject)) {
$et->subject = '';
}
if (empty($et->body)) {
$et->body = '';
}
if (empty($et->body_html)) {
$et->body_html = '';
}
$reply = BeanFactory::newBean('Emails');
$reply->type = 'out';
$reply->to_addrs = $to[0]['email'];
$reply->to_addrs_arr = $to;
$reply->cc_addrs_arr = array();
$reply->bcc_addrs_arr = array();
$reply->from_name = $from_name;
$reply->from_addr = $from_addr;
isValidEmailAddress($reply->from_addr);
$reply->name = $et->subject;
$reply->description = $et->body;
$reply->description_html = $et->body_html;
$reply->reply_to_name = $replyToName;
$reply->reply_to_addr = $replyToAddr;
$attachments = $et->getAttachments();
if (!empty($attachments)) {
$reply->attachments = array_merge($reply->attachments, $attachments);
$reply->handleAttachments();
}
$GLOBALS['log']->debug('saving and sending auto-reply email');
//$reply->save(); // don't save the actual email.
$reply->send();
$this->setAutoreplyStatus($contactAddr);
} else {
$GLOBALS['log']->debug('InboundEmail: auto-reply threshold reached for email (' . $contactAddr . ') - not sending auto-reply');
}
}
}
public function handleCaseAssignment($email)
{
$c = BeanFactory::newBean('Cases');
if ($caseId = $this->getCaseIdFromCaseNumber($email->name, $c)) {
$c->retrieve($caseId);
$email->retrieve($email->id);
//assign the case info to parent id and parent type so that the case can be linked to the email on Email Save
$email->parent_type = "Cases";
$email->parent_id = $caseId;
// assign the email to the case owner
$email->assigned_user_id = $c->assigned_user_id;
$email->save();
$GLOBALS['log']->debug('InboundEmail found exactly 1 match for a case: ' . $c->name);
return true;
} // if
return false;
} // fn
/**
* handles functionality specific to the Mailbox type (Cases, bounced
* campaigns, etc.)
*
* @param object email Email object passed as a reference
* @param object header Header object generated by imap_headerinfo();
*/
public function handleMailboxType(&$email, &$header)
{
switch ($this->mailbox_type) {
case 'support':
$this->handleCaseAssignment($email);
break;
case 'bug':
break;
case 'info':
// do something with this?
break;
case 'sales':
// do something with leads? we don't have an email_leads table
break;
case 'task':
// do something?
break;
case 'bounce':
require_once('modules/Campaigns/ProcessBouncedEmails.php');
campaign_process_bounced_emails($email, $header);
break;
case 'pick': // do all except bounce handling
$GLOBALS['log']->debug('looking for a case for ' . $email->name);
$this->handleCaseAssignment($email);
break;
}
}
public function isMailBoxTypeCreateCase()
{
return ($this->mailbox_type == 'createcase' && !empty($this->groupfolder_id));
} // fn
public function handleCreateCase(Email $email, $userId)
{
global $current_user, $mod_strings, $current_language;
$to = [];
$mod_strings = return_module_language($current_language, "Emails");
$GLOBALS['log']->debug('In handleCreateCase');
$c = BeanFactory::newBean('Cases');
$this->getCaseIdFromCaseNumber($email->name, $c);
if (!$this->handleCaseAssignment($email) && $this->isMailBoxTypeCreateCase()) {
// create a case
$GLOBALS['log']->debug('retrieveing email');
$email->retrieve($email->id);
$c = BeanFactory::newBean('Cases');
$c->description = $email->description;
$c->assigned_user_id = $userId;
$c->name = $email->name;
$c->status = 'Open_New';
if (!empty($email->reply_to_email)) {
$contactAddr = $email->reply_to_email;
} else {
$contactAddr = $email->from_addr;
isValidEmailAddress($contactAddr);
}
$GLOBALS['log']->debug('finding related accounts with address ' . $contactAddr);
if ($accountIds = $this->getRelatedId($contactAddr, 'accounts')) {
if ((is_countable($accountIds) ? count($accountIds) : 0) == 1) {
$c->account_id = $accountIds[0];
$acct = BeanFactory::newBean('Accounts');
$acct->retrieve($c->account_id);
$c->account_name = $acct->name;
} // if
} // if
$c->save(true);
$c->retrieve($c->id);
if ($c->load_relationship('emails')) {
$c->emails->add($email->id);
} // if
if ($contactIds = $this->getRelatedId($contactAddr, 'contacts')) {
if (!empty($contactIds) && $c->load_relationship('contacts')) {
if (!$accountIds && (is_countable($contactIds) ? count($contactIds) : 0) == 1) {
$contact = BeanFactory::getBean('Contacts', $contactIds[0]);
if ($contact->load_relationship('accounts')) {
$acct = $contact->accounts->get();
if ($c->load_relationship('accounts') && !empty($acct[0])) {
$c->accounts->add($acct[0]);
}
}
}
$c->contacts->add($contactIds);
} // if
} // if
$c->email_id = $email->id;
$email->parent_type = "Cases";
$email->parent_id = $c->id;
// assign the email to the case owner
$email->assigned_user_id = $c->assigned_user_id;
$email->name = str_replace('%1', $c->case_number, (string) $c->getEmailSubjectMacro()) . " " . $email->name;
$email->save();
$GLOBALS['log']->debug('InboundEmail created one case with number: ' . $c->case_number);
$createCaseTemplateId = $this->get_stored_options('create_case_email_template', "");
if (!empty($this->stored_options)) {
$storedOptions = sugar_unserialize(base64_decode($this->stored_options));
}
if (!empty($createCaseTemplateId)) {
$fromName = "";
$fromAddress = "";
if (!empty($this->stored_options)) {
$fromAddress = $storedOptions['from_addr'];
isValidEmailAddress($fromAddress);
$fromName = from_html($storedOptions['from_name']);
$replyToName = (!empty($storedOptions['reply_to_name'])) ? from_html($storedOptions['reply_to_name']) : $fromName;
$replyToAddr = (!empty($storedOptions['reply_to_addr'])) ? $storedOptions['reply_to_addr'] : $fromAddress;
} // if
$defaults = $current_user->getPreferredEmail();
$fromAddress = (!empty($fromAddress)) ? $fromAddress : $defaults['email'];
$fromName = (!empty($fromName)) ? $fromName : $defaults['name'];
$to[0]['email'] = $contactAddr;
// handle to name: address, prefer reply-to
if (!empty($email->reply_to_name)) {
$to[0]['display'] = $email->reply_to_name;
} elseif (!empty($email->from_name)) {
$to[0]['display'] = $email->from_name;
}
$et = BeanFactory::newBean('EmailTemplates');
$et->retrieve($createCaseTemplateId);
if (empty($et->subject)) {
$et->subject = '';
}
if (empty($et->body)) {
$et->body = '';
}
if (empty($et->body_html)) {
$et->body_html = '';
}
$et->subject = "Re:" . " " . str_replace(
'%1',
$c->case_number,
$c->getEmailSubjectMacro() . " " . $c->name
);
$html = trim($email->description_html);
$plain = trim($email->description);
$email->email2init();
$email->from_addr = $email->from_addr_name;
isValidEmailAddress($email->from_addr);
$email->to_addrs = $email->to_addrs_names;
$email->cc_addrs = $email->cc_addrs_names;
$email->bcc_addrs = $email->bcc_addrs_names;
$email->from_name = $email->from_addr;
$email = $email->et->handleReplyType($email, "reply");
$ret = $email->et->displayComposeEmail($email);
$ret['description'] = empty($email->description_html) ? str_replace(
"\n",
"\n<BR/>",
(string) $email->description
) : $email->description_html;
$reply = BeanFactory::newBean('Emails');
$reply->type = 'out';
$reply->to_addrs = $to[0]['email'];
$reply->to_addrs_arr = $to;
$reply->cc_addrs_arr = array();
$reply->bcc_addrs_arr = array();
$reply->from_name = $fromName;
$reply->from_addr = $fromAddress;
isValidEmailAddress($reply->from_addr);
$reply->reply_to_name = $replyToName;
$reply->reply_to_addr = $replyToAddr;
$reply->name = $et->subject;
$reply->description = $et->body . "<div><hr /></div>" . $email->description;
if (!$et->text_only) {
$reply->description_html = $et->body_html . "<div><hr /></div>" . $email->description;
}
$GLOBALS['log']->debug('saving and sending auto-reply email');
//$reply->save(); // don't save the actual email.
$reply->send();
} // if
} else {
if (!empty($email->reply_to_email)) {
$contactAddr = $email->reply_to_email;
isValidEmailAddress($contactAddr);
} else {
$contactAddr = $email->from_addr;
isValidEmailAddress($contactAddr);
}
$this->handleAutoresponse($email, $contactAddr);
}
} // fn
/**
* handles linking contacts, accounts, etc. to an email
*
* @param object Email bean to be linked against
* @return string contactAddr is the email address of the sender
*/
public function handleLinking(&$email)
{
// link email to an User if emails match TO addr
if ($userIds = $this->getRelatedId($email->to_addrs, 'users')) {
$GLOBALS['log']->debug('I-E linking email to User');
// link the user to the email
$email->load_relationship('users');
$email->users->add($userIds);
}
// link email to a Contact, Lead, or Account if the emails match
// give precedence to REPLY-TO above FROM
if (!empty($email->reply_to_email)) {
$contactAddr = $email->reply_to_email;
isValidEmailAddress($contactAddr);
} else {
$contactAddr = $email->from_addr;
isValidEmailAddress($contactAddr);
}
// Samir Gandhi : 12/06/07
// This changes has been done because the linking was done only with the from address and
// not with to address
$relationShipAddress = $contactAddr;
if (empty($relationShipAddress)) {
$relationShipAddress .= $email->to_addrs;
} else {
$relationShipAddress = $relationShipAddress . "," . $email->to_addrs;
}
if ($leadIds = $this->getRelatedId($relationShipAddress, 'leads')) {
$GLOBALS['log']->debug('I-E linking email to Lead');
$email->load_relationship('leads');
$email->leads->add($leadIds);
foreach ($leadIds as $leadId) {
$lead = BeanFactory::newBean('Leads');
$lead->retrieve($leadId);
$lead->load_relationship('emails');
$lead->emails->add($email->id);
}
}
if ($contactIds = $this->getRelatedId($relationShipAddress, 'contacts')) {
$GLOBALS['log']->debug('I-E linking email to Contact');
// link the contact to the email
$email->load_relationship('contacts');
$email->contacts->add($contactIds);
}
if ($accountIds = $this->getRelatedId($relationShipAddress, 'accounts')) {
$GLOBALS['log']->debug('I-E linking email to Account');
// link the account to the email
$email->load_relationship('accounts');
$email->accounts->add($accountIds);
}
return $contactAddr;
}
/**
* Gets part by following breadcrumb path
* @param string $bc the breadcrumb string in format (1.1.1)
* @param array parts the root level parts array
*/
protected function getPartByPath($bc, $parts)
{
if (strstr($bc, '.')) {
$exBc = explode('.', $bc);
} else {
$exBc = array($bc);
}
foreach ($exBc as $step) {
if (empty($parts)) {
return false;
}
$res = isset($parts[$step - 1]) ? $parts[$step - 1] : null; // MIME starts with 1, array starts with 0
if (!empty($res->parts)) {
$parts = $res->parts;
} else {
$parts = false;
}
}
return $res;
}
/**
* takes a breadcrumb and returns the encoding at that level
* @param string bc the breadcrumb string in format (1.1.1)
* @param array parts the root level parts array
* @return int retInt Int key to transfer encoding (see handleTranserEncoding())
*/
public function getEncodingFromBreadCrumb($bc, $parts)
{
$exBc = [];
if (strstr((string) $bc, '.')) {
$exBc = explode('.', $bc);
} else {
$exBc[0] = $bc;
}
$depth = count($exBc);
$tempObj = [];
for ($i = 0; $i < $depth; $i++) {
$tempObj[$i] = $parts[($exBc[$i] - 1)];
$retInt = $this->getImap()->utf8($tempObj[$i]->encoding);
if (!empty($tempObj[$i]->parts)) {
$parts = $tempObj[$i]->parts;
}
}
return $retInt;
}
/**
* retrieves the charset for a given part of an email body
*
* @param string bc target part of the message in format (1.1.1)
* @param array parts 1 level above ROOT array of Objects representing a multipart body
* @return string charset name
*/
public function getCharsetFromBreadCrumb($bc, $parts)
{
$tempObj = $this->getPartByPath($bc, $parts);
// now we have the tempObj at the end of the breadCrumb trail
if (!empty($tempObj->ifparameters)) {
foreach ($tempObj->parameters as $param) {
if (strtolower($param->attribute) == 'charset') {
return $param->value;
}
}
}
return 'default';
}
/**
* Get the message text from a single mime section, html or plain.
*
* @param string $msgNo
* @param string $section
* @param stdObject $structure
* @return string|boolean
*/
public function getMessageTextFromSingleMimePart($msgNo, $section, $structure)
{
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email Connection in not a valid resource for getting message text from a single mime part.');
return false;
}
$msgPartTmp = $this->getImap()->fetchBody($msgNo, $section);
$enc = $this->getEncodingFromBreadCrumb($section, $structure->parts);
$charset = $this->getCharsetFromBreadCrumb($section, $structure->parts);
$msgPartTmp = $this->handleTranserEncoding($msgPartTmp, $enc);
return $this->handleCharsetTranslation($msgPartTmp, $charset);
}
public function getMessageTextFromSingleMimePartWithUid($uid, $section, $structure)
{
$msgPartTmp = $this->getImap()->fetchBody($uid, $section, FT_UID);
$enc = $this->getEncodingFromBreadCrumb($section, $structure->parts);
$charset = $this->getCharsetFromBreadCrumb($section, $structure->parts);
$msgPartTmp = $this->handleTranserEncoding($msgPartTmp, $enc);
return $this->handleCharsetTranslation($msgPartTmp, $charset);
}
/**
* Givin an existing breadcrumb add a cooresponding offset
*
* @param string $bc
* @param string $offset
* @return string
*/
public function addBreadCrumbOffset($bc, $offset)
{
if ((empty($bc) || is_null($bc)) && !empty($offset)) {
return $offset;
}
$a_bc = explode(".", $bc);
$a_offset = explode(".", $offset);
if (count($a_bc) < count($a_offset)) {
$a_bc = array_merge($a_bc, array_fill(count($a_bc), count($a_offset) - count($a_bc), 0));
}
$results = array();
$a_bcCount = count($a_bc);
for ($i = 0; $i < $a_bcCount; $i++) {
if (isset($a_offset[$i])) {
if (!is_numeric($a_bc[$i])) {
$aBcI = 0;
} else {
$aBcI = $a_bc[$i];
}
if (!is_numeric($a_offset[$i])) {
$aOffsetI = 0;
} else {
$aOffsetI = $a_offset[$i];
}
$results[] = $aBcI + $aOffsetI;
} else {
$results[] = $a_bc[$i];
}
}
return implode(".", $results);
}
/**
* returns the HTML text part of a multi-part message
*
* @param $uid
* @param string $type the type of text processed, either 'PLAIN' or 'HTML'
* @param null $structure
* @param null $fullHeader
* @param bool $clean_email
* @param string $bcOffset
* @return string UTF-8 encoded version of the requested message text
*/
public function getMessageTextWithUid(
$uid,
$type = null,
$structure = null,
$fullHeader = null,
$clean_email = true,
$bcOffset = ''
) {
$emailBody = $this->imap->fetchBody($uid, '', FT_UID);
if (!empty($type) && strtolower($type) === 'text/plain') {
$emailMessage = $this->mailParser->parse($emailBody, false)->getTextContent();
$emailMessage = $this->handleInlineImages($emailBody, $emailMessage);
$emailMessage = $this->customGetMessageText($emailMessage);
return SugarCleaner::cleanHtml($emailMessage, false);
}
$emailMessage = $this->mailParser->parse($emailBody, false)->getHtmlContent();
$emailMessage = $this->handleInlineImages($emailBody, $emailMessage);
$emailMessage = $this->customGetMessageText($emailMessage);
return SugarCleaner::cleanHtml($emailMessage, $clean_email);
}
/**
* Returns email HTML with visible inline images.
* @param string $email
* @param string $emailHTML
* @return mixed|string
*/
protected function handleInlineImages($email, $emailHTML)
{
foreach ($this->mailParser->parse($email, false)->getAllAttachmentParts() as $attachment) {
$disposition = $attachment->getContentDisposition();
if ($disposition === 'inline') {
$fileName = $attachment->getFilename();
$fileID = $attachment->getContentId();
foreach ($this->tempAttachment as $temp) {
if ($temp === $fileName) {
$fileKey = array_search($fileName, $this->tempAttachment, false);
$filePrefix = "{$GLOBALS['sugar_config']['site_url']}/cache/images/";
$pos = strrpos($fileName, '.');
$fileType = $pos === false ? $fileName : substr($fileName, $pos + 1);
$fileName = $filePrefix . $fileKey . '.' . $fileType;
$newImagePath = "class=\"image\" src=\"{$fileName}\"";
$preImagePath = "src=\"cid:$fileID\"";
$emailHTML = str_replace($preImagePath, $newImagePath, $emailHTML);
}
}
}
}
return $emailHTML;
}
/**
* @param $uid
* @param $type
* @param $structure
* @param $fullHeader
* @param bool $clean_email
* @param string $bcOffset
* @return string|false
*/
public function getMessageText($uid, $type, $structure, $fullHeader, $clean_email = true, $bcOffset = "")
{
if (!$structure) {
LoggerManager::getLogger()->fatal('Trying to get message text with no structure.');
return false;
}
global $sugar_config;
$msgPart = '';
$bc = $this->buildBreadCrumbs(($structure->parts) ? $structure->parts : null, $type);
//Add an offset if specified
if (!empty($bcOffset)) {
$bc = $this->addBreadCrumbOffset($bc, $bcOffset);
}
if (!empty($bc)) { // multi-part
// HUGE difference between PLAIN and HTML
if ($type == 'PLAIN') {
$msgPart = $this->getMessageTextFromSingleMimePart($uid, $bc, $structure);
} else {
// get part of structure that will
$msgPartRaw = '';
$bcArray = $this->buildBreadCrumbsHTML($structure->parts, $bcOffset);
// construct inline HTML/Rich msg
foreach ($bcArray as $bcArryKey => $bcArr) {
foreach ($bcArr as $type => $bcTrail) {
if ($type == 'html') {
$msgPartRaw .= $this->getMessageTextFromSingleMimePart($uid, $bcTrail, $structure);
} else {
// deal with inline image
$part = $this->getPartByPath($bcTrail, $structure->parts);
if (empty($part) || empty($part->id)) {
continue;
}
$partid = substr((string) $part->id, 1, -1); // strip <> around
if (isset($this->inlineImages[$partid])) {
$imageName = $this->inlineImages[$partid];
$newImagePath = "class=\"image\" src=\"{$this->imagePrefix}{$imageName}\"";
$preImagePath = "src=\"cid:$partid\"";
$msgPartRaw = str_replace($preImagePath, $newImagePath, $msgPartRaw);
}
}
}
}
$msgPart = $msgPartRaw;
}
} else { // either PLAIN message type (flowed) or b0rk3d RFC
// make sure we're working on valid data here.
if ($structure->subtype != $type) {
return '';
}
$decodedHeader = $this->decodeHeader($fullHeader);
// now get actual body contents
$text = $this->getImap()->getBody($uid);
$upperCaseKeyDecodeHeader = array();
if (is_array($decodedHeader)) {
$upperCaseKeyDecodeHeader = array_change_key_case($decodedHeader, CASE_UPPER);
} // if
if (isset($upperCaseKeyDecodeHeader[strtoupper('Content-Transfer-Encoding')])) {
$flip = array_flip($this->transferEncoding);
$text = $this->handleTranserEncoding(
$text,
$flip[strtoupper($upperCaseKeyDecodeHeader[strtoupper('Content-Transfer-Encoding')])]
);
}
if (is_array($upperCaseKeyDecodeHeader['CONTENT-TYPE']) && isset($upperCaseKeyDecodeHeader['CONTENT-TYPE']['charset']) && !empty($upperCaseKeyDecodeHeader['CONTENT-TYPE']['charset'])) {
// we have an explicit content type, use it
$msgPart = $this->handleCharsetTranslation($text, $upperCaseKeyDecodeHeader['CONTENT-TYPE']['charset']);
} else {
// make a best guess as to what our content type is
$msgPart = $this->convertToUtf8($text);
}
} // end else clause
$msgPart = $this->customGetMessageText($msgPart);
/* cn: bug 9176 - htmlEntitites hide XSS attacks. */
if ($type == 'PLAIN') {
return SugarCleaner::cleanHtml(to_html($msgPart), false);
}
// Bug 50241: can't process <?xml:namespace .../> properly. Strip <?xml ...> tag first.
$msgPart = preg_replace("/<\?xml[^>]*>/", "", $msgPart);
return SugarCleaner::cleanHtml($msgPart, true);
}
/**
* decodes raw header information and passes back an associative array with
* the important elements key'd by name
* @param header string the raw header
* @return decodedHeader array the associative array
*/
public function decodeHeader($fullHeader)
{
$decodedHeader = array();
$exHeaders = explode("\r", $fullHeader);
if (!is_array($exHeaders)) {
$exHeaders = explode("\r\n", $fullHeader);
}
$quotes = array('"', "'");
foreach ($exHeaders as $lineNum => $head) {
$key = '';
$key = trim(substr($head, 0, strpos($head, ':')));
$value = '';
$value = trim(substr($head, (strpos($head, ':') + 1), strlen($head)));
// handle content-type section in headers
if (strtolower($key) == 'content-type' && strpos($value, ';')) {
// ";" means something follows related to (such as Charset)
$semiColPos = mb_strpos($value, ';');
$strLenVal = mb_strlen($value);
if (($semiColPos + 4) >= $strLenVal) {
// the charset="[something]" is on the next line
$value .= str_replace($quotes, "", trim($exHeaders[$lineNum + 1]));
}
$newValue = array();
$exValue = explode(';', $value);
$newValue['type'] = $exValue[0];
$exValueCount = count($exValue);
for ($i = 1; $i < $exValueCount; $i++) {
$exContent = explode('=', $exValue[$i]);
$newValue[trim($exContent[0])] = trim($exContent[1], "\t \"");
}
$value = $newValue;
}
if (!empty($key) && !empty($value)) {
$decodedHeader[$key] = $value;
}
}
return $decodedHeader;
}
/**
* handles translating message text from orignal encoding into UTF-8
*
* @param string text test to be re-encoded
* @param string charset original character set
* @return string utf8 re-encoded text
*/
public function handleCharsetTranslation($text, $charset)
{
global $locale;
if (empty($charset)) {
$GLOBALS['log']->debug("***ERROR: InboundEmail::handleCharsetTranslation() called without a \$charset!");
return $text;
}
// typical headers have no charset - let destination pick (since it's all ASCII anyways)
if (strtolower($charset) == 'default' || strtolower($charset) == 'utf-8') {
return $text;
}
return $locale->translateCharset($text, $charset);
}
/**
* Builds up the "breadcrumb" trail that imap_fetchbody() uses to return
* parts of an email message, including attachments and inline images
* @param $parts array of objects
* @param $subtype what type of trail to return? HTML? Plain? binaries?
* @param $breadcrumb text trail to build up
*/
public function buildBreadCrumbs($parts, $subtype, $breadcrumb = '0')
{
// loop through available parts in the array
foreach ($parts as $k => $part) {
// mark passage through level
$thisBc = ($k + 1);
// if this is not the first time through, start building the map
if ($breadcrumb != 0) {
$thisBc = $breadcrumb . '.' . $thisBc;
}
// found a multi-part/mixed 'part' - keep digging
if ($part->type == 1 && (strtoupper($part->subtype) == 'RELATED' || strtoupper($part->subtype) == 'ALTERNATIVE' || strtoupper($part->subtype) == 'MIXED')) {
$thisBc = $this->buildBreadCrumbs($part->parts, $subtype, $thisBc);
return $thisBc;
} elseif (strtolower($part->subtype) === strtolower($subtype)) { // found the subtype we want, return the breadcrumb value
return $thisBc;
}
}
}
/**
* Similar to buildBreadCrumbs() but returns an ordered array containing all parts of the message that would be
* considered "HTML" or Richtext (embedded images, formatting, etc.).
* @param array parts Array of parts of a message
* @param int breadcrumb Passed integer value to start breadcrumb trail
* @param array stackedBreadcrumbs Persistent trail of breadcrumbs
* @return array Ordered array of parts to retrieve via imap_fetchbody()
*/
public function buildBreadCrumbsHTML($parts, $breadcrumb = '0', $stackedBreadcrumbs = array())
{
$subtype = 'HTML';
$disposition = 'inline';
foreach ($parts as $k => $part) {
// mark passage through level
$thisBc = ($k + 1);
if ($breadcrumb != 0) {
$thisBc = $breadcrumb . '.' . $thisBc;
}
// found a multi-part/mixed 'part' - keep digging
if ($part->type == 1 && (strtoupper($part->subtype) == 'RELATED' || strtoupper($part->subtype) == 'ALTERNATIVE' || strtoupper($part->subtype) == 'MIXED')) {
$stackedBreadcrumbs = $this->buildBreadCrumbsHTML($part->parts, $thisBc, $stackedBreadcrumbs);
} elseif (
(strtolower($part->subtype) == strtolower($subtype)) ||
(
isset($part->disposition) && strtolower($part->disposition) == 'inline' &&
in_array(strtoupper($part->subtype), $this->imageTypes)
)
) {
// found the subtype we want, return the breadcrumb value
$stackedBreadcrumbs[] = array(strtolower($part->subtype) => $thisBc);
} elseif ($part->type == 5) {
$stackedBreadcrumbs[] = array(strtolower($part->subtype) => $thisBc);
}
}
return $stackedBreadcrumbs;
}
/**
* Takes a PHP imap_* object's to/from/cc/bcc address field and converts it
* to a standard string that SugarCRM expects
* @param $arr an array of email address objects
*/
public function convertImapToSugarEmailAddress($arr)
{
if (is_array($arr)) {
$addr = '';
foreach ($arr as $key => $obj) {
$addr .= $obj->mailbox . '@' . $obj->host . ', ';
}
// strip last comma
$ret = substr_replace($addr, '', -2, -1);
return trim($ret);
}
}
/**
* tries to figure out what character set a given filename is using and
* decode based on that
*
* @param string name Name of attachment
* @return string decoded name
*/
public function handleEncodedFilename($name)
{
$imapDecode = $this->getImap()->mimeHeaderDecode($name);
/******************************
* $imapDecode => stdClass Object
* (
* [charset] => utf-8
* [text] => w<>hlen.php
* )
*
* OR
*
* $imapDecode => stdClass Object
* (
* [charset] => default
* [text] => UTF-8''%E3%83%8F%E3%82%99%E3%82%A4%E3%82%AA%E3%82%AF%E3%82%99%E3%83%A9%E3%83%95%E3%82%A3%E3%83%BC.txt
* )
*******************************/
if ($imapDecode[0]->charset != 'default') { // mime-header encoded charset
$encoding = $imapDecode[0]->charset;
$name = $imapDecode[0]->text; // encoded in that charset
} else {
/* encoded filenames are formatted as [encoding]''[filename] */
if (strpos((string) $name, "''") !== false) {
$encoding = substr((string) $name, 0, strpos((string) $name, "'"));
while (strpos((string) $name, "'") !== false) {
$name = trim(substr((string) $name, (strpos((string) $name, "'") + 1), strlen((string) $name)));
}
}
$name = urldecode($name);
}
return ((isset($encoding) && strtolower($encoding) == 'utf-8') ? $name : isset($encoding)) ? $GLOBALS['locale']->translateCharset(
$name,
$encoding,
'UTF-8'
) : $name;
}
/*
Primary body types for a part of a mail structure (imap_fetchstructure returned object)
0 => text
1 => multipart
2 => message
3 => application
4 => audio
5 => image
6 => video
7 => other
*/
/**
* Primary body types for a part of a mail structure (imap_fetchstructure returned object)
* @var array $imap_types
*/
public $imap_types = array(
0 => 'text',
1 => 'multipart',
2 => 'message',
3 => 'application',
4 => 'audio',
5 => 'image',
6 => 'video',
);
public function getMimeType($type, $subtype)
{
if (isset($this->imap_types[$type])) {
return $this->imap_types[$type] . "/$subtype";
}
return "other/$subtype";
}
/**
* Takes the "parts" attribute of the object that imap_fetchbody() method
* returns, and recursively goes through looking for objects that have a
* disposition of "attachement" or "inline"
* @param int $msgNo The relative message number for the monitored mailbox
* @param object $parts Array of objects to examine
* @param string $emailId The GUID of the email saved prior to calling this method
* @param array $breadcrumb Default 0, build up of the parts mapping
* @param bool $forDisplay Default false
*/
public function saveAttachments($msgNo, $parts, $emailId, $breadcrumb, $forDisplay = null)
{
global $sugar_config;
/*
Primary body types for a part of a mail structure (imap_fetchstructure returned object)
0 => text
1 => multipart
2 => message
3 => application
4 => audio
5 => image
6 => video
7 => other
*/
// set $breadcrumb = '0' as default
if (!$breadcrumb) {
$breadcrumb = '0';
}
foreach ($parts as $k => $part) {
$thisBc = $k + 1;
if ($breadcrumb != '0') {
$thisBc = $breadcrumb . '.' . $thisBc;
}
$attach = null;
// check if we need to recurse into the object
//if($part->type == 1 && !empty($part->parts)) {
if (isset($part->parts) && !empty($part->parts) && !(isset($part->subtype) && strtolower($part->subtype) == 'rfc822')) {
$this->saveAttachments($msgNo, $part->parts, $emailId, $thisBc, $forDisplay);
continue;
} elseif ($part->ifdisposition) {
// we will take either 'attachments' or 'inline'
if (strtolower($part->disposition) == 'attachment' || ((strtolower($part->disposition) == 'inline') && $part->type != 0)) {
$attach = $this->getNoteBeanForAttachment($emailId);
$fname = $this->handleEncodedFilename($this->retrieveAttachmentNameFromStructure($part));
if (!empty($fname)) {//assign name to attachment
$attach->name = $fname;
} else {//if name is empty, default to filename
$attach->name = urlencode($this->retrieveAttachmentNameFromStructure($part));
}
$attach->filename = $attach->name;
if (empty($attach->filename)) {
continue;
}
// deal with the MIME types email has
$attach->file_mime_type = $this->getMimeType($part->type, $part->subtype);
$attach->safeAttachmentName();
if ($forDisplay) {
$attach->id = $this->getTempFilename();
} else {
// only save if doing a full import, else we want only the binaries
$attach->save();
}
} // end if disposition type 'attachment'
}// end ifdisposition
//Retrieve contents of subtype rfc8822
elseif ($part->type == 2 && isset($part->subtype) && (strtolower($part->subtype) == 'rfc822' || strtolower($part->subtype) == 'delivery-status')) {
$attach = $this->getNoteBeanForAttachment($emailId);
$attach->file_mime_type = 'message/' . strtolower($part->subtype);
$attach->filename = 'bounce-' . strtolower($part->subtype) . '.txt';
$attach->safeAttachmentName();
if ($forDisplay) {
$attach->id = $this->getTempFilename();
} else {
// only save if doing a full import, else we want only the binaries
$attach->save();
}
} elseif (!$part->ifdisposition && $part->type != 1 && $part->type != 2 && $thisBc != '1') {
// No disposition here, but some IMAP servers lie about disposition headers, try to find the truth
// Also Outlook puts inline attachments as type 5 (image) without a disposition
if ($part->ifparameters) {
foreach ($part->parameters as $param) {
if (strtolower($param->attribute) == "name" || strtolower($param->attribute) == "filename") {
$fname = $this->handleEncodedFilename($param->value);
break;
}
}
if (empty($fname)) {
continue;
}
// we assume that named parts are attachments too
$attach = $this->getNoteBeanForAttachment($emailId);
$attach->filename = $attach->name = $fname;
$attach->file_mime_type = $this->getMimeType($part->type, $part->subtype);
$attach->safeAttachmentName();
if ($forDisplay) {
$attach->id = $this->getTempFilename();
} else {
// only save if doing a full import, else we want only the binaries
$attach->save();
}
}
}
$this->saveAttachmentBinaries($attach, $msgNo, $thisBc, $part, $forDisplay);
} // end foreach
}
/**
* Return a new note object for attachments.
*
* @param string $emailId
* @return Note
*/
public function getNoteBeanForAttachment($emailId)
{
$attach = BeanFactory::newBean('Notes');
$attach->parent_id = $emailId;
$attach->parent_type = 'Emails';
return $attach;
}
/**
* Return the filename of the attachment by examining the dparameters or parameters returned from imap_fetch_structure
*
* @param object $part
* @return string
*/
public function retrieveAttachmentNameFromStructure($part)
{
$result = "";
foreach ($part->dparameters as $k => $v) {
if (strtolower($v->attribute) == 'filename') {
$result = $v->value;
break;
}
}
if (empty($result)) {
foreach ($part->parameters as $k => $v) {
if (strtolower($v->attribute) == 'name') {
$result = $v->value;
break;
}
}
}
return $result;
}
/**
* saves the actual binary file of a given attachment
* @param object attach Note object that is attached to the binary file
* @param string msgNo Message Number on IMAP/POP3 server
* @param string thisBc Breadcrumb to navigate email structure to find the content
* @param object part IMAP standard object that contains the "parts" of this section of email
* @param bool $forDisplay
*/
public function saveAttachmentBinaries($attach, $msgNo, $thisBc, $part, $forDisplay)
{
$cacheDir = $GLOBALS['sugar_config']['cache_dir'] . 'images/';
if (isset($attach->id) &&
strpos((string) $attach->id, "..") !== false &&
$this->id !== null &&
strpos((string) $this->id, "..") !== false
) {
die("Directory navigation attack denied.");
}
$uploadDir = ($forDisplay) ? "{$this->EmailCachePath}/{$this->id}/attachments/" : "upload://";
// decide what name to save file as
$fileName = htmlspecialchars((string) $attach->id);
// download the attachment if we didn't do it yet
if (!file_exists($uploadDir . $fileName)) {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbounc Email Connection is not valid resource for saving attachment binaries.');
return false;
}
$msgPartRaw = $this->getImap()->fetchBody($msgNo, $thisBc);
// deal with attachment encoding and decode the text string
$msgPart = $this->handleTranserEncoding($msgPartRaw, $part->encoding);
if (file_put_contents($uploadDir . $fileName, $msgPart)) {
$GLOBALS['log']->debug('InboundEmail saved attachment file: ' . $attach->filename);
} else {
$GLOBALS['log']->debug('InboundEmail could not create attachment file: ' . $attach->filename . " - temp file target: [ {$uploadDir}{$fileName} ]");
return;
}
}
$this->tempAttachment[$fileName] = urldecode($attach->filename);
// if all was successful, feel for inline and cache Note ID for display:
if ((isset($part->disposition) && strtolower($part->disposition) == 'inline' && in_array($part->subtype, $this->imageTypes))
|| ($part->type == 5)
) {
if (!is_dir($cacheDir) && !mkdir($cacheDir) && !is_dir($cacheDir)) {
throw new \RuntimeException(sprintf('Directory "%s" was not created', $cacheDir));
}
if (copy($uploadDir . $fileName, sugar_cached("images/{$fileName}.") . strtolower($part->subtype))) {
$id = substr((string) $part->id, 1, -1); //strip <> around
$this->inlineImages[$id] = $attach->id . "." . strtolower($part->subtype);
} else {
$GLOBALS['log']->debug('InboundEmail could not copy ' . $uploadDir . $fileName . ' to cache');
}
}
}
/**
* decodes a string based on its associated encoding
* if nothing is passed, we default to no-encoding type
* @param $str encoded string
* @param $enc detected encoding
*/
public function handleTranserEncoding($str, $enc = 0)
{
switch ($enc) {
case 2:// BINARY
$ret = $str;
break;
case 3:// BASE64
$ret = base64_decode($str);
break;
case 4:// QUOTED-PRINTABLE
$ret = quoted_printable_decode($str);
break;
case 0:// 7BIT or 8BIT
case 1:// already in a string-useable format - do nothing
case 5:// OTHER
default:// catch all
$ret = $str;
break;
}
return $ret;
}
/**
* Some emails do not get assigned a message_id, specifically from
* Outlook/Exchange.
*
* We need to derive a reliable one for duplicate import checking.
* @param mixed $header
* @return string
*/
public function getMessageId($header)
{
$message_id = md5(print_r($header, true));
return $message_id;
}
/**
* checks for duplicate emails on polling. The uniqueness of a given email message is determined by a concatenation
* of 2 values, the messageID and the delivered-to field. This allows multiple To: and B/CC: destination addresses
* to be imported by Sugar without violating the true duplicate-email issues.
*
* @param string message_id message ID generated by sending server
* @param int message number (mailserver's key) of email
* @param object header object generated by imap_headerinfo()
* @param string textHeader Headers in normal text format
* @return bool
*/
public function importDupeCheck($message_id, $header, $textHeader)
{
$GLOBALS['log']->debug('*********** InboundEmail doing dupe check.');
// generate "delivered-to" seed for email duplicate check
$deliveredTo = $this->id; // cn: bug 12236 - cc's failing dupe check
$exHeader = explode("\n", $textHeader);
foreach ($exHeader as $headerLine) {
if (strpos(strtolower($headerLine), 'delivered-to:') !== false) {
$deliveredTo = substr($headerLine, strpos($headerLine, " "), strlen($headerLine));
$GLOBALS['log']->debug('********* InboundEmail found [ ' . $deliveredTo . ' ] as the destination address for email [ ' . $message_id . ' ]');
} elseif (strpos(strtolower($headerLine), 'x-real-to:') !== false) {
$deliveredTo = substr($headerLine, strpos($headerLine, " "), strlen($headerLine));
$GLOBALS['log']->debug('********* InboundEmail found [ ' . $deliveredTo . ' ] for non-standards compliant email x-header [ ' . $message_id . ' ]');
}
}
$message_id = $this->getMessageId($header);
// generate compound messageId
$this->compoundMessageId = trim($message_id) . trim($deliveredTo);
if (empty($this->compoundMessageId)) {
$GLOBALS['log']->error('Inbound Email found a message without a header and message_id');
return false;
} // if
$this->compoundMessageId = md5($this->compoundMessageId);
$query = 'SELECT count(emails.id) AS c FROM emails WHERE emails.message_id = \'' . $this->compoundMessageId . '\' and emails.deleted = 0';
$results = $this->db->query($query, true);
$row = $this->db->fetchByAssoc($results);
if ($row['c'] > 0) {
$GLOBALS['log']->debug('InboundEmail found a duplicate email with ID (' . $this->compoundMessageId . ')');
return false; // we have a dupe and don't want to import the email'
}
return true;
}
/**
* takes the output from imap_mime_hader_decode() and handles multiple types of encoding
* @param string subject Raw subject string from email
* @return string ret properly formatted UTF-8 string
*/
public function handleMimeHeaderDecode($subject)
{
$subjectDecoded = '';
if (function_exists('imap_mime_header_decode') && in_array('imap', get_loaded_extensions(), true)) { // function_exists() should be moved to MimeHeaderDecode().
$subjectDecoded = $this->getImap()->MimeHeaderDecode($subject); // returns array or string.
} else {
// imap_mime_header_decode() is not installed on bitnami docker container! Fall back to iconv_mime_decode().
if (function_exists('iconv_mime_decode')) {
$subjectDecoded = iconv_mime_decode($subject, 0, 'UTF-8'); // returns string or false.
if ($subjectDecoded == false) { // error occurred in iconv_mime_decode().
$subjectDecoded = $subject; // possibly still mime encoded.
}
} else { // iconv module not installed or enabled!
$subjectDecoded = $subject;
}
}
if (is_array($subjectDecoded)) {
$ret = '';
foreach ($subjectDecoded as $object) {
if ($object->charset != 'default') {
$ret .= $this->handleCharsetTranslation($object->text, $object->charset);
} else {
$ret .= $object->text;
}
}
$subjectDecoded = $ret;
}
return $subjectDecoded; //should be plain US-ASCII, compatible with UTF-8.
}
/**
* Calculates the appropriate display date/time sent for an email.
* @param string headerDate The date sent of email in MIME header format
* @return string GMT-0 Unix timestamp
*/
public function getUnixHeaderDate($headerDate)
{
global $timedate;
if (empty($headerDate)) {
return "";
}
///////////////////////////////////////////////////////////////////
//// CALCULATE CORRECT SENT DATE/TIME FOR EMAIL
if (!empty($headerDate)) {
// Bug 25254 - Strip trailing space that come in some header dates (maybe ones with 1-digit day number)
$headerDate = trim($headerDate);
// need to hack PHP/windows' bad handling of strings when using POP3
if (strstr($headerDate, '+0000 GMT')) {
$headerDate = str_replace('GMT', '', $headerDate);
} elseif (!strtotime($headerDate)) {
$headerDate = 'now'; // catch non-standard format times.
} else {
// cn: bug 9196 parse the GMT offset
if (strpos($headerDate, '-') || strpos($headerDate, '+')) {
// cn: bug make sure last 5 chars are [+|-]nnnn
if (strpos($headerDate, "(")) {
$headerDate = preg_replace('/\([\w]+\)/i', "", $headerDate);
$headerDate = trim($headerDate);
}
// parse mailserver time
$gmtEmail = trim(substr($headerDate, -5, 5));
$posNeg = substr($gmtEmail, 0, 1);
$gmtHours = substr($gmtEmail, 1, 2);
$gmtMins = substr($gmtEmail, -2, 2);
// get seconds
$secsHours = $gmtHours * 60 * 60;
$secsTotal = $secsHours + ($gmtMins * 60);
$secsTotal = ($posNeg == '-') ? $secsTotal : -1 * $secsTotal;
// mfh: bug 10961/12855 - date time values with GMT offsets not properly formatted
$headerDate = trim(substr_replace($headerDate, '', -5));
}
}
} else {
$headerDate = 'now';
}
$unixHeaderDate = strtotime($headerDate);
if (isset($secsTotal)) {
// this gets the timestamp to true GMT-0
$unixHeaderDate += $secsTotal;
}
if (strtotime('Jan 1, 2001') > $unixHeaderDate) {
$unixHeaderDate = strtotime('now');
}
return $unixHeaderDate;
//// END CALCULATE CORRECT SENT DATE/TIME FOR EMAIL
///////////////////////////////////////////////////////////////////
}
/**
* This method returns the correct messageno for the pop3 protocol
* @param String UIDL
* @return returnMsgNo
*/
public function getCorrectMessageNoForPop3($messageId)
{
$returnMsgNo = -1;
if ($this->protocol == 'pop3') {
if ($this->pop3_open()) {
// get the UIDL from database;
$query = "SELECT msgno FROM email_cache WHERE ie_id = '{$this->id}' AND message_id = '{$messageId}'";
$r = $this->db->query($query);
$a = $this->db->fetchByAssoc($r);
$msgNo = $a['msgno'];
$returnMsgNo = $msgNo;
// authenticate
$this->pop3_sendCommand("USER", $this->email_user);
$this->pop3_sendCommand("PASS", $this->email_password);
// get UIDL for this msgNo
$this->pop3_sendCommand("UIDL {$msgNo}", '', false); // leave socket buffer alone until the while()
$buf = fgets($this->pop3socket, 1024); // handle "OK+ msgNo UIDL(UIDL for this messageno)";
// if it returns OK then we have found the message else get all the UIDL
// and search for the correct msgNo;
$foundMessageNo = false;
if (preg_match("/OK/", $buf) > 0) {
$mailserverResponse = explode(" ", $buf);
// if the cachedUIDL and the UIDL from mail server matches then its the correct messageno
if (trim($mailserverResponse[count($mailserverResponse) - 1]) == $messageId) {
$foundMessageNo = true;
}
} //if
//get all the UIDL and then find the correct messageno
if (!$foundMessageNo) {
// get UIDLs
$this->pop3_sendCommand("UIDL", '', false); // leave socket buffer alone until the while()
fgets($this->pop3socket, 1024); // handle "OK+";
$UIDLs = array();
$buf = '!';
if (is_resource($this->pop3socket)) {
while (!feof($this->pop3socket)) {
$buf = fgets(
$this->pop3socket,
1024
); // 8kb max buffer - shouldn't be more than 80 chars via pop3...
if (trim($buf) == '.') {
$GLOBALS['log']->debug("*** GOT '.'");
break;
} // if
// format is [msgNo] [UIDL]
$exUidl = explode(" ", $buf);
$UIDLs[trim($exUidl[1])] = trim($exUidl[0]);
} // while
if (array_key_exists($messageId, $UIDLs)) {
$returnMsgNo = $UIDLs[$messageId];
} else {
// message could not be found on server
$returnMsgNo = -1;
} // else
} // if
} // if
$this->pop3_cleanUp();
} //if
} //if
return $returnMsgNo;
}
/**
* If the importOneEmail returns false, then findout if the duplicate email
*/
public function getDuplicateEmailId($msgNo, $uid)
{
global $timedate;
global $app_strings;
global $app_list_strings;
global $sugar_config;
global $current_user;
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbounc Email Connection is not valid resource for getting duplicate email id.');
return false;
}
$header = $this->getImap()->getHeaderInfo($msgNo);
$fullHeader = $this->getImap()->fetchHeader($msgNo); // raw headers
$message_id = isset($header->message_id) ? $header->message_id : '';
// reset inline images cache
$this->inlineImages = array();
// handle messages deleted on server
if (empty($header)) {
if (!isset($this->email) || empty($this->email)) {
$this->email = BeanFactory::newBean('Emails');
} // if
return "";
}
$dupeCheckResult = $this->importDupeCheck($message_id, $header, $fullHeader);
if (!$dupeCheckResult && !empty($this->compoundMessageId)) {
// we have a duplicate email
$query = 'SELECT id FROM emails WHERE emails.message_id = \'' . $this->compoundMessageId . '\' and emails.deleted = 0';
$results = $this->db->query($query, true);
$row = $this->db->fetchByAssoc($results);
$this->email = BeanFactory::newBean('Emails');
$this->email->id = $row['id'];
return $row['id'];
} // if
return "";
// else
} // fn
/**
* shiny new importOneEmail() method
* @param int msgNo
* @param bool forDisplay
* @param clean_email boolean, default true,
* @return boolean|string
* @deprecated since - 7.9 use returnImportedEmail instead
*/
public function importOneEmail($msgNo, $uid, $forDisplay = false, $clean_email = true)
{
$GLOBALS['log']->debug("InboundEmail processing 1 email {$msgNo}-----------------------------------------------------------------------------------------");
global $timedate;
global $app_strings;
global $app_list_strings;
global $sugar_config;
global $current_user;
// Bug # 45477
// So, on older versions of PHP (PHP VERSION < 5.3),
// calling imap_headerinfo and imap_fetchheader can cause a buffer overflow for exteremly large headers,
// This leads to the remaining messages not being read because Sugar crashes everytime it tries to read the headers.
// The workaround is to mark a message as read before making trying to read the header of the msg in question
// This forces this message not be read again, and we can continue processing remaining msgs.
// UNCOMMENT THIS IF YOU HAVE THIS PROBLEM! See notes on Bug # 45477
// $this->markEmails($uid, "read");
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->warn('Connection is not a valid resource for importOneEmail()');
$header = null;
$fullHeader = null;
} else {
$header = $this->getImap()->getHeaderInfo($msgNo);
$fullHeader = $this->getImap()->fetchHeader($msgNo); // raw headers
}
// reset inline images cache
$this->inlineImages = array();
// handle messages deleted on server
if (empty($header)) {
if (!isset($this->email) || empty($this->email)) {
$this->email = BeanFactory::newBean('Emails');
}
$q = "";
$queryUID = $this->db->quote($uid);
if ($this->isPop3Protocol()) {
$this->email->name = $app_strings['LBL_EMAIL_ERROR_MESSAGE_DELETED'];
$q = "DELETE FROM email_cache WHERE message_id = '{$queryUID}' AND ie_id = '{$this->id}' AND mbox = '{$this->mailbox}'";
} else {
$this->email->name = $app_strings['LBL_EMAIL_ERROR_IMAP_MESSAGE_DELETED'];
$q = "DELETE FROM email_cache WHERE imap_uid = '{$queryUID}' AND ie_id = '{$this->id}' AND mbox = '{$this->mailbox}'";
} // else
// delete local cache
$r = $this->db->query($q);
$this->email->date_sent_received = $timedate->nowDb();
return false;
//return "Message deleted from server.";
}
///////////////////////////////////////////////////////////////////////
//// DUPLICATE CHECK
$message_id = isset($header->message_id) ? $header->message_id : '';
$dupeCheckResult = $this->importDupeCheck($message_id, $header, $fullHeader);
if ($forDisplay || $dupeCheckResult) {
$GLOBALS['log']->debug('*********** NO duplicate found, continuing with processing.');
$structure = $this->getImap()->fetchStructure($msgNo); // map of email
///////////////////////////////////////////////////////////////////
//// CREATE SEED EMAIL OBJECT
$email = BeanFactory::newBean('Emails');
$email->isDuplicate = ($dupeCheckResult) ? false : true;
$email->mailbox_id = $this->id;
$message = array();
$email->id = create_guid();
$email->new_with_id = true; //forcing a GUID here to prevent double saves.
//// END CREATE SEED EMAIL
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// PREP SYSTEM USER
if (empty($current_user)) {
// I-E runs as admin, get admin prefs
$current_user = BeanFactory::newBean('Users');
$current_user->getSystemUser();
}
$tPref = $current_user->getUserDateTimePreferences();
//// END USER PREP
///////////////////////////////////////////////////////////////////
if (!empty($header->date)) {
$unixHeaderDate = $timedate->fromString($header->date);
}
///////////////////////////////////////////////////////////////////
//// HANDLE EMAIL ATTACHEMENTS OR HTML TEXT
//// Inline images require that I-E handle attachments before body text
// parts defines attachments - be mindful of .html being interpreted as an attachment
if ($structure->type == 1 && !empty($structure->parts)) {
$GLOBALS['log']->debug('InboundEmail found multipart email - saving attachments if found.');
$this->saveAttachments($msgNo, $structure->parts, $email->id, 0, $forDisplay);
} elseif ($structure->type == 0) {
$uuemail = ($this->isUuencode($email->description)) ? true : false;
/*
* UUEncoded attachments - legacy, but still have to deal with it
* format:
* begin 777 filename.txt
* UUENCODE
*
* end
*/
// set body to the filtered one
if ($uuemail) {
$email->description = $this->handleUUEncodedEmailBody($email->description, $email->id);
$email->retrieve($email->id);
$email->save();
}
} else {
if ($this->port != 110) {
$GLOBALS['log']->debug('InboundEmail found a multi-part email (id:' . $msgNo . ') with no child parts to parse.');
}
}
//// END HANDLE EMAIL ATTACHEMENTS OR HTML TEXT
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// ASSIGN APPROPRIATE ATTRIBUTES TO NEW EMAIL OBJECT
// handle UTF-8/charset encoding in the ***headers***
$db = DBManagerFactory::getInstance();
$email->name = $this->handleMimeHeaderDecode($header->subject);
$email->type = 'inbound';
if (!empty($unixHeaderDate)) {
$email->date_sent_received = $timedate->asUser($unixHeaderDate);
list($email->date_start, $email->time_start) = $timedate->split_date_time($email->date_sent_received);
} else {
$email->date_start = $email->time_start = $email->date_sent_received = "";
}
$email->status = 'unread'; // this is used in Contacts' Emails SubPanel
if (!empty($header->toaddress)) {
$email->to_name = $this->handleMimeHeaderDecode($header->toaddress);
$email->to_addrs_names = $email->to_name;
}
if (!empty($header->to)) {
$email->to_addrs = $this->convertImapToSugarEmailAddress($header->to);
}
$email->from_name = $this->handleMimeHeaderDecode($header->fromaddress);
$email->from_addr_name = $email->from_name;
$email->from_addr = $this->convertImapToSugarEmailAddress($header->from);
isValidEmailAddress($email->from_addr);
if (!empty($header->cc)) {
$email->cc_addrs = $this->convertImapToSugarEmailAddress($header->cc);
}
if (!empty($header->ccaddress)) {
$email->cc_addrs_names = $this->handleMimeHeaderDecode($header->ccaddress);
} // if
$email->reply_to_name = $this->handleMimeHeaderDecode($header->reply_toaddress);
$email->reply_to_email = $this->convertImapToSugarEmailAddress($header->reply_to);
if (!empty($email->reply_to_email)) {
$email->reply_to_addr = $email->reply_to_name;
}
$email->intent = $this->mailbox_type;
$email->message_id = $this->compoundMessageId; // filled by importDupeCheck();
$oldPrefix = $this->imagePrefix;
if (!$forDisplay) {
// Store CIDs in imported messages, convert on display
$this->imagePrefix = "cid:";
}
// handle multi-part email bodies
$email->description_html = $this->getMessageText(
$msgNo,
'HTML',
$structure,
$fullHeader,
$clean_email
); // runs through handleTranserEncoding() already
$email->description = $this->getMessageText(
$msgNo,
'PLAIN',
$structure,
$fullHeader,
$clean_email
); // runs through handleTranserEncoding() already
$this->imagePrefix = $oldPrefix;
// empty() check for body content
if (empty($email->description)) {
$GLOBALS['log']->debug('InboundEmail Message (id:' . $email->message_id . ') has no body');
}
// assign_to group
if (!empty($_REQUEST['user_id'])) {
$email->assigned_user_id = $_REQUEST['user_id'];
}
// Samir Gandhi : Commented out this code as its not needed
//$email->assigned_user_id = $this->group_id;
//Assign Parent Values if set
if (!empty($_REQUEST['parent_id']) && !empty($_REQUEST['parent_type'])) {
$email->parent_id = $_REQUEST['parent_id'];
$email->parent_type = $_REQUEST['parent_type'];
$mod = strtolower($email->parent_type);
//Custom modules rel name
$rel = array_key_exists($mod, $email->field_defs) ? $mod : $mod . "_activities_emails";
if (!$email->load_relationship($rel)) {
return false;
}
$email->$rel->add($email->parent_id);
}
// override $forDisplay w/user pref
if ($forDisplay) {
if ($this->isAutoImport()) {
$forDisplay = false; // triggers save of imported email
}
}
if (!$forDisplay) {
$email->save();
$email->new_with_id = false; // to allow future saves by UPDATE, instead of INSERT
//// ASSIGN APPROPRIATE ATTRIBUTES TO NEW EMAIL OBJECT
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// LINK APPROPRIATE BEANS TO NEWLY SAVED EMAIL
//$contactAddr = $this->handleLinking($email);
//// END LINK APPROPRIATE BEANS TO NEWLY SAVED EMAIL
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// MAILBOX TYPE HANDLING
$this->handleMailboxType($email, $header);
//// END MAILBOX TYPE HANDLING
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// SEND AUTORESPONSE
if (!empty($email->reply_to_email)) {
$contactAddr = $email->reply_to_email;
isValidEmailAddress($contactAddr);
} else {
$contactAddr = $email->from_addr;
isValidEmailAddress($contactAddr);
}
if (!$this->isMailBoxTypeCreateCase()) {
$this->handleAutoresponse($email, $contactAddr);
}
//// END SEND AUTORESPONSE
///////////////////////////////////////////////////////////////////
//// END IMPORT ONE EMAIL
///////////////////////////////////////////////////////////////////
}
} else {
// only log if not POP3; pop3 iterates through ALL mail
if ($this->protocol != 'pop3') {
$GLOBALS['log']->info("InboundEmail found a duplicate email: " . $message_id);
//echo "This email has already been imported";
}
return false;
}
//// END DUPLICATE CHECK
///////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
//// DEAL WITH THE MAILBOX
if (!$forDisplay) {
$r = $this->getImap()->setFlagFull($msgNo, '\\SEEN');
// if delete_seen, mark msg as deleted
if ($this->delete_seen == 1 && !$forDisplay) {
$GLOBALS['log']->info("INBOUNDEMAIL: delete_seen == 1 - deleting email");
$this->getImap()->setFlagFull($msgNo, '\\DELETED');
}
}
// for display - don't touch server files?
//imap_setflag_full($this->conn, $msgNo, '\\UNSEEN');
$GLOBALS['log']->debug('********************************* InboundEmail finished import of 1 email: ' . $email->name);
//// END DEAL WITH THE MAILBOX
///////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
//// TO SUPPORT EMAIL 2.0
$this->email = $email;
if (empty($this->email->et)) {
$this->email->email2init();
}
return true;
}
/**
* Imports A Single Email
* @param $msgNo
* @param $uid
* @param bool $forDisplay
* @param bool $clean_email
* @param bool $isGroupFolderExists
* @return boolean
*/
public function returnImportedEmail(
$msgNo,
$uid,
$forDisplay = false,
$clean_email = true,
$isGroupFolderExists = false
) {
$GLOBALS['log']->debug("InboundEmail processing 1 email {$msgNo}-----------------------------------------------------------------------------------------");
global $timedate;
global $current_user;
// Bug # 45477
// So, on older versions of PHP (PHP VERSION < 5.3),
// calling imap_headerinfo and imap_fetchheader can cause a buffer overflow for exteremly large headers,
// This leads to the remaining messages not being read because Sugar crashes everytime it tries to read the headers.
// The workaround is to mark a message as read before making trying to read the header of the msg in question
// This forces this message not be read again, and we can continue processing remaining msgs.
// UNCOMMENT THIS IF YOU HAVE THIS PROBLEM! See notes on Bug # 45477
// $this->markEmails($uid, "read");
if (empty($msgNo) && !empty($uid)) {
$msgNo = $this->getImap()->getMessageNo((int)$uid);
}
$fullHeader = $this->getImap()->fetchHeader($msgNo);
$header = $this->getImap()->rfc822ParseHeaders($fullHeader);
$message_id = isset($header->message_id) ? $header->message_id : '';
// reset inline images cache
$this->inlineImages = array();
///////////////////////////////////////////////////////////////////////
//// DUPLICATE CHECK
$dupeCheckResult = $this->importDupeCheck($message_id, $header, $fullHeader);
if ($forDisplay || $dupeCheckResult) {
$GLOBALS['log']->debug('*********** NO duplicate found, continuing with processing.');
$structure = $this->getImap()->fetchStructure($msgNo); // map of email
///////////////////////////////////////////////////////////////////
//// CREATE SEED EMAIL OBJECT
$email = BeanFactory::newBean('Emails');
$email->isDuplicate = $dupeCheckResult ? false : true;
$email->mailbox_id = $this->id;
$email->uid = $uid;
$email->msgNo = $msgNo;
$email->id = create_guid();
$email->new_with_id = true; //forcing a GUID here to prevent double saves.
//// END CREATE SEED EMAIL
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// PREP SYSTEM USER
if (empty($current_user)) {
// I-E runs as admin, get admin prefs
$current_user = BeanFactory::newBean('Users');
$current_user->getSystemUser();
}
$current_user->getUserDateTimePreferences();
//// END USER PREP
///////////////////////////////////////////////////////////////////
if (!empty($header->date)) {
$unixHeaderDate = $timedate->fromString($header->date);
}
///////////////////////////////////////////////////////////////////
//// HANDLE EMAIL ATTACHEMENTS OR HTML TEXT
//// Inline images require that I-E handle attachments before body text
// parts defines attachments - be mindful of .html being interpreted as an attachment
if ($structure->type == 1 && !empty($structure->parts)) {
$GLOBALS['log']->debug('InboundEmail found multipart email - saving attachments if found.');
$this->saveAttachments($msgNo, $structure->parts, $email->id, 0, $forDisplay);
} elseif ($structure->type == 0) {
$UUEncodedEmail = $this->isUuencode($email->description) ? true : false;
/*
* UUEncoded attachments - legacy, but still have to deal with it
* format:
* begin 777 filename.txt
* UUENCODE
*
* end
*/
// set body to the filtered one
if ($UUEncodedEmail) {
$email->description = $this->handleUUEncodedEmailBody($email->description, $email->id);
$email->retrieve($email->id);
$email->save();
}
} else {
if ($this->port != 110) {
$GLOBALS['log']->debug(
'InboundEmail found a multi-part email (id:' . $msgNo . ') with no child parts to parse.'
);
}
}
//// END HANDLE EMAIL ATTACHEMENTS OR HTML TEXT
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// ASSIGN APPROPRIATE ATTRIBUTES TO NEW EMAIL OBJECT
// handle UTF-8/charset encoding in the ***headers***
$email->name = $this->handleMimeHeaderDecode($header->subject);
$email->type = 'inbound';
if (!empty($unixHeaderDate)) {
$email->date_sent_received = $timedate->asUser($unixHeaderDate);
list($email->date_start, $email->time_start) = $timedate->split_date_time($email->date_sent_received);
} else {
$email->date_start = $email->time_start = $email->date_sent_received = "";
}
$email->status = 'unread'; // this is used in Contacts' Emails SubPanel
if (!empty($header->toaddress)) {
$email->to_name = $this->handleMimeHeaderDecode($header->toaddress);
$email->to_addrs_names = $email->to_name;
}
if (!empty($header->to)) {
$email->to_addrs = $this->convertImapToSugarEmailAddress($header->to);
}
$email->from_name = $this->handleMimeHeaderDecode($header->fromaddress);
$email->from_addr_name = $email->from_name;
$email->from_addr = $this->convertImapToSugarEmailAddress($header->from);
isValidEmailAddress($email->from_addr);
if (!empty($header->cc)) {
$email->cc_addrs = $this->convertImapToSugarEmailAddress($header->cc);
}
if (!empty($header->ccaddress)) {
$email->cc_addrs_names = $this->handleMimeHeaderDecode($header->ccaddress);
} // if
$email->reply_to_name = $this->handleMimeHeaderDecode($header->reply_toaddress);
$email->reply_to_email = $this->convertImapToSugarEmailAddress($header->reply_to);
if (!empty($email->reply_to_email)) {
$email->reply_to_addr = $email->reply_to_name;
}
$email->intent = $this->mailbox_type;
$email->message_id = $this->compoundMessageId; // filled by importDupeCheck();
$oldPrefix = $this->imagePrefix;
if (!$forDisplay) {
// Store CIDs in imported messages, convert on display
$this->imagePrefix = 'cid:';
}
$emailBody = $this->imap->fetchBody($uid, '', FT_UID);
$contentType = $this->mailParser->parse($emailBody, false)->getHeaderValue('Content-Type');
if (!empty($contentType) && strtolower($contentType) === 'text/plain') {
$email->description = $this->getMessageTextWithUid(
$uid,
$contentType,
$structure = null,
$fullHeader = null,
true
);
}
$email->description_html = $this->getMessageTextWithUid(
$uid,
$structure->subtype,
$structure,
$fullHeader,
$clean_email
);
$this->imagePrefix = $oldPrefix;
// empty() check for body content
if (empty($email->description)) {
$GLOBALS['log']->debug('InboundEmail Message (id:' . $email->message_id . ') has no body');
}
// assign_to group
if (!empty($_REQUEST['user_id'])) {
$email->assigned_user_id = $_REQUEST['user_id'];
}
//Assign Parent Values if set
if (!empty($_REQUEST['parent_id']) && !empty($_REQUEST['parent_type'])) {
$email->parent_id = $_REQUEST['parent_id'];
$email->parent_type = $_REQUEST['parent_type'];
$mod = strtolower($email->parent_type);
//Custom modules rel name
$rel = array_key_exists($mod, $email->field_defs) ? $mod : $mod . '_activities_emails';
if (!$email->load_relationship($rel)) {
return false;
}
$email->$rel->add($email->parent_id);
}
// override $forDisplay w/user pref
if ($forDisplay && $this->isAutoImport()) {
$forDisplay = false; // triggers save of imported email
}
if (!$forDisplay) {
$email->save();
$email->new_with_id = false; // to allow future saves by UPDATE, instead of INSERT
//// ASSIGN APPROPRIATE ATTRIBUTES TO NEW EMAIL OBJECT
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// LINK APPROPRIATE BEANS TO NEWLY SAVED EMAIL
//$contactAddress = $this->handleLinking($email);
//// END LINK APPROPRIATE BEANS TO NEWLY SAVED EMAIL
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// MAILBOX TYPE HANDLING
$this->handleMailboxType($email, $header);
//// END MAILBOX TYPE HANDLING
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
//// SEND AUTORESPONSE
if (!empty($email->reply_to_email)) {
$contactAddress = $email->reply_to_email;
isValidEmailAddress($contactAddress);
} else {
$contactAddress = $email->from_addr;
isValidEmailAddress($contactAddress);
}
if (!$this->isMailBoxTypeCreateCase()) {
$this->handleAutoresponse($email, $contactAddress);
}
//// END SEND AUTORESPONSE
///////////////////////////////////////////////////////////////////
//// END IMPORT ONE EMAIL
///////////////////////////////////////////////////////////////////
}
} else {
// only log if not POP3; pop3 iterates through ALL mail
if ($this->protocol != 'pop3') {
$GLOBALS['log']->info('InboundEmail found a duplicate email: ' . $message_id);
//echo "This email has already been imported";
}
if (!empty($this->compoundMessageId)) {
// return email
$result = $this->db->query(
'SELECT id from emails WHERE message_id ="' . $this->compoundMessageId . '"' .
'AND mailbox_id = "' . $this->id . '"'
);
$row = $this->db->fetchRow($result);
if (!empty($row['id'])) {
return $row['id'];
}
}
return false;
}
//// END DUPLICATE CHECK
///////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
//// DEAL WITH THE MAILBOX
if (!$forDisplay) {
if (!$isGroupFolderExists) {
$r = $this->getImap()->setFlagFull($msgNo, '\\SEEN');
} else {
$r = $this->getImap()->clearFlagFull($msgNo, '\\SEEN');
}
// if delete_seen, mark msg as deleted
if ($this->delete_seen == 1 && !$forDisplay) {
$GLOBALS['log']->info("INBOUNDEMAIL: delete_seen == 1 - deleting email");
$this->getImap()->setFlagFull($msgNo, '\\DELETED');
}
}
// for display - don't touch server files?
//imap_setflag_full($this->conn, $msgNo, '\\UNSEEN');
$GLOBALS['log']->debug('********************************* InboundEmail finished import of 1 email: ' . $email->name);
//// END DEAL WITH THE MAILBOX
///////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
//// TO SUPPORT EMAIL 2.0
$this->email = $email;
if (empty($this->email->et)) {
$this->email->email2init();
}
if (isset($email->id) && !empty($email->id)) {
return $email->id;
}
return true;
}
/**
* Used to view non imported emails
* @param array $request - must include the metadata
* @return Email|boolean - false on error | a non imported email
* @throws Exception
* @see EmailsViewDetailNonImported::preDisplay()
*/
public function returnNonImportedEmail($request)
{
global $timedate;
global $current_user;
global $log;
$msgNo = $request['msgno'];
$uid = $request['uid'];
if (empty($header)) {
$email = BeanFactory::newBean('Emails');
$this->connectMailserver();
$fullHeader = $this->getImap()->fetchHeader($uid, FT_UID);
$parsedFullHeader = $this->getImap()->rfc822ParseHeaders($fullHeader);
$email->name = $this->handleMimeHeaderDecode($parsedFullHeader->subject);
$email->type = 'inbound';
if (isset($request['metadata']['viewdefs'])) {
// only process field(s) in which we actually use
$fields_selected = $request['metadata']['viewdefs'];
if (empty($email->date_entered)) {
$possibleFormats = [
DateTime::RFC2822 . '+',
str_replace(['D, '], '', DateTime::RFC2822),
// day-of-week is optional
str_replace([':s'], '', DateTime::RFC2822),
// seconds are optional
str_replace(['D, ', ':s'], '', DateTime::RFC2822),
// day-of-week is optional, seconds are optional
DateTime::RFC822,
str_replace(['D, '], '', DateTime::RFC822),
// day is optional
str_replace([':s'], '', DateTime::RFC822),
// seconds are optional
str_replace(['D, ', ':s'], '', DateTime::RFC822),
// day is optional, seconds are optional
];
// Some IMAP server respond with different data formats.
// The iteration attempt to use each possible format to decode the detail.
// The if ($dateTime !== false) means that when the DateTime class successfully
// decodes the date field it will exit the loop.
// As we no longer need to continue trying to decode the datetime format.
foreach ($possibleFormats as $possibleFormat) {
$dateTime = DateTime::createFromFormat($possibleFormat, $parsedFullHeader->date);
if ($dateTime !== false) {
break;
}
}
if ($dateTime === false) {
throw new Exception(
sprintf('Expected header Date to comply with RFC882 or RFC2882, but actual is "%s"',
$parsedFullHeader->date)
);
}
$email->date_entered = $timedate->asUser($dateTime, $current_user);
$email->date_modified = $timedate->asUser($dateTime, $current_user);
$email->date_start = $timedate->asUserDate($dateTime);
$email->time_start = $timedate->asUserTime($dateTime);
$systemUser = BeanFactory::getBean('Users', 1);
$email->created_by = $systemUser->id;
$email->created_by_name = $systemUser->name;
$email->modified_user_id = $systemUser->id;
$email->modified_by_name = $systemUser->name;
}
$email->status = 'unread'; // this is used in Contacts' Emails SubPanel
if (!empty($parsedFullHeader->to)) {
$email->to_name = $this->handleMimeHeaderDecode($parsedFullHeader->toaddress);
$email->to_addrs_names = $email->to_name;
$email->to_addrs = $this->convertImapToSugarEmailAddress($parsedFullHeader->toaddress);
}
if (!empty($parsedFullHeader->from)) {
$email->to_addrs = $this->convertImapToSugarEmailAddress($parsedFullHeader->toaddress);
}
$email->from_name = $this->handleMimeHeaderDecode($parsedFullHeader->fromaddress);
$email->from_addr_name = $email->from_name;
$email->from_addr = $this->convertImapToSugarEmailAddress($email->from_name);
isValidEmailAddress($email->from_addr);
if (
in_array('cc_addrs', $fields_selected)
|| in_array('cc_addrs_names', $fields_selected)
) {
if (!empty($parsedFullHeader->ccaddress)) {
$email->cc_addrs = $this->convertImapToSugarEmailAddress($parsedFullHeader->ccaddress);
$email->cc_addrs_names = $this->handleMimeHeaderDecode($parsedFullHeader->ccaddress);
} // if
}
$email->reply_to_name = $this->handleMimeHeaderDecode($parsedFullHeader->reply_toaddress);
$email->reply_to_email = $this->convertImapToSugarEmailAddress($parsedFullHeader->reply_to);
if (!empty($email->reply_to_email)) {
$email->reply_to_addr = $email->reply_to_name;
}
$email->intent = $this->mailbox_type;
$email->message_id = $this->compoundMessageId; // filled by importDupeCheck();
$oldPrefix = $this->imagePrefix;
$emailBody = $this->imap->fetchBody($uid, '', FT_UID);
$contentType = $this->mailParser->parse($emailBody, false)->getHeaderValue('Content-Type');
if (!empty($contentType) && strtolower($contentType) === 'text/plain') {
$email->description = $this->getMessageTextWithUid(
$uid,
$contentType,
$structure = null,
$fullHeader = null,
true
);
}
$email->description_html = $this->getMessageTextWithUid(
$uid,
$contentType,
$structure = null,
$fullHeader = null,
true
);
} else {
$log->warn('Missing viewdefs in request');
}
if (empty($email->description_html)) {
$email->description_html = $email->description;
$email->description_html = nl2br($email->description_html);
}
$this->imagePrefix = $oldPrefix;
$email->msgNo = $msgNo;
$email->uid = $uid;
$email->inbound_email_record = $this->id;
return $email;
}
return false;
}
/**
* Imports every email in the mailbox
* depending on what the $this->mailbox is set to
*/
public function importAllFromFolder()
{
$response = array();
$emailSortedHeaders = $this->getImap()->sort(
SORTDATE,
0,
SE_UID
);
foreach ($emailSortedHeaders as $uid) {
$response[] = $this->returnImportedEmail(null, $uid);
}
return $response;
}
/**
* figures out if a plain text email body has UUEncoded attachments
* @param string string The email body
* @return bool True if UUEncode is detected.
*/
public function isUuencode($string)
{
$rx = "begin [0-9]{3} .*";
$exBody = explode("\r", $string);
foreach ($exBody as $line) {
if (preg_match("/begin [0-9]{3} .*/i", $line)) {
return true;
}
}
return false;
}
/**
* handles UU Encoded emails - a legacy from pre-RFC 822 which must still be supported (?)
* @param string raw The raw email body
* @param string id Parent email ID
* @return string The filtered email body, stripped of attachments
*/
public function handleUUEncodedEmailBody($raw, $id)
{
global $locale;
$emailBody = '';
$attachmentBody = '';
$inAttachment = false;
$exRaw = explode("\n", $raw);
foreach ($exRaw as $k => $line) {
$line = trim($line);
if (preg_match("/begin [0-9]{3} .*/i", $line, $m)) {
$inAttachment = true;
$fileName = $this->handleEncodedFilename(substr($m[0], 10, strlen($m[0])));
$attachmentBody = ''; // reset for next part of loop;
continue;
}
// handle "end"
if (strpos($line, "end") === 0) {
if (!empty($fileName) && !empty($attachmentBody)) {
$this->handleUUDecode($id, $fileName, trim($attachmentBody));
$attachmentBody = ''; // reset for next part of loop;
}
}
if ($inAttachment === false) {
$emailBody .= "\n" . $line;
} else {
$attachmentBody .= "\n" . $line;
}
}
/* since UUEncode was developed before MIME, we have NO idea what character set encoding was used. we will assume the user's locale character set */
$emailBody = $locale->translateCharset($emailBody, $locale->getExportCharset(), 'UTF-8');
return $emailBody;
}
/**
* wrapper for UUDecode
* @param string id Id of the email
* @param string UUEncode Encode US-ASCII
*/
public function handleUUDecode($id, $fileName, $UUEncode)
{
global $sugar_config;
/* include PHP_Compat library; it auto-feels for PHP5's compiled convert_uuencode() function */
require_once('include/PHP_Compat/convert_uudecode.php');
$attach = BeanFactory::newBean('Notes');
$attach->parent_id = $id;
$attach->parent_type = 'Emails';
$fname = $this->handleEncodedFilename($fileName);
if (!empty($fname)) {//assign name to attachment
$attach->name = $fname;
} else {//if name is empty, default to filename
$attach->name = urlencode($fileName);
}
$attach->filename = urlencode($attach->name);
//get position of last "." in file name
$file_ext_beg = strrpos($attach->filename, ".");
$file_ext = "";
//get file extension
if ($file_ext_beg > 0) {
$file_ext = substr($attach->filename, $file_ext_beg + 1);
}
//check to see if this is a file with extension located in "badext"
foreach ($sugar_config['upload_badext'] as $badExt) {
if (strtolower($file_ext) === strtolower($badExt)) {
//if found, then append with .txt and break out of lookup
$attach->name = $attach->name . ".txt";
$attach->file_mime_type = 'text/';
$attach->filename = $attach->filename . ".txt";
break; // no need to look for more
}
}
$attach->save();
$bin = convert_uudecode($UUEncode);
$filename = "upload://{$attach->id}";
if (file_put_contents($filename, $bin)) {
$GLOBALS['log']->debug('InboundEmail saved attachment file: ' . $filename);
} else {
$GLOBALS['log']->debug('InboundEmail could not create attachment file: ' . $filename);
}
}
/**
* returns true if the email's domain is NOT in the filter domain string
*
* @param object email Email object in question
* @return bool true if not filtered, false if filtered
*/
public function checkFilterDomain($email)
{
$filterDomain = $this->get_stored_options('filter_domain');
if (!isset($filterDomain) || empty($filterDomain)) {
return true; // nothing set for this
}
$replyTo = strtolower($email->reply_to_email);
$from = strtolower($email->from_addr);
$filterDomain = '@' . strtolower($filterDomain);
if (strpos($replyTo, $filterDomain) !== false) {
$GLOBALS['log']->debug('Autoreply cancelled - [reply to] address domain matches filter domain.');
return false;
} elseif (strpos($from, $filterDomain) !== false) {
$GLOBALS['log']->debug('Autoreply cancelled - [from] address domain matches filter domain.');
return false;
}
return true; // no match
}
/**
* returns true if subject is NOT "out of the office" type
*
* @param string subject Subject line of email in question
* @return bool returns false if OOTO found
*/
public function checkOutOfOffice($subject)
{
$ooto = array("Out of the Office", "Out of Office");
foreach ($ooto as $str) {
if (preg_match('/' . $str . '/i', (string) $subject)) {
$GLOBALS['log']->debug('Autoreply cancelled - found "Out of Office" type of subject.');
return false;
}
}
return true; // no matches to ooto strings
}
/**
* sets a timestamp for an autoreply to a single email addy
*
* @param string addr Address of auto-replied target
*/
public function setAutoreplyStatus($addr)
{
$timedate = TimeDate::getInstance();
$this->db->query(
'INSERT INTO inbound_email_autoreply (id, deleted, date_entered, date_modified, autoreplied_to, ie_id) VALUES (
\'' . create_guid() . '\',
0,
\'' . $timedate->nowDb() . '\',
\'' . $timedate->nowDb() . '\',
\'' . $addr . '\',
\'' . $this->id . '\') ',
true
);
}
/**
* returns true if recipient has NOT received 10 auto-replies in 24 hours
*
* @param string from target address for auto-reply
* @return bool true if target is valid/under limit
*/
public function getAutoreplyStatus($from)
{
global $sugar_config;
$timedate = TimeDate::getInstance();
$q_clean = 'UPDATE inbound_email_autoreply SET deleted = 1 WHERE date_entered < \'' . $timedate->getNow()->modify("-24 hours")->asDb() . '\'';
$r_clean = $this->db->query($q_clean, true);
$q = 'SELECT count(*) AS c FROM inbound_email_autoreply WHERE deleted = 0 AND autoreplied_to = \'' . $from . '\' AND ie_id = \'' . $this->id . '\'';
$r = $this->db->query($q, true);
$a = $this->db->fetchByAssoc($r);
$email_num_autoreplies_24_hours = $this->get_stored_options('email_num_autoreplies_24_hours');
$maxReplies = (isset($email_num_autoreplies_24_hours)) ? $email_num_autoreplies_24_hours : $this->maxEmailNumAutoreplies24Hours;
if ($a['c'] >= $maxReplies) {
$GLOBALS['log']->debug('Autoreply cancelled - more than ' . $maxReplies . ' replies sent in 24 hours.');
return false;
}
return true;
}
/**
* returns exactly 1 id match. if more than one, than returns false
* @param $emailName the subject of the email to match
* @param $tableName the table of the matching bean type
*/
public function getSingularRelatedId($emailName, $tableName)
{
$repStrings = array('RE:', 'Re:', 're:');
$preppedName = str_replace($repStrings, '', trim($emailName));
//TODO add team security to this query
$q = 'SELECT count(id) AS c FROM ' . $tableName . ' WHERE deleted = 0 AND name LIKE \'%' . $preppedName . '%\'';
$r = $this->db->query($q, true);
$a = $this->db->fetchByAssoc($r);
if ($a['c'] == 0) {
$q = 'SELECT id FROM ' . $tableName . ' WHERE deleted = 0 AND name LIKE \'%' . $preppedName . '%\'';
$r = $this->db->query($q, true);
$a = $this->db->fetchByAssoc($r);
if ($a === false) {
return null;
} else {
return $a['id'];
}
}
return false;
}
/**
* saves InboundEmail parse macros to config.php
* @param string type Bean to link
* @param string macro The new macro
*/
public function saveInboundEmailSystemSettings($type, $macro)
{
global $sugar_config;
// inbound_email_case_subject_macro
$var = "inbound_email_" . strtolower($type) . "_subject_macro";
$sugar_config[$var] = $macro;
ksort($sugar_config);
$sugar_config_string = "<?php\n" .
'// created: ' . date('Y-m-d H:i:s') . "\n" .
'$sugar_config = ' .
var_export($sugar_config, true) .
";\n?>\n";
write_array_to_file("sugar_config", $sugar_config, "config.php");
}
/**
* returns the HTML for InboundEmail system settings
* @return string HTML
*/
public function getSystemSettingsForm()
{
global $sugar_config;
global $mod_strings;
global $app_strings;
global $app_list_strings;
$c = BeanFactory::newBean('Cases');
$template = new Sugar_Smarty();
$template->assign('APP', $app_strings);
$template->assign('MOD', $mod_strings);
$template->assign('MACRO', $c->getEmailSubjectMacro());
return $template->fetch('modules/InboundEmail/tpls/systemSettingsForm.tpl');
}
/**
* For mailboxes of type "Support" parse for '[CASE:%1]'
*
* @param string $emailName The subject line of the email
* @param aCase $aCase A Case object
*
* @return string|boolean Case ID or FALSE if not found
*/
public function getCaseIdFromCaseNumber($emailName, $aCase)
{
//$emailSubjectMacro
$exMacro = explode('%1', $aCase->getEmailSubjectMacro());
$open = $exMacro[0];
$close = $exMacro[1];
if ($sub = stristr($emailName, $open)) {
// eliminate everything up to the beginning of the macro and return the rest
// $sub is [CASE:XX] xxxxxxxxxxxxxxxxxxxxxx
$sub2 = str_replace($open, '', $sub);
// $sub2 is XX] xxxxxxxxxxxxxx
$sub3 = substr($sub2, 0, strpos($sub2, $close));
// case number is supposed to be numeric
if (ctype_digit($sub3)) {
// filter out deleted records in order to create a new case
// if email is related to deleted one (bug #49840)
$query = 'SELECT id FROM cases WHERE case_number = '
. $this->db->quoted($sub3)
. ' and deleted = 0';
$results = $this->db->query($query, true);
$row = $this->db->fetchByAssoc($results);
if (!empty($row['id'])) {
return $row['id'];
}
}
}
return false;
}
/**
* @param $option_name
* @param null $default_value
* @param null $stored_options
* @return mixed
*/
public function get_stored_options($option_name, $default_value = null, $stored_options = null)
{
if (empty($stored_options)) {
$stored_options = $this->stored_options;
}
return self::get_stored_options_static($option_name, $default_value, $stored_options);
}
/**
* Returns the stored options property un-encoded and un serialised.
* @return array
*/
public function getStoredOptions()
{
return sugar_unserialize(base64_decode($this->stored_options));
}
/**
* @param array $options
*/
public function setStoredOptions($options)
{
$this->stored_options = base64_encode(serialize($options));
}
/**
* @param $option_name
* @param null $default_value
* @param null $stored_options
* @return mixed
*/
public static function get_stored_options_static($option_name, $default_value = null, $stored_options = null)
{
if (!empty($stored_options)) {
$storedOptions = sugar_unserialize(base64_decode($stored_options));
if (isset($storedOptions[$option_name])) {
$default_value = $storedOptions[$option_name];
}
}
return $default_value;
}
/**
* This function returns a contact or user ID if a matching email is found
* @param $email the email address to match
* @param $table which table to query
*/
public function getRelatedId($email, $module)
{
$email = trim(strtoupper($email));
if (strpos($email, ',') !== false) {
$emailsArray = explode(',', $email);
$emailAddressString = "";
foreach ($emailsArray as $emailAddress) {
if (!empty($emailAddressString)) {
$emailAddressString .= ",";
}
$emailAddressString .= $this->db->quoted(trim($emailAddress));
} // foreach
$email = $emailAddressString;
} else {
$email = $this->db->quoted($email);
} // else
$module = $this->db->quoted(ucfirst($module));
$q = "SELECT bean_id FROM email_addr_bean_rel eabr
JOIN email_addresses ea ON (eabr.email_address_id = ea.id)
WHERE bean_module = $module AND ea.email_address_caps in ( {$email} ) AND eabr.deleted=0";
$r = $this->db->query($q, true);
$retArr = array();
while ($a = $this->db->fetchByAssoc($r)) {
$retArr[] = $a['bean_id'];
}
if (count($retArr) > 0) {
return $retArr;
}
return false;
}
/**
* finds emails tagged "//UNSEEN" on mailserver and "SINCE: [date]" if that
* option is set
*
* @return array Array of messageNumbers (mail server's internal keys)
*/
public function getNewMessageIds()
{
$storedOptions = sugar_unserialize(base64_decode($this->stored_options));
//TODO figure out if the since date is UDT
if (!is_bool($storedOptions) && $storedOptions['only_since']) {// POP3 does not support Unseen flags
if (!isset($storedOptions['only_since_last']) && !empty($storedOptions['only_since_last'])) {
$q = "SELECT last_run FROM schedulers WHERE job = '{$this->job_name}'";
$r = $this->db->query($q, true);
$a = $this->db->fetchByAssoc($r);
$date = date('r', strtotime($a['last_run']));
LoggerManager::getLogger()->debug("-----> getNewMessageIds() executed query: {$q}");
} else {
$date = $storedOptions['only_since_last'];
}
$ret = $this->getImap()->search('SINCE "' . $date . '" UNDELETED UNSEEN');
$check = $this->getImap()->check();
$storedOptions['only_since_last'] = $check->Date;
$this->stored_options = base64_encode(serialize($storedOptions));
$this->save();
} else {
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email Connection is not valid resource for getting New Message Ids.');
return false;
}
$ret = $this->getImap()->search('UNDELETED UNSEEN');
}
$nmessages = is_countable($ret)? count($ret) : 0;
LoggerManager::getLogger()->debug('-----> getNewMessageIds() got ' . $nmessages . ' new Messages');
return $ret;
}
/**
* Constructs the resource connection string that IMAP needs
* @param string $service Service string, will generate if not passed
* @return string
*/
public function getConnectString($service = '', $mbox = '', $includeMbox = true)
{
if (!empty($this->connection_string)){
$connectString = '{' . $this->connection_string . '}';
} else {
$service = empty($service) ? $this->getServiceString() : $service;
$protocol = $this->protocol ?? 'imap';
$port = $this->port ?? '143';
$connectString = '{' . $this->server_url . ':' . $port . '/service=' . $protocol . $service . '}';
}
$mbox = empty($mbox) ? $this->mailbox : $mbox;
$connectString .= ($includeMbox) ? $mbox : "";
return $connectString;
}
/**
*
*/
public function disconnectMailserver()
{
if ($this->getImap()->isValidStream($this->conn)) {
$this->getImap()->close();
}
}
/**
* Connects to mailserver. If an existing IMAP resource is available, it
* will attempt to reuse the connection, updating the mailbox path.
*
* @param bool test Flag to test connection
* @param bool force Force reconnect
* @return string "true" on success, "false" or $errorMessage on failure
*/
public function connectMailserver($test = false, $force = false)
{
global $mod_strings, $sugar_config;
$msg = '';
if (!$this->getImap()->isAvailable()) {
$GLOBALS['log']->debug('------------------------- IMAP libraries NOT available!!!! die()ing thread.----');
return $mod_strings['LBL_WARN_NO_IMAP'];
}
$this->getImap()->getErrors(); // clearing error stack
//error_reporting(0); // turn off notices from IMAP
// tls::ca::ssl::protocol::novalidate-cert::notls
if (!isset($_REQUEST['ssl'])) {
LoggerManager::getLogger()->warn('Request ssl value not found.');
$requestSsl = null;
} else {
$requestSsl = $_REQUEST['ssl'];
}
if (empty($this->port) || !in_array($this->port, $sugar_config['valid_imap_ports'] ?? [], true)) {
$GLOBALS['log']->fatal("InboundEmail::connectMailserver - Invalid port provided: '" . ($this->port ?? '') . "'. See valid_imap_ports config.");
return $mod_strings['ERR_INVALID_PORT'] ?? "Invalid port";
}
$useSsl = ($requestSsl == 'true') ? true : false; // TODO: validate the ssl request variable value (for e.g its posibble to give a numeric 1 as true)
if ($test) {
$this->getImap()->setTimeout(1, 5); // 60 secs is the default
$this->getImap()->setTimeout(2, 5);
$this->getImap()->setTimeout(3, 5);
$opts = $this->findOptimumSettings($useSsl);
if (!empty($opts) && isset($opts['good']) && empty($opts['good'])) {
$ret = array_pop($opts['err']); // TODO: lost error info?
return $ret;
}
if (!empty($opts) && is_array($opts['service'])) {
$service = $opts['service'];
} else {
$service = null;
}
$service = str_replace('foo', '', $service); // foo there to support no-item explodes
} else {
$service = $this->getServiceString();
}
if (!isset($_REQUEST['folder'])) {
LoggerManager::getLogger()->warn('Requested folder is not defined');
$requestFolder = null;
} else {
$requestFolder = $_REQUEST['folder'];
}
if ($requestFolder === 'sent') {
$this->mailbox = $this->get_stored_options('sentFolder');
}
if ($requestFolder === 'inbound') {
if (!empty($_REQUEST['folder_name'])) {
$this->mailbox = $_REQUEST['folder_name'];
} elseif ($this->mailboxarray && (is_countable($this->mailboxarray) ? count($this->mailboxarray) : 0)) {
$this->mailbox = $this->mailboxarray[0];
} else {
$this->mailbox = 'INBOX';
}
}
$connectString = $this->getConnectString($service, $this->mailbox);
/*
* Try to recycle the current connection to reduce response times
*/
if ($this->getImap()->isValidStream($this->getImap()->getConnection())) {
if ($force) {
// force disconnect
$this->getImap()->close();
}
if ($this->getImap()->ping()) {
// we have a live connection
$this->getImap()->reopen($connectString, CL_EXPUNGE);
}
}
// final test
if (!$this->getImap()->isValidStream($this->getImap()->getConnection()) && !$test) {
$imapUser = $this->email_user;
[$imapPassword, $imapOAuthConnectionOptions] = $this->getOAuthCredentials($this->email_password, CL_EXPUNGE);
$this->conn = $this->getImapConnection(
$connectString,
$imapUser,
$imapPassword,
$imapOAuthConnectionOptions
);
}
if ($test) {
if ($opts === false && !$this->getImap()->isValidStream($this->getImap()->getConnection())) {
$imapUser = $this->email_user;
[$imapPassword, $imapOAuthConnectionOptions] = $this->getOAuthCredentials($this->email_password, CL_EXPUNGE);
$this->conn = $this->getImapConnection(
$connectString,
$imapUser,
$imapPassword,
$imapOAuthConnectionOptions
);
}
$errors = '';
$alerts = '';
$successful = false;
if (($errors = $this->getImap()->getLastError()) || ($alerts = $this->getImap()->getAlerts()) || !$this->conn) {
if ($errors === 'Mailbox is empty') { // false positive
$successful = true;
} else {
if (!isset($msg)) {
$msg = $errors;
} else {
$msg .= $errors;
}
$msg .= '<p>' . $alerts . '<p>';
$msg .= '<p>' . $mod_strings['ERR_TEST_MAILBOX'];
}
} else {
$successful = true;
}
if ($successful) {
if ($this->protocol == 'imap') {
$msg .= $mod_strings['LBL_TEST_SUCCESSFUL'];
} else {
$msg .= $mod_strings['LBL_POP3_SUCCESS'];
}
}
$this->getImap()->getErrors(); // collapse error stack
if ($this->getImap()->isValidStream($this->getImap()->getConnection())) {
$this->getImap()->close();
} else {
LoggerManager::getLogger()->warn('Connection is not a valid resource.');
}
return $msg;
} elseif (!$this->getImap()->isValidStream($this->getImap()->getConnection())) {
$GLOBALS['log']->fatal('Couldn\'t connect to mail server id: ' . $this->id);
return "false";
}
$GLOBALS['log']->info('Connected to mail server id: ' . $this->id);
return "true";
}
/**
* @return mixed|string|void
*/
public function checkImap()
{
global $app_strings, $mod_strings;
if (!$this->getImap()->isAvailable()) {
$template = new Sugar_Smarty();
$template->assign('APP', $app_strings);
$template->assign('MOD', $mod_strings);
$output = $template->fetch('modules/InboundEmail/tpls/checkImap.tpl');
echo $output;
return $output;
}
}
/**
* Attempt to create an IMAP connection using passed in parameters
* return either the connection resource or false if unable to connect
*
* @param string $mailbox Mailbox to be used to create imap connection
* @param string $username The user name
* @param string $password The password associated with the username
* @param integer $options Bitmask for options parameter to the imap_open function
*
* @return resource|boolean Connection resource on success, FALSE on failure
*/
protected function getImapConnection($mailbox, $username, $password, $options = 0)
{
$connection = null;
$authenticators = ['', 'GSSAPI', 'NTLM'];
$isOAuth = $this->isOAuth();
if ($isOAuth === true) {
$token = $this->getOAuthToken($this->external_oauth_connection_id ?? '');
if ($token === null) {
return false;
}
$password = $token;
}
while (!$connection && ($authenticator = array_shift($authenticators)) !== null) {
if ($authenticator) {
$params = [
'DISABLE_AUTHENTICATOR' => $authenticator,
];
} else {
$params = [];
}
$connection = $this->getImap()->open($mailbox, $username, $password, $options, 0, $params);
if (!$connection){
break;
}
}
return $connection;
}
/**
* retrieves an array of I-E beans based on the group_id
* @param string $groupId GUID of the group user or Individual
* @return array $beans array of beans
* @return boolean false if none returned
*/
public function retrieveByGroupId($groupId)
{
$q = '
SELECT id FROM inbound_email
WHERE
group_id = \'' . $groupId . '\' AND
deleted = 0 AND
status = \'Active\'';
$r = $this->db->query($q, true);
$beans = array();
while ($a = $this->db->fetchByAssoc($r)) {
$ie = BeanFactory::newBean('InboundEmail');
$ie->retrieve($a['id']);
$beans[$a['id']] = $ie;
}
return $beans;
}
/**
* Retrieves the current count of personal accounts for the user specified.
*
* @param unknown_type $user
*/
public function getUserPersonalAccountCount($user = null)
{
if ($user == null) {
$user = $GLOBALS['current_user'];
}
$query = "SELECT count(*) as c FROM inbound_email WHERE deleted=0 AND is_personal='1' AND (group_id='{$user->id}' OR created_by='{$user->id}') AND status='Active'";
$rs = $this->db->query($query);
$row = $this->db->fetchByAssoc($rs);
return $row['c'];
}
/**
* retrieves an array of I-E beans based on the group folder id
* @param string $groupFolderId GUID of the group folder
* @return array $beans array of beans
* @return boolean false if none returned
*/
public function retrieveByGroupFolderId($groupFolderId)
{
$q = 'SELECT id FROM inbound_email WHERE groupfolder_id = \'' . $groupFolderId . '\' AND deleted = 0 ';
$r = $this->db->query($q, true);
$beans = array();
while ($a = $this->db->fetchByAssoc($r)) {
$ie = BeanFactory::newBean('InboundEmail');
$ie->retrieve($a['id']);
$beans[] = $ie;
}
return $beans;
}
/**
* Retrieves an array of I-E beans that the user has team access to
*
* @param string $id user id
* @param bool $includePersonal
* @return array
*/
public function retrieveAllByGroupId($id, $includePersonal = true)
{
$beans = ($includePersonal) ? $this->retrieveByGroupId($id) : array();
$q = "
SELECT inbound_email.id FROM inbound_email
WHERE
is_personal = 0 AND
-- (groupfolder_id is null OR groupfolder_id = '') AND
mailbox_type not like 'bounce' AND
inbound_email.deleted = 0 AND
status = 'Active' ";
$r = $this->db->query($q, true);
while ($a = $this->db->fetchByAssoc($r)) {
$found = false;
foreach ($beans as $bean) {
if ($bean->id == $a['id']) {
$found = true;
}
}
if (!$found) {
$ie = BeanFactory::newBean('InboundEmail');
$ie->retrieve($a['id']);
$beans[$a['id']] = $ie;
}
}
return $beans;
}
/**
* Retrieves an array of I-E beans that the user has team access to including group
*
* @param string $id
* @param bool $includePersonal
* @return InboundEmail[]
*/
public function retrieveAllByGroupIdWithGroupAccounts($id, $includePersonal = true)
{
$beans = ($includePersonal) ? $this->retrieveByGroupId($id) : array();
$q = "
SELECT DISTINCT inbound_email.id
FROM inbound_email
WHERE
is_personal = 0 AND
mailbox_type not like 'bounce' AND
status = 'Active' AND
inbound_email.deleted = 0 ";
$r = $this->db->query($q, true);
while ($a = $this->db->fetchByAssoc($r)) {
$found = false;
foreach ($beans as $bean) {
if ($bean->id == $a['id']) {
$found = true;
}
}
if (!$found) {
$ie = BeanFactory::newBean('InboundEmail');
$ie->retrieve($a['id']);
$beans[$a['id']] = $ie;
}
}
return $beans;
}
/**
* returns the bean name - overrides SugarBean's
*/
public function get_summary_text()
{
return $this->name;
}
/**
* Override's SugarBean's
*/
public function create_export_query($order_by, $where, $show_deleted = 0)
{
return $this->create_new_list_query($order_by, $where, array(), array(), $show_deleted);
}
/**
* @return array
*/
public function getUserInboundAccounts(): array {
global $current_user, $db;
$where = '';
if (is_admin($current_user)) {
$currentUserId = $db->quote($current_user->id);
$tableName = $db->quote($this->table_name);
$where = "(($tableName.is_personal IS NULL) OR ($tableName.is_personal = 0 ) OR ($tableName.is_personal = 1 AND $tableName.created_by = '$currentUserId'))";
}
return $this->get_list('', $where)['list'] ?? [];
}
/**
* @inheritDoc
*/
public function create_new_list_query(
$order_by,
$where,
$filter = array(),
$params = array(),
$show_deleted = 0,
$join_type = '',
$return_array = false,
$parentbean = null,
$singleSelect = false,
$ifListForExport = false
) {
global $current_user, $db;
$ret_array = parent::create_new_list_query(
$order_by,
$where,
$filter,
$params ,
$show_deleted,
$join_type,
true,
$parentbean,
$singleSelect,
$ifListForExport
);
if(is_admin($current_user)) {
if ($return_array) {
return $ret_array;
}
return $ret_array['select'] . $ret_array['from'] . $ret_array['where'] . $ret_array['order_by'];
}
if (is_array($ret_array) && !empty($ret_array['where'])){
$tableName = $db->quote($this->table_name);
$currentUserId = $db->quote($current_user->id);
$showGroupRecords = "($tableName.is_personal IS NULL) OR ($tableName.is_personal = 0) OR ";
$hasActionAclsDefined = has_group_action_acls_defined('InboundEmail', 'list');
if($hasActionAclsDefined === false) {
$showGroupRecords = '';
}
$ret_array['where'] = $ret_array['where'] . " AND ( $showGroupRecords ($tableName.is_personal = 1 AND $tableName.created_by = '$currentUserId') )";
}
if ($return_array) {
return $ret_array;
}
return $ret_array['select'] . $ret_array['from'] . $ret_array['where'] . $ret_array['order_by'];
}
/**
* Override's SugarBean's
*/
/**
* Override's SugarBean's
*/
public function get_list_view_data()
{
global $mod_strings;
global $app_list_strings;
$temp_array = $this->get_list_view_array();
$temp_array['MAILBOX_TYPE_NAME'] = '';
if (!empty($this->mailbox_type)) {
if (!isset($app_list_strings['dom_mailbox_type'][$this->mailbox_type])) {
LoggerManager::getLogger()->fatal('Language string not found for app_list_string[dom_mailbox_type][' . $this->mailbox_type . ']');
}
$temp_array['MAILBOX_TYPE_NAME'] = $app_list_strings['dom_mailbox_type'][$this->mailbox_type] ?? null;
}
//cma, fix bug 21670.
$temp_array['GLOBAL_PERSONAL_STRING'] = ($this->is_personal ? $mod_strings['LBL_IS_PERSONAL'] : $mod_strings['LBL_IS_GROUP']);
$temp_array['STATUS'] = ($this->status == 'Active') ? $mod_strings['LBL_STATUS_ACTIVE'] : $mod_strings['LBL_STATUS_INACTIVE'];
return $temp_array;
}
/**
* Override's SugarBean's
*/
public function fill_in_additional_list_fields()
{
$this->fill_in_additional_detail_fields();
}
/**
* Override's SugarBean's
*/
public function fill_in_additional_detail_fields()
{
$this->calculateType();
$this->calculateDefault();
$this->calculateSignature();
$this->expandStoreOptions();
if (!empty($this->service)) {
$exServ = explode('::', $this->service);
$this->tls = $exServ[0];
if (isset($exServ[1])) {
$this->ca = $exServ[1];
}
if (isset($exServ[2])) {
$this->ssl = $exServ[2];
}
if (isset($exServ[3])) {
$this->protocol = $exServ[3];
}
}
}
public function calculateType(): void {
if (!empty($this->type)){
return;
}
if (isTrue($this->is_personal ?? false)) {
$this->type = 'personal';
return;
}
$mailboxType = $this->mailbox_type ?? '';
if ($mailboxType === 'createcase') {
$this->type = 'group';
return;
}
if ($mailboxType === 'bounce') {
$this->type = 'bounce';
return;
}
if ($mailboxType === 'pick' ) {
$this->type = 'group';
}
}
public function calculateDefault(): void {
global $current_user;
if ($this->type === 'personal' && $this->getUsersDefaultOutboundServerId($current_user) === $this->id) {
$this->is_default = 1;
}
}
public function calculateSignature(): void {
$inboundEmailId = $this->id ?? '';
$createdBy = $this->created_by ?? '';
if ($inboundEmailId === '' || $createdBy === '') {
return;
}
/** @var User $owner */
$owner = BeanFactory::getBean('Users', $createdBy);
$emailSignatures = $owner->getPreference('account_signatures', 'Emails') ?? '';
$emailSignatures = sugar_unserialize(base64_decode($emailSignatures));
$signatureId = $emailSignatures[$inboundEmailId] ?? '';
if ($signatureId !== '') {
$this->account_signature_id = $signatureId;
}
}
/**
* Expand options
* @return void
*/
public function expandStoreOptions(): void {
if (empty($this->stored_options)) {
return;
}
// FROM NAME and Address
$storedOptions = unserialize(base64_decode($this->stored_options), ['allowed_classes' => false]);
$this->from_name = ($storedOptions['from_name'] ?? '');
$this->from_addr = ($storedOptions['from_addr'] ?? '');
$this->reply_to_name = $storedOptions['reply_to_name'] ?? '';
$this->reply_to_addr = $storedOptions['reply_to_addr'] ?? '';
$this->only_since = isTrue($storedOptions['LBL_ONLY_SINCE_NO'] ?? false);
$this->filter_domain = $storedOptions['filter_domain'] ?? '';
$this->trashFolder = $storedOptions['trashFolder'] ?? '';
$this->sentFolder = $storedOptions['sentFolder'] ?? '';
$this->mailbox = $storedOptions['mailbox'] ?? '';
$this->leave_messages_on_mail_server = isTrue($storedOptions['leaveMessagesOnMailServer'] ?? false);
$this->move_messages_to_trash_after_import = !isTrue($storedOptions['leaveMessagesOnMailServer'] ?? true);
$this->distrib_method = $storedOptions['distrib_method'] ?? '';
$this->distribution_user_id = $storedOptions['distribution_user_id'] ?? '';
$this->distribution_options = $storedOptions['distribution_options'] ?? '';
$this->create_case_template_id = $storedOptions['create_case_email_template'] ?? '';
$this->email_num_autoreplies_24_hours = $storedOptions['email_num_autoreplies_24_hours'] ?? $this->defaultEmailNumAutoreplies24Hours;
$this->is_auto_import = isTrue($storedOptions['isAutoImport'] ?? false);
$this->is_create_case = ($this->mailbox_type ?? '') === 'createcase';
$this->allow_outbound_group_usage = isTrue($storedOptions['allow_outbound_group_usage'] ?? false);
$this->outbound_email_id = $storedOptions['outbound_email'] ?? '';
}
/**
* Checks for $user's autoImport setting and returns the current value
* @param object $user User in focus, defaults to $current_user
* @return bool
*/
public function isAutoImport($user = null)
{
if (!empty($this->autoImport)) {
return $this->autoImport;
}
global $current_user;
if (empty($user)) {
$user = $current_user;
}
$emailSettings = $current_user->getPreference('emailSettings', 'Emails');
$emailSettings = is_string($emailSettings) ? sugar_unserialize($emailSettings) : $emailSettings;
$this->autoImport = (isset($emailSettings['autoImport']) && !empty($emailSettings['autoImport'])) ? true : false;
return $this->autoImport;
}
/**
* Clears out cache files for a user
*/
public function cleanOutCache()
{
$GLOBALS['log']->debug("INBOUNDEMAIL: at cleanOutCache()");
$this->deleteCache();
}
/**
* moves emails from folder to folder
* @param string $fromIe I-E id
* @param string $fromFolder IMAP path to folder in which the email lives
* @param string $toIe I-E id
* @param string $toFolder
* @param string $uids UIDs of emails to move, either Sugar GUIDS or IMAP
* UIDs
*/
public function copyEmails($fromIe, $fromFolder, $toIe, $toFolder, $uids)
{
$this->moveEmails($fromIe, $fromFolder, $toIe, $toFolder, $uids, true);
}
/**
* moves emails from folder to folder
* @param string $fromIe I-E id
* @param string $fromFolder IMAP path to folder in which the email lives
* @param string $toIe I-E id
* @param string $toFolder
* @param string $uids UIDs of emails to move, either Sugar GUIDS or IMAP
* UIDs
* @param bool $copy Default false
* @return bool True on successful execution
*/
public function moveEmails($fromIe, $fromFolder, $toIe, $toFolder, $uids, $copy = false)
{
global $app_strings;
global $current_user;
// same I-E server
if ($fromIe == $toIe) {
$GLOBALS['log']->debug("********* SUGARFOLDER - moveEmails() moving email from I-E to I-E");
//$exDestFolder = explode("::", $toFolder);
//preserve $this->mailbox
if ($this->mailbox !== null) {
$oldMailbox = $this->mailbox;
}
$this->retrieve($fromIe);
$this->mailbox = $fromFolder;
$this->connectMailserver();
$exUids = explode('::;::', $uids);
$uids = implode(",", $exUids);
// imap_mail_move accepts comma-delimited lists of UIDs
if ($copy) {
if ($this->getImap()->mailCopy($uids, $toFolder, CP_UID)) {
$this->mailbox = $toFolder;
$this->connectMailserver();
$newOverviews = $this->getImap()->fetchOverview($uids, FT_UID);
$this->updateOverviewCacheFile($newOverviews, 'append');
if (isset($oldMailbox)) {
$this->mailbox = $oldMailbox;
}
return true;
}
$GLOBALS['log']->debug("INBOUNDEMAIL: could not imap_mail_copy() [ {$uids} ] to folder [ {$toFolder} ] from folder [ {$fromFolder} ]");
} else {
if ($this->getImap()->mailMove($uids, $toFolder, CP_UID)) {
$GLOBALS['log']->info("INBOUNDEMAIL: imap_mail_move() [ {$uids} ] to folder [ {$toFolder} ] from folder [ {$fromFolder} ]");
$this->getImap()->expunge(); // hard deletes moved messages
// update cache on fromFolder
$newOverviews = $this->getOverviewsFromCacheFile($uids, $fromFolder, true);
$this->deleteCachedMessages($uids, $fromFolder);
// update cache on toFolder
$this->checkEmailOneMailbox($toFolder, true, true);
if (isset($oldMailbox)) {
$this->mailbox = $oldMailbox;
}
return true;
}
$GLOBALS['log']->debug("INBOUNDEMAIL: could not imap_mail_move() [ {$uids} ] to folder [ {$toFolder} ] from folder [ {$fromFolder} ]");
}
} elseif ($toIe == 'folder' && $fromFolder == 'sugar::Emails') {
$GLOBALS['log']->debug("********* SUGARFOLDER - moveEmails() moving email from SugarFolder to SugarFolder");
// move from sugar folder to sugar folder
require_once("include/SugarFolders/SugarFolders.php");
$sugarFolder = new SugarFolder();
$exUids = explode($app_strings['LBL_EMAIL_DELIMITER'], $uids);
foreach ($exUids as $id) {
if ($copy) {
$sugarFolder->copyBean($fromIe, $toFolder, $id, "Emails");
} else {
$fromSugarFolder = new SugarFolder();
$fromSugarFolder->retrieve($fromIe);
$toSugarFolder = new SugarFolder();
$toSugarFolder->retrieve($toFolder);
$email = BeanFactory::newBean('Emails');
$email->retrieve($id);
$email->status = 'unread';
// when you move from My Emails to Group Folder, Assign To field for the Email should become null
if ($fromSugarFolder->is_dynamic && $toSugarFolder->is_group) {
// Bug 50972 - assigned_user_id set to empty string not true null
// Modifying the field defs in just this one place to allow
// a true null since this is what is expected when reading
// inbox folders
$email->setFieldNullable('assigned_user_id');
$email->assigned_user_id = "";
$email->save();
$email->revertFieldNullable('assigned_user_id');
// End fix 50972
if (!$toSugarFolder->checkEmailExistForFolder($id)) {
$fromSugarFolder->deleteEmailFromAllFolder($id);
$toSugarFolder->addBean($email);
}
} elseif ($fromSugarFolder->is_group && $toSugarFolder->is_dynamic) {
$fromSugarFolder->deleteEmailFromAllFolder($id);
$email->assigned_user_id = $current_user->id;
$email->save();
} else {
// If you are moving something from personal folder then delete an entry from all folder
if (!$fromSugarFolder->is_dynamic && !$fromSugarFolder->is_group) {
$fromSugarFolder->deleteEmailFromAllFolder($id);
} // if
if ($fromSugarFolder->is_dynamic && !$toSugarFolder->is_dynamic && !$toSugarFolder->is_group) {
$email->assigned_user_id = "";
$toSugarFolder->addBean($email);
} // if
if (!$toSugarFolder->checkEmailExistForFolder($id)) {
if (!$toSugarFolder->is_dynamic) {
$fromSugarFolder->deleteEmailFromAllFolder($id);
$toSugarFolder->addBean($email);
} else {
$fromSugarFolder->deleteEmailFromAllFolder($id);
$email->assigned_user_id = $current_user->id;
}
} else {
$sugarFolder->move($fromIe, $toFolder, $id);
} // else
$email->save();
} // else
}
}
return true;
} elseif ($toIe == 'folder') {
$GLOBALS['log']->debug("********* SUGARFOLDER - moveEmails() moving email from I-E to SugarFolder");
// move to Sugar folder
require_once("include/SugarFolders/SugarFolders.php");
$sugarFolder = new SugarFolder();
$sugarFolder->retrieve($toFolder);
//Show the import form if we don't have the required info
if (!isset($_REQUEST['delete'])) {
$json = getJSONobj();
if ($sugarFolder->is_group) {
$_REQUEST['showTeam'] = false;
$_REQUEST['showAssignTo'] = false;
}
$ret = $this->email->et->getImportForm($_REQUEST, $this->email);
$ret['move'] = true;
$ret['srcFolder'] = $fromFolder;
$ret['srcIeId'] = $fromIe;
$ret['dstFolder'] = $toFolder;
$ret['dstIeId'] = $toIe;
$out = trim($json->encode($ret, false));
echo $out;
return true;
}
// import to Sugar
$this->retrieve($fromIe);
$this->mailbox = $fromFolder;
$this->connectMailserver();
// If its a group folder the team should be of the folder team
if ($sugarFolder->is_group) {
$_REQUEST['team_id'] = $sugarFolder->team_id;
$_REQUEST['team_set_id'] = $sugarFolder->team_set_id;
}
// TODO - set team_id, team_set for new UI
// else
$exUids = explode($app_strings['LBL_EMAIL_DELIMITER'], $uids);
if (!empty($sugarFolder->id)) {
$count = 1;
$return = array();
$json = getJSONobj();
foreach ($exUids as $k => $uid) {
$msgNo = $uid;
if ($this->isPop3Protocol()) {
$msgNo = $this->getCorrectMessageNoForPop3($uid);
} else {
$msgNo = $this->getImap()->getMessageNo($uid);
}
if (!empty($msgNo)) {
$importStatus = $this->returnImportedEmail($msgNo, $uid);
// add to folder
if ($importStatus) {
$sugarFolder->addBean($this);
if (!$copy && isset($_REQUEST['delete']) && ($_REQUEST['delete'] == "true") && $importStatus) {
$GLOBALS['log']->error("********* delete from mailserver [ {explode(", ", $uids)} ]");
// delete from mailserver
$this->deleteMessageOnMailServer($uid);
$this->deleteMessageFromCache($uid);
} // if
}
$return[] = $app_strings['LBL_EMAIL_MESSAGE_NO'] . " " . $count . ", " . $app_strings['LBL_STATUS'] . " " . ($importStatus ? $app_strings['LBL_EMAIL_IMPORT_SUCCESS'] : $app_strings['LBL_EMAIL_IMPORT_FAIL']);
$count++;
} // if
} // foreach
echo $json->encode($return);
return true;
}
$GLOBALS['log']->error("********* SUGARFOLDER - failed to retrieve folder ID [ {$toFolder} ]");
} else {
$GLOBALS['log']->debug("********* SUGARFOLDER - moveEmails() called with no passing criteria");
}
return false;
}
/**
* Hard deletes an I-E account
* @param string id GUID
*/
public function hardDelete($id)
{
$q = "DELETE FROM inbound_email WHERE id = '{$id}'";
$this->db->query($q, true);
$q = "DELETE FROM folders WHERE id = '{$id}'";
$this->db->query($q, true);
$q = "DELETE FROM folders WHERE parent_folder = '{$id}'";
$this->db->query($q, true);
}
/**
* Generate a unique filename for attachments based on the message id. There are no maximum
* specifications for the length of the message id, the only requirement is that it be globally unique.
*
* @param bool $nameOnly Whether or not the attachment count should be appended to the filename.
* @return string The temp file name
*/
public function getTempFilename($nameOnly = false)
{
$str = $this->compoundMessageId;
if (!$nameOnly) {
$str = $str . $this->attachmentCount;
$this->attachmentCount++;
}
return $str;
}
/**
* deletes and expunges emails on server
* @param string $uid UID(s), comma delimited, of email(s) on server
* @return bool true on success
*/
public function deleteMessageOnMailServer($uid)
{
global $app_strings;
$this->connectMailserver();
$uids = [];
if (strpos($uid, (string) $app_strings['LBL_EMAIL_DELIMITER']) !== false) {
$uids = explode($app_strings['LBL_EMAIL_DELIMITER'], $uid);
} else {
$uids[] = $uid;
}
$return = true;
$msgnos = [];
if ($this->protocol == 'imap') {
$trashFolder = $this->get_stored_options("trashFolder");
if (empty($trashFolder)) {
$trashFolder = "INBOX.Trash";
}
$uidsToMove = implode('::;::', $uids);
if ($this->moveEmails($this->id, $this->mailbox, $this->id, $trashFolder, $uidsToMove)) {
$GLOBALS['log']->fatal("INBOUNDEMAIL: MoveEmail to {$trashFolder} successful.");
} else {
$GLOBALS['log']->fatal("INBOUNDEMAIL: MoveEmail to {$trashFolder} FAILED - trying hard delete for message: $uid");
$uidsToDelete = implode(',', $uids);
$this->getImap()->delete($uidsToDelete, FT_UID);
$return = true;
}
} else {
foreach ($uids as $uid) {
$msgnos[] = $this->getCorrectMessageNoForPop3($uid);
}
$msgnos = implode(',', $msgnos);
$this->getImap()->delete($msgnos);
$return = true;
}
if (!$this->getImap()->expunge()) {
$GLOBALS['log']->debug("NOOP: could not expunge deleted email.");
$return = false;
} else {
LoggerManager::getLogger()->info("INBOUNDEMAIL: hard-deleted mail with MSgno's' [ {$msgnos} ]");
}
return $return;
}
/**
* deletes and expunges emails on server
* @param string $uid UID(s), comma delimited, of email(s) on server
*/
public function deleteMessageOnMailServerForPop3($uid)
{
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email connection is not a resource for deleting Message On Mail Server For Pop3');
return false;
}
if ($this->getImap()->delete($uid)) {
if (!$this->getImap()->expunge()) {
$GLOBALS['log']->debug("NOOP: could not expunge deleted email.");
$return = false;
} else {
$GLOBALS['log']->info("INBOUNDEMAIL: hard-deleted mail with MSgno's' [ {$uid} ]");
}
}
}
/**
* Checks if this is a pop3 type of an account or not
* @return boolean
*/
public function isPop3Protocol()
{
return ($this->protocol == 'pop3');
}
/**
* Gets the UIDL from database for the corresponding msgno
* @param int messageNo of a message
* @return UIDL for the message
*/
public function getUIDLForMessage($msgNo)
{
$query = "SELECT message_id FROM email_cache WHERE ie_id = '{$this->id}' AND msgno = '{$msgNo}'";
$r = $this->db->query($query);
$a = $this->db->fetchByAssoc($r);
// Protect against the query failing.
if ($a === false) {
return null;
} else {
return $a['message_id'];
}
}
/**
* Get the users default IE account id
*
* @param User $user
* @return string
*/
public function getUsersDefaultOutboundServerId($user)
{
$id = $user->getPreference($this->keyForUsersDefaultIEAccount, 'Emails', $user);
//If no preference has been set, grab the default system id.
if (empty($id)) {
$oe = new OutboundEmail();
$system = $oe->getSystemMailerSettings();
$id = empty($system->id) ? '' : $system->id;
}
return $id;
}
public function isOnlyPersonalInbound()
{
$inboundAccount = $this->getUserPersonalAccountCount();
if ($inboundAccount == 1) {
return true;
}
return false;
}
/**
* @param $id
* @return bool
*/
public function isDefaultPersonalInbound($userId): bool
{
$user = BeanFactory::getBean('Users', $userId);
$isDefault = $user->getPreference($this->keyForUsersDefaultIEAccount, 'Emails');
if ($isDefault == $userId){
return true;
}
return false;
}
/**
* Get the users default IE account id
*
* @param User $user
*/
public function setUsersDefaultOutboundServerId($user, $oe_id)
{
$user->setPreference($this->keyForUsersDefaultIEAccount, $oe_id, '', 'Emails');
}
/**
* Gets the UIDL from database for the corresponding msgno
* @param int messageNo of a message
* @return UIDL for the message
*/
public function getMsgnoForMessageID($messageid)
{
$query = "SELECT msgno FROM email_cache WHERE ie_id = '{$this->id}' AND message_id = '{$messageid}'";
$r = $this->db->query($query);
$a = $this->db->fetchByAssoc($r);
if (!isset($a['message_id'])) {
LoggerManager::getLogger()->warn('unable to get msgno for message id');
return null;
}
return $a['message_id'];
}
/**
* fills InboundEmail->email with an email's details
* @param int uid Unique ID of email
* @param bool isMsgNo flag that passed ID is msgNo, default false
* @param bool setRead Sets the 'seen' flag in cache
* @param bool forceRefresh Skips cache file
* @return string
*/
public function setEmailForDisplay($uid, $isMsgNo = false, $setRead = false, $forceRefresh = false)
{
if (empty($uid)) {
$GLOBALS['log']->debug("*** ERROR: INBOUNDEMAIL trying to setEmailForDisplay() with no UID");
return 'NOOP';
}
global $sugar_config;
global $app_strings;
$cacheFile = [];
// if its a pop3 then get the UIDL and see if this file name exist or not
if ($this->isPop3Protocol()) {
// get the UIDL from database;
$cachedUIDL = md5($uid);
$cache = "{$this->EmailCachePath}/{$this->id}/messages/{$this->mailbox}{$cachedUIDL}.php";
} else {
$cache = "{$this->EmailCachePath}/{$this->id}/messages/{$this->mailbox}{$uid}.php";
}
if (isset($cache) && strpos($cache, "..") !== false) {
die("Directory navigation attack denied.");
}
if (file_exists($cache) && !$forceRefresh) {
$GLOBALS['log']->info("INBOUNDEMAIL: Using cache file for setEmailForDisplay()");
include($cache); // profides $cacheFile
/** @var $cacheFile array */
$metaOut = unserialize($cacheFile['out']);
$meta = $metaOut['meta']['email'];
$email = BeanFactory::newBean('Emails');
foreach ($meta as $k => $v) {
$email->$k = $v;
}
$email->to_addrs = $meta['toaddrs'];
$email->date_sent_received = $meta['date_start'];
$this->email = $email;
$this->email->email2init();
$ret = 'cache';
} else {
$GLOBALS['log']->info("INBOUNDEMAIL: opening new connection for setEmailForDisplay()");
if ($this->isPop3Protocol()) {
$msgNo = $this->getCorrectMessageNoForPop3($uid);
} else {
if (empty($this->conn)) {
$this->connectMailserver();
}
$msgNo = ($isMsgNo) ? $uid : $this->getImap()->getMessageNo($uid);
}
if (empty($this->conn)) {
$status = $this->connectMailserver();
if ($status == "false") {
$this->email = BeanFactory::newBean('Emails');
$this->email->name = $app_strings['LBL_EMAIL_ERROR_MAILSERVERCONNECTION'];
$ret = 'error';
return $ret;
}
}
$this->returnImportedEmail($msgNo, $uid, true);
$this->email->id = '';
$this->email->new_with_id = false;
$ret = 'import';
}
if ($setRead) {
$this->setStatuses($uid, 'seen', 1);
}
return $ret;
}
/**
* Sets status for a particular attribute on the mailserver and the local cache file
*/
public function setStatuses($uid, $field, $value)
{
global $sugar_config;
/** available status fields
* [subject] => aaa
* [from] => Some Name
* [to] => Some Name
* [date] => Mon, 22 Jan 2007 17:32:57 -0800
* [message_id] =>
* [size] => 718
* [uid] => 191
* [msgno] => 141
* [recent] => 0
* [flagged] => 0
* [answered] => 0
* [deleted] => 0
* [seen] => 1
* [draft] => 0
*/
// local cache
$file = "{$this->mailbox}.imapFetchOverview.php";
$overviews = $this->getCacheValueForUIDs($this->mailbox, array($uid));
if (!empty($overviews)) {
$updates = array();
foreach ($overviews['retArr'] as $k => $obj) {
if ($obj->imap_uid == $uid) {
$obj->$field = $value;
$updates[] = $obj;
}
}
if (!empty($updates)) {
$this->setCacheValue($this->mailbox, array(), $updates);
}
}
}
/**
* Removes an email from the cache file, deletes the message from the cache too
* @param string String of uids, comma delimited
*/
public function deleteMessageFromCache($uids)
{
global $app_strings;
// delete message cache file and email_cache file
$exUids = explode($app_strings['LBL_EMAIL_DELIMITER'], $uids);
foreach ($exUids as $uid) {
// local cache
$queryUID = $this->db->quote($uid);
if ($this->isPop3Protocol()) {
$q = "DELETE FROM email_cache WHERE message_id = '{$queryUID}' AND ie_id = '{$this->id}'";
} else {
$q = "DELETE FROM email_cache WHERE imap_uid = '{$queryUID}' AND ie_id = '{$this->id}'";
}
$r = $this->db->query($q);
if ($this->isPop3Protocol()) {
$uid = md5($uid);
} // if
$msgCacheFile = "{$this->EmailCachePath}/{$this->id}/messages/{$this->mailbox}{$uid}.php";
if (file_exists($msgCacheFile)) {
if (!unlink($msgCacheFile)) {
$GLOBALS['log']->error("***ERROR: InboundEmail could not delete the cache file [ {$msgCacheFile} ]");
}
}
}
}
/**
* Shows one email.
* @param int uid UID of email to display
* @param string mbox Mailbox to look in for the message
* @param bool isMsgNo Flag to assume $uid is a MessageNo, not UniqueID, default false
*/
public function displayOneEmail($uid, $mbox, $isMsgNo = false)
{
require_once("include/JSON.php");
global $timedate;
global $app_strings;
global $app_list_strings;
global $sugar_smarty;
global $theme;
global $current_user;
global $sugar_config;
$fetchedAttributes = array(
'name',
'from_name',
'from_addr',
'date_start',
'time_start',
'message_id',
);
$souEmail = array();
foreach ($fetchedAttributes as $k) {
if ($k == 'date_start') {
$this->email->$k . " " . $this->email->time_start;
$souEmail[$k] = $this->email->$k . " " . $this->email->time_start;
} elseif ($k == 'time_start') {
$souEmail[$k] = "";
} else {
$souEmail[$k] = trim($this->email->$k);
}
}
// if a MsgNo is passed in, convert to UID
if ($isMsgNo) {
$uid = $this->getImap()->getUid($uid);
}
// meta object to allow quick retrieval for replies
$meta = array();
$meta['type'] = $this->email->type;
$meta['uid'] = $uid;
$meta['ieId'] = $this->id;
$meta['email'] = $souEmail;
$meta['mbox'] = $this->mailbox;
$ccs = '';
// imap vs pop3
// self mapping
$exMbox = explode("::", $mbox);
// CC section
$cc = '';
if (!empty($this->email->cc_addrs)) {
//$ccs = $this->collapseLongMailingList($this->email->cc_addrs);
$ccs = to_html($this->email->cc_addrs_names);
$cc = <<<eoq
<tr>
<td NOWRAP valign="top" class="displayEmailLabel">
{$app_strings['LBL_EMAIL_CC']}:
</td>
<td class="displayEmailValue">
{$ccs}
</td>
</tr>
eoq;
}
$meta['cc'] = $cc;
$meta['email']['cc_addrs'] = $ccs;
// attachments
$attachments = '';
if ($mbox == "sugar::Emails") {
$q = "SELECT id, filename, file_mime_type FROM notes WHERE parent_id = '{$uid}' AND deleted = 0";
$r = $this->db->query($q);
$i = 0;
while ($a = $this->db->fetchByAssoc($r)) {
$url = "index.php?entryPoint=download&type=notes&id={$a['id']}";
$lbl = ($i == 0) ? $app_strings['LBL_EMAIL_ATTACHMENTS'] . ":" : '';
$i++;
$attachments .= <<<EOQ
<tr>
<td NOWRAP valign="top" class="displayEmailLabel">
{$lbl}
</td>
<td NOWRAP valign="top" colspan="2" class="displayEmailValue">
<a href="{$url}">{$a['filename']}</a>
</td>
</tr>
EOQ;
$this->email->cid2Link($a['id'], $a['file_mime_type']);
} // while
} else {
if ($this->attachmentCount > 0) {
$theCount = $this->attachmentCount;
for ($i = 0; $i < $theCount; $i++) {
$lbl = ($i == 0) ? $app_strings['LBL_EMAIL_ATTACHMENTS'] . ":" : '';
$name = $this->getTempFilename(true) . $i;
$tempName = urlencode($this->tempAttachment[$name]);
$url = "index.php?entryPoint=download&type=temp&isTempFile=true&ieId={$this->id}&tempName={$tempName}&id={$name}";
$attachments .= <<<eoq
<tr>
<td NOWRAP valign="top" class="displayEmailLabel">
{$lbl}
</td>
<td NOWRAP valign="top" colspan="2" class="displayEmailValue">
<a href="{$url}">{$this->tempAttachment[$name]}</a>
</td>
</tr>
eoq;
} // for
} // if
} // else
$meta['email']['attachments'] = $attachments;
// toasddrs
$meta['email']['toaddrs'] = $this->collapseLongMailingList($this->email->to_addrs);
$meta['email']['cc_addrs'] = $ccs;
// body
$description = (empty($this->email->description_html)) ? nl2br($this->email->description) : $this->email->description_html;
$meta['email']['description'] = $description;
// meta-metadata
$meta['is_sugarEmail'] = ($exMbox[0] == 'sugar') ? true : false;
if (!$meta['is_sugarEmail']) {
if ($this->isAutoImport) {
$meta['is_sugarEmail'] = true;
}
} else {
if ($this->email->status != 'sent') {
// mark SugarEmail read
$q = "UPDATE emails SET status = 'read' WHERE id = '{$uid}'";
$r = $this->db->query($q);
}
}
$return = array();
$meta['email']['name'] = to_html($this->email->name);
$meta['email']['from_addr'] = (!empty($this->email->from_addr_name)) ? to_html($this->email->from_addr_name) : to_html($this->email->from_addr);
isValidEmailAddress($meta['email']['from_addr']);
$meta['email']['toaddrs'] = (!empty($this->email->to_addrs_names)) ? to_html($this->email->to_addrs_names) : to_html($this->email->to_addrs);
$meta['email']['cc_addrs'] = to_html($this->email->cc_addrs_names);
$meta['email']['reply_to_addr'] = to_html($this->email->reply_to_addr);
$return['meta'] = $meta;
return $return;
}
/**
* Takes a long list of email addresses from a To or CC field and shows the first 3, the rest hidden
* @param string emails
* @return string
*/
public function collapseLongMailingList($emails)
{
global $app_strings;
$ex = explode(",", $emails);
$i = 0;
$j = 0;
if (count($ex) > 3) {
$emails = "";
$emailsHidden = "";
foreach ($ex as $email) {
if ($i < 2) {
if (!empty($emails)) {
$emails .= ", ";
}
$emails .= trim($email);
} else {
if (!empty($emailsHidden)) {
$emailsHidden .= ", ";
}
$emailsHidden .= trim($email);
$j++;
}
$i++;
}
if (!empty($emailsHidden)) {
$email2 = $emails;
$emails = "<span onclick='javascript:SUGAR.email2.detailView.showFullEmailList(this);' style='cursor:pointer;'>{$emails} [...{$j} {$app_strings['LBL_MORE']}]</span>";
$emailsHidden = "<span onclick='javascript:SUGAR.email2.detailView.showCroppedEmailList(this)' style='cursor:pointer; display:none;'>{$email2}, {$emailsHidden} [ {$app_strings['LBL_LESS']} ]</span>";
}
$emails .= $emailsHidden;
}
return $emails;
}
/**
* Sorts IMAP's imap_fetch_overview() results
* @param array $arr Array of standard objects
* @param string $sort Column to sort by
* @param string direction Direction to sort by (asc/desc)
* @return array Sorted array of obj.
*/
public function sortFetchedOverview($arr, $sort = 4, $direction = 'DESC', $forceSeen = false)
{
global $current_user;
$currentNode = [];
$sortPrefs = $current_user->getPreference('folderSortOrder', 'Emails');
if (!empty($sortPrefs)) {
$listPrefs = $sortPrefs;
} else {
$listPrefs = array();
}
if (isset($listPrefs[$this->id][$this->mailbox])) {
$currentNode = $listPrefs[$this->id][$this->mailbox];
}
if (isset($currentNode['current']) && !empty($currentNode['current'])) {
$sort = $currentNode['current']['sort'];
$direction = $currentNode['current']['direction'];
}
// sort defaults
if (empty($sort)) {
$sort = $this->defaultSort;//4;
$direction = $this->defaultDirection; //'DESC';
} elseif (!is_numeric($sort)) {
// handle bad sort index
$sort = $this->defaultSort;
} else {
// translate numeric index to human readable
$sort = $this->hrSort[$sort];
}
if (empty($direction)) {
$direction = 'DESC';
}
$retArr = array();
$sorts = array();
foreach ($arr as $k => $overview) {
$sorts['flagged'][$k] = $overview->flagged;
$sorts['status'][$k] = $overview->answered;
$sorts['from'][$k] = str_replace('"', "", $this->handleMimeHeaderDecode($overview->from));
$sorts['subj'][$k] = $this->handleMimeHeaderDecode(quoted_printable_decode($overview->subject));
$sorts['date'][$k] = $overview->date;
}
// sort by column
natcasesort($sorts[$sort]);
// direction
if (strtolower($direction) == 'desc') {
$revSorts = array();
$keys = array_reverse(array_keys($sorts[$sort]));
$keysCount = count($keys);
for ($i = 0; $i < $keysCount; $i++) {
$v = $keys[$i];
$revSorts[$v] = $sorts[$sort][$v];
}
$sorts[$sort] = $revSorts;
}
$timedate = TimeDate::getInstance();
foreach ($sorts[$sort] as $k2 => $overview2) {
$arr[$k2]->date = $timedate->fromString($arr[$k2]->date)->asDb();
$retArr[] = $arr[$k2];
}
$finalReturn = array();
$finalReturn['retArr'] = $retArr;
$finalReturn['sortBy'] = $sort;
$finalReturn['direction'] = $direction;
return $finalReturn;
}
public function setReadFlagOnFolderCache($mbox, $uid)
{
global $sugar_config;
$this->mailbox = $mbox;
// cache
if ($this->validCacheExists($this->mailbox)) {
$ret = $this->getCacheValue($this->mailbox);
$updates = array();
foreach ($ret as $k => $v) {
if ($v->imap_uid == $uid) {
$v->seen = 1;
$updates[] = $v;
break;
}
}
$this->setCacheValue($this->mailbox, array(), $updates);
}
}
/**
* Returns a list of emails in a mailbox.
* @param string mbox Name of mailbox using dot notation paths to display
* @param string $forceRefresh Flag to use cache or not
* @param integer page number
*/
public function displayFolderContents($mbox, $forceRefresh = 'false', $page = 1)
{
global $current_user;
$delimiter = $this->get_stored_options('folderDelimiter');
if ($delimiter) {
$mbox = str_replace('.', $delimiter, (string) $mbox);
}
$this->mailbox = $mbox;
// jchi #9424, get sort and direction from user preference
$sort = 'date';
$direction = 'desc';
$sortSerial = $current_user->getPreference('folderSortOrder', 'Emails');
if (!empty($sortSerial) && !empty($_REQUEST['ieId']) && !empty($_REQUEST['mbox'])) {
$sortArray = sugar_unserialize($sortSerial);
$sort = $sortArray[$_REQUEST['ieId']][$_REQUEST['mbox']]['current']['sort'];
$direction = $sortArray[$_REQUEST['ieId']][$_REQUEST['mbox']]['current']['direction'];
}
//end
// save sort order
if (!empty($_REQUEST['sort']) && !empty($_REQUEST['dir'])) {
$this->email->et->saveListViewSortOrder(
$_REQUEST['ieId'],
$_REQUEST['mbox'],
$_REQUEST['sort'],
$_REQUEST['dir']
);
$sort = $_REQUEST['sort'];
$direction = $_REQUEST['dir'];
} else {
$_REQUEST['sort'] = '';
$_REQUEST['dir'] = '';
}
// cache
$ret = array();
$cacheUsed = false;
if ($forceRefresh == 'false' && $this->validCacheExists($this->mailbox)) {
$emailSettings = $current_user->getPreference('emailSettings', 'Emails');
// cn: default to a low number until user specifies otherwise
if (empty($emailSettings['showNumInList'])) {
$emailSettings['showNumInList'] = 20;
}
$ret = $this->getCacheValue($this->mailbox, $emailSettings['showNumInList'], $page, $sort, $direction);
$cacheUsed = true;
}
$out = $this->displayFetchedSortedListXML($ret, $mbox);
$metadata = array();
$metadata['mbox'] = $mbox;
$metadata['ieId'] = $this->id;
$metadata['name'] = $this->name;
$metadata['fromCache'] = $cacheUsed ? 1 : 0;
$metadata['out'] = $out;
return $metadata;
}
/**
* For a group email account, create subscriptions for all users associated with the
* team assigned to the account.
*
*/
public function createUserSubscriptionsForGroupAccount()
{
$team = new Team();
$team->retrieve($this->team_id);
$usersList = $team->get_team_members(true);
foreach ($usersList as $userObject) {
$previousSubscriptions = sugar_unserialize(
base64_decode(
$userObject->getPreference(
'showFolders',
'Emails',
$userObject
)
)
);
if ($previousSubscriptions === false) {
$previousSubscriptions = array();
}
$previousSubscriptions[] = $this->id;
$encodedSubs = base64_encode(serialize($previousSubscriptions));
$userObject->setPreference('showFolders', $encodedSubs, '', 'Emails');
$userObject->savePreferencesToDB();
}
}
/**
* Create a sugar folder for this inbound email account
* if the Enable Auto Import option is selected
*
* @return String Id of the sugar folder created.
*/
public function createAutoImportSugarFolder()
{
global $current_user;
$guid = create_guid();
$GLOBALS['log']->debug("Creating Sugar Folder for IE with id $guid");
$folder = new SugarFolder();
$folder->id = $guid;
$folder->new_with_id = true;
$folder->name = $this->name;
$folder->has_child = 0;
$folder->is_group = 1;
$folder->assign_to_id = $current_user->id;
$folder->parent_folder = "";
//If this inbound email is marked as inactive, don't add subscriptions.
$addSubscriptions = ($this->status == 'Inactive' || $this->mailbox_type == 'bounce') ? false : true;
$folder->save($addSubscriptions);
return $guid;
}
public function validCacheExists($mbox)
{
$q = "SELECT count(*) c FROM email_cache WHERE ie_id = '{$this->id}'";
$r = $this->db->query($q);
$a = $this->db->fetchByAssoc($r);
$count = $a['c'];
if ($count > 0) {
return true;
}
return false;
}
public function displayFetchedSortedListXML($ret, $mbox)
{
global $timedate;
global $current_user;
global $sugar_config;
if (empty($ret['retArr'])) {
return array();
}
$tPref = $current_user->getUserDateTimePreferences();
$return = array();
foreach ($ret['retArr'] as $msg) {
$flagged = ($msg->flagged == 0) ? "" : $this->iconFlagged;
$status = ($msg->deleted) ? $this->iconDeleted : "";
$status = ($msg->draft == 0) ? $status : $this->iconDraft;
$status = ($msg->answered == 0) ? $status : $this->iconAnswered;
$from = $this->handleMimeHeaderDecode($msg->from);
$subject = $this->handleMimeHeaderDecode($msg->subject);
//$date = date($tPref['date']." ".$tPref['time'], $msg->date);
$date = $timedate->to_display_date_time($this->db->fromConvert($msg->date, 'datetime'));
//$date = date($tPref['date'], $this->getUnixHeaderDate($msg->date));
$temp = array();
$temp['flagged'] = $flagged;
$temp['status'] = $status;
$temp['from'] = to_html($from);
$temp['subject'] = $subject;
$temp['date'] = $date;
$temp['uid'] = $msg->uid; // either from an imap_search() or massaged cache value
$temp['mbox'] = $this->mailbox;
$temp['ieId'] = $this->id;
$temp['site_url'] = $sugar_config['site_url'];
$temp['seen'] = $msg->seen;
$temp['type'] = (isset($msg->type)) ? $msg->type : 'remote';
$temp['to_addrs'] = to_html($msg->to);
$temp['hasAttach'] = '0';
$return[] = $temp;
}
return $return;
}
/**
* retrieves the mailboxes for a given account in the following format
* Array(
* [INBOX] => Array
* (
* [Bugs] => Bugs
* [Builder] => Builder
* [DEBUG] => Array
* (
* [out] => out
* [test] => test
* )
* )
* @param bool $justRaw Default false
* @return array
*/
public function getMailboxes($justRaw = false)
{
if ($justRaw == true) {
return $this->mailboxarray;
} // if
return $this->generateMultiDimArrayFromFlatArray($this->mailboxarray, $this->retrieveDelimiter());
}
public function getMailBoxesForGroupAccount()
{
$mailboxes = $this->generateMultiDimArrayFromFlatArray(
explode(",", $this->mailbox),
$this->retrieveDelimiter()
);
$mailboxesArray = $this->generateFlatArrayFromMultiDimArray($mailboxes, $this->retrieveDelimiter());
$mailboxesArray = $this->filterMailBoxFromRaw(explode(",", $this->mailbox), $mailboxesArray);
$this->saveMailBoxFolders($mailboxesArray);
return $mailboxes;
} // fn
public function saveMailBoxFolders($value)
{
if (is_array($value)) {
$value = implode(",", $value);
}
$this->mailboxarray = explode(",", $value);
$value = $this->db->quoted($value);
$query = "update inbound_email set mailbox = $value where id ='{$this->id}'";
$this->db->query($query);
}
public function insertMailBoxFolders($value)
{
$query = "select value from config where category='InboundEmail' and name='{$this->id}'";
$r = $this->db->query($query);
$a = $this->db->fetchByAssoc($r);
if (empty($a['value'])) {
if (is_array($value)) {
$value = implode(",", $value);
}
$this->mailboxarray = explode(",", $value);
$value = $this->db->quoted($value);
$query = "INSERT INTO config VALUES('InboundEmail', '{$this->id}', $value)";
$this->db->query($query);
} // if
}
public function saveMailBoxValueOfInboundEmail()
{
$emailUserQuoted = $this->db->quote($this->email_user);
$query = "update Inbound_email set mailbox = '$emailUserQuoted'";
$this->db->query($query);
}
public function retrieveMailBoxFolders()
{
$this->mailboxarray = explode(",", $this->mailbox);
} // fn
public function retrieveDelimiter()
{
$delimiter = $this->get_stored_options('folderDelimiter');
if (!$delimiter) {
$delimiter = '.';
}
return $delimiter;
} // fn
public function generateFlatArrayFromMultiDimArray($arraymbox, $delimiter)
{
$ret = array();
foreach ($arraymbox as $key => $value) {
$this->generateArrayData($key, $value, $ret, $delimiter);
} // foreach
return $ret;
} // fn
public function generateMultiDimArrayFromFlatArray($raw, $delimiter)
{
// generate a multi-dimensional array to iterate through
$ret = array();
foreach ($raw as $mbox) {
$ret = $this->sortMailboxes($mbox, $ret, $delimiter);
}
return $ret;
} // fn
public function generateArrayData($key, $arraymbox, &$ret, $delimiter)
{
$ret [] = $key;
if (is_array($arraymbox)) {
foreach ($arraymbox as $mboxKey => $value) {
$newKey = $key . $delimiter . $mboxKey;
$this->generateArrayData($newKey, $value, $ret, $delimiter);
} // foreach
} // if
}
/**
* sorts the folders in a mailbox in a multi-dimensional array
* @param string $MBOX
* @param array $ret
* @return array
*/
public function sortMailboxes($mbox, $ret, $delimeter = ".")
{
if (strpos((string) $mbox, (string) $delimeter)) {
$node = substr((string) $mbox, 0, strpos((string) $mbox, (string) $delimeter));
$nodeAfter = substr((string) $mbox, strpos((string) $mbox, (string) $node) + strlen($node) + 1, strlen((string) $mbox));
if (!isset($ret[$node])) {
$ret[$node] = array();
} elseif (isset($ret[$node]) && !is_array($ret[$node])) {
$ret[$node] = array();
}
$ret[$node] = $this->sortMailboxes($nodeAfter, $ret[$node], $delimeter);
} else {
$ret[$mbox] = $mbox;
}
return $ret;
}
/**
* parses Sugar's storage method for imap server service strings
* @return string
*/
public function getServiceString()
{
$service = '';
$exServ = explode('::', $this->service);
foreach ($exServ as $v) {
if (!empty($v) && ($v != 'imap' && $v != 'pop3')) {
$service .= '/' . $v;
}
}
return $service;
}
/**
* Get Email messages IDs from server which aren't in database
* @return array Ids of messages, which aren't still in database
*/
public function getNewEmailsForSyncedMailbox()
{
// ids's count limit for batch processing
$limit = 20;
if (!$this->getImap()->isValidStream($this->conn)) {
LoggerManager::getLogger()->fatal('Inbound Email connection is not a resource for getting New Emails For Synced Mailbox');
return false;
}
$msgIds = $this->getImap()->search('ALL UNDELETED');
$result = array();
try {
if ((is_countable($msgIds) ? count($msgIds) : 0) > 0) {
/*
* @var collect results of queries and message headers
*/
$tmpMsgs = array();
$repeats = 0;
$counter = 0;
// sort IDs to get lastest on top
arsort($msgIds);
$GLOBALS['log']->debug('-----> getNewEmailsForSyncedMailbox() got ' . (is_countable($msgIds) ? count($msgIds) : 0) . ' Messages');
foreach ($msgIds as $k => &$msgNo) {
$uid = $this->getImap()->getUid($msgNo);
$header = $this->getImap()->headerInfo($msgNo);
$fullHeader = $this->getImap()->fetchHeader($msgNo);
$message_id = isset($header->message_id) ? $header->message_id : '';
$deliveredTo = $this->id;
$matches = array();
preg_match('/(delivered-to:|x-real-to:){1}\s*(\S+)\s*\n{1}/im', (string) $fullHeader, $matches);
if (count($matches)) {
$deliveredTo = $matches[2];
}
if (empty($message_id) || !isset($message_id)) {
$GLOBALS['log']->debug('*********** NO MESSAGE_ID.');
$message_id = $this->getMessageId($header);
}
// generate compound messageId
$this->compoundMessageId = trim($message_id) . trim($deliveredTo);
// if the length > 255 then md5 it so that the data will be of smaller length
if (strlen($this->compoundMessageId) > 255) {
$this->compoundMessageId = md5($this->compoundMessageId);
} // if
if (empty($this->compoundMessageId)) {
break;
} // if
$counter++;
$potentials = clean_xss($this->compoundMessageId, false);
if (is_array($potentials) && !empty($potentials)) {
foreach ($potentials as $bad) {
$this->compoundMessageId = str_replace($bad, "", $this->compoundMessageId);
}
}
array_push($tmpMsgs, array('msgNo' => $msgNo, 'msgId' => $this->compoundMessageId, 'exists' => 0));
if ($counter == $limit) {
$counter = 0;
$query = array();
foreach (array_slice($tmpMsgs, -$limit, $limit) as $k1 => $v1) {
$query[] = $v1['msgId'];
}
$query = 'SELECT count(emails.message_id) as cnt, emails.message_id AS mid FROM emails WHERE emails.message_id IN ("' . implode(
'","',
$query
) . '") and emails.deleted = 0 group by emails.message_id';
$r = $this->db->query($query);
$tmp = array();
while ($a = $this->db->fetchByAssoc($r)) {
$tmp[html_entity_decode((string) $a['mid'])] = $a['cnt'];
}
foreach ($tmpMsgs as $k1 => $v1) {
if (isset($tmp[$v1['msgId']]) && $tmp[$v1['msgId']] > 0) {
$tmpMsgs[$k1]['exists'] = 1;
}
}
foreach ($tmpMsgs as $k1 => $v1) {
if ($v1['exists'] == 0) {
$repeats = 0;
array_push($result, $v1['msgNo']);
} else {
$repeats++;
}
}
if ($repeats > 0) {
if ($repeats >= $limit) {
break;
}
$tmpMsgs = array_splice($tmpMsgs, -$repeats, $repeats);
} else {
$tmpMsgs = array();
}
}
}
unset($msgNo);
}
} catch (Exception $ex) {
$GLOBALS['log']->fatal($ex->getMessage());
}
$GLOBALS['log']->debug('-----> getNewEmailsForSyncedMailbox() got ' . count($result) . ' unsynced messages');
return $result;
}
/**
* Import new messages from given account.
*/
public function importMessages()
{
$protocol = $this->isPop3Protocol() ? 'pop3' : 'imap';
switch ($protocol) {
case 'pop3':
$this->importMailboxMessages($protocol);
break;
case 'imap':
$mailboxes = $this->getMailboxes(true);
foreach ($mailboxes as $mailbox) {
$this->importMailboxMessages($protocol, $mailbox);
}
$this->getImap()->expunge();
$this->getImap()->close();
break;
}
}
/**
* Import messages from specified mailbox
*
* @param string $protocol Mailing protocol
* @param string|null $mailbox Mailbox (if applied to protocol)
*/
protected function importMailboxMessages($protocol, $mailbox = null)
{
switch ($protocol) {
case 'pop3':
$msgNumbers = $this->getPop3NewMessagesToDownload();
break;
case 'imap':
$this->mailbox = $mailbox;
$this->connectMailserver();
$msgNumbers = $this->getNewMessageIds();
if (!$msgNumbers) {
$msgNumbers = array();
}
break;
default:
$msgNumbers = array();
break;
}
foreach ($msgNumbers as $msgNumber) {
$uid = $this->getMessageUID($msgNumber, $protocol);
$GLOBALS['log']->info('Importing message no: ' . $msgNumber);
$this->returnImportedEmail($msgNumber, $uid, false, false);
}
}
/**
* Retrieves message UID by it's number
*
* @param int $msgNumber Number of the message in current sequence
* @param string $protocol Mailing protocol
* @return string
*/
protected function getMessageUID($msgNumber, $protocol)
{
switch ($protocol) {
case 'pop3':
$uid = $this->getUIDLForMessage($msgNumber);
break;
case 'imap':
$uid = $this->getImap()->getUid($msgNumber);
break;
default:
$uid = null;
break;
}
return $uid;
}
public function bean_implements($interface)
{
if ($interface === 'ACL') {
return true;
}
return false;
}
/**
* Check if its admin only action
* @param string $view
* @return bool
*/
protected function isAdminOnlyAction(string $view): bool
{
$adminOnlyAction = ['edit', 'delete', 'editview', 'save'];
return in_array(strtolower($view), $adminOnlyAction);
}
/**
* Check if its a security based action
* @param string $view
* @return bool
*/
protected function isSecurityGroupBasedAction(string $view): bool
{
$securityBasedActions = ['detail', 'detailview', 'view'];
return in_array(strtolower($view), $securityBasedActions);
}
/**
* Get not allowed action
* @param string $view
* @return bool
*/
protected function isNotAllowedAction(string $view): bool
{
$notAllowed = ['export', 'import', 'massupdate', 'duplicate'];
return in_array(strtolower($view), $notAllowed);
}
/**
* @param array $order
* @return array
*/
protected function getSortCriteria(array $order): array
{
// handle sorting
// Default: to sort the date in descending order
$sortCriteria = SORTARRIVAL;
$sortCRM = 'udate';
$sortOrder = 1;
return [$sortCriteria, $sortCRM, $sortOrder];
}
/**
* @param array $filter
* @return string|null
*/
protected function getFilterCriteria(array $filter): ?string
{
// handle filtering
$filterCriteria = null;
$emailFilteringOption = 'multi';
if ($this->email_body_filtering) {
$emailFilteringOption = $this->email_body_filtering;
}
if (!empty($filter)) {
foreach ($filter as $filterField => $filterFieldValue) {
if (empty($filterFieldValue)) {
continue;
}
// Convert to a blank string as NULL will break the IMAP request
if ($filterCriteria == null) {
$filterCriteria = '';
}
if ($filterField === 'BODY' && $emailFilteringOption !== 'multi') {
$word = strtok($filterFieldValue, ' ') ?? '';
if (!empty($word)){
$filterCriteria .= ' ' . $filterField . ' "' . $word . '" ';
}
} else {
$filterCriteria .= ' ' . $filterField . ' "' . $filterFieldValue . '" ';
}
}
}
return $filterCriteria;
}
/**
* @param array $returnService
* @param array $serviceArr
* @param $tmpMailbox
* @return void
*/
protected function overrideConnectionConfigs(array &$returnService, array &$serviceArr, $tmpMailbox): void
{
$connectionString = str_replace('//', '', $this->connection_string ?? '');
$parts = explode('/', $connectionString) ?? [];
array_shift($parts);
$servicesString = implode('/', $parts);
$serviceKey = implode('-', $parts);
$returnService[$serviceKey] = 'foo' . $servicesString;
$serviceArr[$serviceKey] = '{' . $this->connection_string . '}' . $tmpMailbox;
}
/**
* @param $emailHeaders
* @param $sortCRM
* @param $sortOrder
* @return mixed
*/
protected function sortMessageList($emailHeaders, $sortCRM, $sortOrder)
{
// TODO: parameter 1 could be a bool but it should be an array!
usort(
$emailHeaders,
function ($a, $b) use ($sortCRM) { // defaults to DESC order
if ($a[$sortCRM] === $b[$sortCRM]) {
return 0;
} elseif ($a[$sortCRM] < $b[$sortCRM]) {
return 1;
}
return -1;
}
);
// Make it ASC order
if (!$sortOrder) {
array_reverse($emailHeaders);
};
return $emailHeaders;
}
/**
* @param $password
* @param int $imapConnectionOptions
* @return array
*/
protected function getOAuthCredentials($password, int $imapConnectionOptions): array
{
if ($this->isOAuth()) {
/** @var ExternalOAuthConnection $oAuthConnection */
$oAuthConnection = BeanFactory::getBean('ExternalOAuthConnection', $this->external_oauth_connection_id);
$password = $oAuthConnection->access_token;
$imapConnectionOptions = OP_XOAUTH2;
}
return [$password, $imapConnectionOptions];
}
/**
* Get Imap handler type
* @return string
*/
protected function getImapHandlerType(): string
{
return 'imap2';
}
/**
* Get refersh token error messages
* @param $reLogin
* @param ExternalOAuthConnection $oauthConnection
* @param string $oAuthConnectionId
* @return string
*/
protected function getOAuthRefreshTokenErrorMessage(
$reLogin,
ExternalOAuthConnection $oauthConnection,
string $oAuthConnectionId
): string {
$message = translate('ERR_IMAP_OAUTH_CONNECTION_ERROR', 'InboundEmail');
$linkAction = 'DetailView';
if ($reLogin === true) {
$linkAction = 'EditView';
$message = translate('WARN_OAUTH_TOKEN_SESSION_EXPIRED', 'InboundEmail');
}
$oauthConnectionName = $oauthConnection->name;
$hasAccess = $oauthConnection->ACLAccess('edit') ?? false;
if ($hasAccess === true) {
$message .= " <a href=\"index.php?module=ExternalOAuthConnection&action=$linkAction&record=$oAuthConnectionId\">$oauthConnectionName</a>.";
} else {
$message .= $oauthConnectionName . '.';
}
return $message;
}
/**
* Get OAuthToken. Refresh if needed
* @param string $oAuthConnectionId
* @return string|null
*/
protected function getOAuthToken(string $oAuthConnectionId): ?string
{
require_once __DIR__ . '/../ExternalOAuthConnection/services/OAuthAuthorizationService.php';
$oAuth = new OAuthAuthorizationService();
/** @var ExternalOAuthConnection $oauthConnection */
$oauthConnection = BeanFactory::getBean('ExternalOAuthConnection', $oAuthConnectionId);
$password = $oauthConnection->access_token;
$hasExpiredFeedback = $oAuth->hasConnectionTokenExpired($oauthConnection);
$refreshToken = $hasExpiredFeedback['refreshToken'] ?? false;
if ($refreshToken === true) {
$refreshTokenFeedback = $oAuth->refreshConnectionToken($oauthConnection);
if ($refreshTokenFeedback['success'] === false) {
$message = $this->getOAuthRefreshTokenErrorMessage(
$refreshTokenFeedback['reLogin'],
$oauthConnection,
$oAuthConnectionId
);
displayAdminError($message);
return null;
}
return $oauthConnection->access_token;
}
return $password;
}
/**
* Check if is using oauth authentication
* @return bool
*/
protected function isOAuth(): bool
{
$authType = $this->auth_type ?? '';
$oAuthConnectionId = $this->external_oauth_connection_id ?? '';
return $authType === 'oauth' && $oAuthConnectionId !== '';
}
} // end class definition
Reference in New Issue View Git Blame Copy Permalink