Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-08-12-10-27-52

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

diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php
index ad27b66d1c707604697d2cbdf573c382c6fb7da8..c273cd8fdbd77184d5a1173406bbd5578bc89d6d 100644 (file)
--- a/CRM/Mailing/MailStore/Maildir.php
+++ b/CRM/Mailing/MailStore/Maildir.php
@@ -35,14 +35,18 @@
 
 require_once 'ezc/Base/src/ezc_bootstrap.php';
 require_once 'ezc/autoload/mail_autoload.php';
+
+/**
+ * Class CRM_Mailing_MailStore_Maildir
+ */
 class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore {
 
   /**
    * Connect to the supplied dir and make sure the two mail dirs exist
    *
-   * @param string $dir  dir to operate upon
+   * @param string $dir dir to operate upon
    *
-   * @return void
+   * @return \CRM_Mailing_MailStore_Maildir
    */
   function __construct($dir) {
     $this->_dir = $dir;
@@ -91,8 +95,9 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore {
   /**
    * Fetch the specified message to the local ignore folder
    *
-   * @param integer $file  file location of the message to fetch
+   * @param integer $file file location of the message to fetch
    *
+   * @throws Exception
    * @return void
    */
   function markIgnored($file) {
@@ -108,8 +113,9 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore {
   /**
    * Fetch the specified message to the local processed folder
    *
-   * @param integer $file  file location of the message to fetch
+   * @param integer $file file location of the message to fetch
    *
+   * @throws Exception
    * @return void
    */
   function markProcessed($file) {