Added option for optional attachment download (#76)

* Added option for optional attachment download
* Fixed majority that scrutinizer-ci found
* fixed typo

Author: sparavalo

src/IMAP/Folder.php

@@ -284,7 +284,8 @@ public function searchMessages(array $where, $fetch_options = null, $parse_body
             if ($availableMessages !== false) {
                 $msglist = 1;
                 foreach ($availableMessages as $msgno) {
-                    $message = new Message($msgno, $msglist, $this->getClient(), $fetch_options, $parse_body);
+                    $fetch_attachments = config('imap.options.attachments', false);
+                    $message = new Message($msgno, $msglist, $this->getClient(), $fetch_options, $parse_body, $fetch_attachments);
 
                     $messages->put($message->getMessageId(), $message);
                     $msglist++;

src/IMAP/Message.php

@@ -43,6 +43,13 @@ class Message {
      */
     public $fetch_options = null;
 
+    /**
+     * Fetch attachments options
+     *
+     * @var bool
+     */
+    public $fetch_attachment = null;
+
     /**
      * @var int $msglist
      */
@@ -128,9 +135,11 @@ class Message {
      * @param Client        $client
      * @param integer|null  $fetch_options
      * @param boolean       $parse_body
+     * @param boolean       $fetch_attachment
      */
-    public function __construct($uid, $msglist, Client $client, $fetch_options = null, $parse_body = false) {
+    public function __construct($uid, $msglist, Client $client, $fetch_options = null, $parse_body = false, $fetch_attachment = false) {
         $this->setFetchOption($fetch_options);
+        $this->setFetchAttachment($fetch_attachment);
 
         $this->attachments = AttachmentCollection::make([]);
 
@@ -371,8 +380,8 @@ public function parseBody() {
      * @param mixed $partNumber
      */
     private function fetchStructure($structure, $partNumber = null) {
-        if ($structure->type == self::TYPE_TEXT && 
-            ($structure->ifdisposition == 0 || 
+        if ($structure->type == self::TYPE_TEXT &&
+            ($structure->ifdisposition == 0 ||
                 ($structure->ifdisposition == 1 && !isset($structure->parts) && $partNumber == null)
             )
         ) {
@@ -421,7 +430,9 @@ private function fetchStructure($structure, $partNumber = null) {
                 $this->fetchStructure($subStruct, $prefix.($index + 1));
             }
         } else {
-            $this->fetchAttachment($structure, $partNumber);
+            if ($this->fetch_attachment === true) {
+                $this->fetchAttachment($structure, $partNumber);
+            }
         }
     }
 
@@ -461,6 +472,23 @@ public function setFetchOption($option) {
 
         return $this;
     }
+    /**
+     * Fail proof setter for $fetch_attachment
+     *
+     * @param $option
+     *
+     * @return $this
+     */
+    public function setFetchAttachment($option) {
+        if (is_bool($option) == true) {
+            $this->fetch_attachment = $option;
+        } elseif(is_null($option) == true) {
+            $config = config('imap.options.attachments', false);
+            $this->fetch_attachment = is_bool($config) ? $config : false;
+        }
+
+        return $this;
+    }
 
     /**
      * Decode a given string

src/config/imap.php

@@ -75,6 +75,10 @@
     |   -Fetch option:
     |       FT_UID  - Message marked as read by fetching the message
     |       FT_PEEK - Fetch the message without setting the "read" flag
+    |
+    |   -Attachment download option
+    |       Default FALSE
+    |
     |   -Open IMAP options:
     |       DISABLE_AUTHENTICATOR - Disable authentication properties.
     |                               Use 'GSSAPI' if you encounter the following
@@ -86,6 +90,7 @@
     'options' => [
         'delimiter' => '/',
         'fetch' => FT_UID,
+        'attachments' => false,
         'open' => [
             // 'DISABLE_AUTHENTICATOR' => 'GSSAPI'
         ]