Merge pull request #4696 from colemanw/CRM-15669
[civicrm-core.git] / CRM / Mailing / MailStore / Imap.php
index 4489e384afd85382c9f667ba83850d4fee81ec1e..bfb3d047b4702354e8aa2c02e8fc779253886e08 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
 
 require_once 'ezc/Base/src/ezc_bootstrap.php';
 require_once 'ezc/autoload/mail_autoload.php';
+
+/**
+ * Class CRM_Mailing_MailStore_Imap
+ */
 class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
 
   /**
    * Connect to the supplied IMAP server and make sure the two mailboxes exist
    *
-   * @param string $host      host to connect to
-   * @param string $username  authentication username
-   * @param string $password  authentication password
-   * @param bool   $ssl       whether to use IMAP or IMAPS
-   * @param string $folder    name of the inbox folder
+   * @param string $host host to connect to
+   * @param string $username authentication username
+   * @param string $password authentication password
+   * @param bool $ssl whether to use IMAP or IMAPS
+   * @param string $folder name of the inbox folder
    *
-   * @return void
+   * @return \CRM_Mailing_MailStore_Imap
    */
-  function __construct($host, $username, $password, $ssl = TRUE, $folder = 'INBOX') {
+  public function __construct($host, $username, $password, $ssl = TRUE, $folder = 'INBOX') {
     // default to INBOX if an empty string
     if (!$folder) {
       $folder = 'INBOX';
@@ -85,7 +89,7 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
   /**
    * Expunge the messages marked for deletion, CRM-7356
    */
-  function expunge() {
+  public function expunge() {
     $this->_transport->expunge();
   }
 
@@ -96,7 +100,7 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
    *
    * @return void
    */
-  function markIgnored($nr) {
+  public function markIgnored($nr) {
     if ($this->_debug) {
       print "setting $nr as seen and moving it to the ignored mailbox\n";
     }
@@ -112,7 +116,7 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
    *
    * @return void
    */
-  function markProcessed($nr) {
+  public function markProcessed($nr) {
     if ($this->_debug) {
       print "setting $nr as seen and moving it to the processed mailbox\n";
     }
@@ -121,4 +125,3 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
     $this->_transport->delete($nr);
   }
 }
-