Merge pull request #3341 from systopia/CRM-14740
[civicrm-core.git] / CRM / Mailing / MailStore / Pop3.php
index 4fde61193b90da1568170b327fc172346a2902ba..003588536e0c2d0fb375fa0ac5d1fa8036984664 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 
 require_once 'ezc/Base/src/ezc_bootstrap.php';
 require_once 'ezc/autoload/mail_autoload.php';
+
+/**
+ * Class CRM_Mailing_MailStore_Pop3
+ */
 class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
 
   /**
    * Connect to the supplied POP3 server and make sure the two mail dirs exist
    *
-   * @param string $host      host to connect to
-   * @param string $username  authentication username
-   * @param string $password  authentication password
-   * @param bool   $ssl       whether to use POP3 or POP3S
+   * @param string $host host to connect to
+   * @param string $username authentication username
+   * @param string $password authentication password
+   * @param bool $ssl whether to use POP3 or POP3S
    *
-   * @return void
+   * @return \CRM_Mailing_MailStore_Pop3
    */
   function __construct($host, $username, $password, $ssl = TRUE) {
     if ($this->_debug) {