First commit
This commit is contained in:
commit
c6e2478c40
13918 changed files with 2303184 additions and 0 deletions
172
sites/all/modules/civicrm/CRM/Mailing/MailStore.php
Normal file
172
sites/all/modules/civicrm/CRM/Mailing/MailStore.php
Normal file
|
@ -0,0 +1,172 @@
|
|||
<?php
|
||||
/*
|
||||
+--------------------------------------------------------------------+
|
||||
| CiviCRM version 4.7 |
|
||||
+--------------------------------------------------------------------+
|
||||
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||||
+--------------------------------------------------------------------+
|
||||
| This file is a part of CiviCRM. |
|
||||
| |
|
||||
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||||
| under the terms of the GNU Affero General Public License |
|
||||
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||||
| |
|
||||
| CiviCRM 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 and the CiviCRM Licensing Exception along |
|
||||
| with this program; if not, contact CiviCRM LLC |
|
||||
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||||
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||||
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||||
+--------------------------------------------------------------------+
|
||||
*/
|
||||
|
||||
/**
|
||||
*
|
||||
* @package CRM
|
||||
* @copyright CiviCRM LLC (c) 2004-2017
|
||||
*/
|
||||
class CRM_Mailing_MailStore {
|
||||
// flag to decide whether to print debug messages
|
||||
var $_debug = FALSE;
|
||||
|
||||
/**
|
||||
* Return the proper mail store implementation, based on config settings.
|
||||
*
|
||||
* @param string $name
|
||||
* Name of the settings set from civimail_mail_settings to use (null for default).
|
||||
*
|
||||
* @throws Exception
|
||||
* @return object
|
||||
* mail store implementation for processing CiviMail-bound emails
|
||||
*/
|
||||
public static function getStore($name = NULL) {
|
||||
$dao = new CRM_Core_DAO_MailSettings();
|
||||
$dao->domain_id = CRM_Core_Config::domainID();
|
||||
$name ? $dao->name = $name : $dao->is_default = 1;
|
||||
if (!$dao->find(TRUE)) {
|
||||
throw new Exception("Could not find entry named $name in civicrm_mail_settings");
|
||||
}
|
||||
|
||||
$protocols = CRM_Core_PseudoConstant::get('CRM_Core_DAO_MailSettings', 'protocol');
|
||||
if (empty($protocols[$dao->protocol])) {
|
||||
throw new Exception("Empty mail protocol");
|
||||
}
|
||||
|
||||
switch ($protocols[$dao->protocol]) {
|
||||
case 'IMAP':
|
||||
return new CRM_Mailing_MailStore_Imap($dao->server, $dao->username, $dao->password, (bool) $dao->is_ssl, $dao->source);
|
||||
|
||||
case 'POP3':
|
||||
return new CRM_Mailing_MailStore_Pop3($dao->server, $dao->username, $dao->password, (bool) $dao->is_ssl);
|
||||
|
||||
case 'Maildir':
|
||||
return new CRM_Mailing_MailStore_Maildir($dao->source);
|
||||
|
||||
case 'Localdir':
|
||||
return new CRM_Mailing_MailStore_Localdir($dao->source);
|
||||
|
||||
// DO NOT USE the mbox transport for anything other than testing
|
||||
// in particular, it does not clear the mbox afterwards
|
||||
|
||||
case 'mbox':
|
||||
return new CRM_Mailing_MailStore_Mbox($dao->source);
|
||||
|
||||
default:
|
||||
throw new Exception("Unknown protocol {$dao->protocol}");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return all emails in the mail store.
|
||||
*
|
||||
* @return array
|
||||
* array of ezcMail objects
|
||||
*/
|
||||
public function allMails() {
|
||||
return $this->fetchNext(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Expunge the messages marked for deletion; stub function to be redefined by IMAP store.
|
||||
*/
|
||||
public function expunge() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the next X messages from the mail store.
|
||||
*
|
||||
* @param int $count
|
||||
* Number of messages to fetch (0 to fetch all).
|
||||
*
|
||||
* @return array
|
||||
* array of ezcMail objects
|
||||
*/
|
||||
public function fetchNext($count = 1) {
|
||||
$offset = 1;
|
||||
if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) {
|
||||
$offset = $this->_transport->listUniqueIdentifiers();
|
||||
$offset = array_shift($offset);
|
||||
}
|
||||
try {
|
||||
$set = $this->_transport->fetchFromOffset($offset, $count);
|
||||
if ($this->_debug) {
|
||||
print "fetching $count messages\n";
|
||||
}
|
||||
}
|
||||
catch (ezcMailOffsetOutOfRangeException$e) {
|
||||
if ($this->_debug) {
|
||||
print "got to the end of the mailbox\n";
|
||||
}
|
||||
return array();
|
||||
}
|
||||
$mails = array();
|
||||
$parser = new ezcMailParser();
|
||||
//set property text attachment as file CRM-5408
|
||||
$parser->options->parseTextAttachmentsAsFiles = TRUE;
|
||||
|
||||
foreach ($set->getMessageNumbers() as $nr) {
|
||||
if ($this->_debug) {
|
||||
print "retrieving message $nr\n";
|
||||
}
|
||||
$single = $parser->parseMail($this->_transport->fetchByMessageNr($nr));
|
||||
$mails[$nr] = $single[0];
|
||||
}
|
||||
return $mails;
|
||||
}
|
||||
|
||||
/**
|
||||
* Point to (and create if needed) a local Maildir for storing retrieved mail
|
||||
*
|
||||
* @param string $name
|
||||
* Name of the Maildir.
|
||||
*
|
||||
* @throws Exception
|
||||
* @return string
|
||||
* path to the Maildir's cur directory
|
||||
*/
|
||||
public function maildir($name) {
|
||||
$config = CRM_Core_Config::singleton();
|
||||
$dir = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $name;
|
||||
foreach (array(
|
||||
'cur',
|
||||
'new',
|
||||
'tmp',
|
||||
) as $sub) {
|
||||
if (!file_exists($dir . DIRECTORY_SEPARATOR . $sub)) {
|
||||
if ($this->_debug) {
|
||||
print "creating $dir/$sub\n";
|
||||
}
|
||||
if (!mkdir($dir . DIRECTORY_SEPARATOR . $sub, 0700, TRUE)) {
|
||||
throw new Exception('Could not create ' . $dir . DIRECTORY_SEPARATOR . $sub);
|
||||
}
|
||||
}
|
||||
}
|
||||
return $dir . DIRECTORY_SEPARATOR . 'cur';
|
||||
}
|
||||
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue