CRM/Mailing/MailStore/Pop3.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  */
  33
  34 require_once 'ezc/Base/src/ezc_bootstrap.php';
  35 require_once 'ezc/autoload/mail_autoload.php';
  36
  37 /**
  38  * Class CRM_Mailing_MailStore_Pop3
  39  */
  40 class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
  41
  42   /**
  43    * Connect to the supplied POP3 server and make sure the two mail dirs exist
  44    *
  45    * @param string $host
  46    *   Host to connect to.
  47    * @param string $username
  48    *   Authentication username.
  49    * @param string $password
  50    *   Authentication password.
  51    * @param bool $ssl
  52    *   Whether to use POP3 or POP3S.
  53    *
  54    * @return \CRM_Mailing_MailStore_Pop3
  55    */
  56   public function __construct($host, $username, $password, $ssl = TRUE) {
  57     if ($this->_debug) {
  58       print "connecting to $host and authenticating as $username\n";
  59     }
  60
  61     $options = array('ssl' => $ssl);
  62     $this->_transport = new ezcMailPop3Transport($host, NULL, $options);
  63     $this->_transport->authenticate($username, $password);
  64
  65     $this->_ignored = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  66           'CiviMail.ignored',
  67           date('Y'),
  68           date('m'),
  69           date('d'),
  70         )));
  71     $this->_processed = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  72           'CiviMail.processed',
  73           date('Y'),
  74           date('m'),
  75           date('d'),
  76         )));
  77   }
  78
  79   /**
  80    * Fetch the specified message to the local ignore folder.
  81    *
  82    * @param int $nr
  83    *   Number of the message to fetch.
  84    */
  85   public function markIgnored($nr) {
  86     if ($this->_debug) {
  87       print "fetching message $nr and putting it in the ignored mailbox\n";
  88     }
  89     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_ignored);
  90     $parser = new ezcMailParser();
  91     $parser->parseMail($set);
  92     $this->_transport->delete($nr);
  93   }
  94
  95   /**
  96    * Fetch the specified message to the local processed folder.
  97    *
  98    * @param int $nr
  99    *   Number of the message to fetch.
 100    */
 101   public function markProcessed($nr) {
 102     if ($this->_debug) {
 103       print "fetching message $nr and putting it in the processed mailbox\n";
 104     }
 105     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_processed);
 106     $parser = new ezcMailParser();
 107     $parser->parseMail($set);
 108     $this->_transport->delete($nr);
 109   }
 110
 111 }