Merge pull request #4806 from civicrm/4.5

[civicrm-core.git] / CRM / Mailing / MailStore / Imap.php

diff --git a/CRM/Mailing/MailStore/Imap.php b/CRM/Mailing/MailStore/Imap.php
index 4489e384afd85382c9f667ba83850d4fee81ec1e..6abb1fdaa3c98c8623124722d68feecc37b76e8b 100644 (file)
--- a/CRM/Mailing/MailStore/Imap.php
+++ b/CRM/Mailing/MailStore/Imap.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -35,18 +35,22 @@
 
 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') {
     // default to INBOX if an empty string