Migrated away from PHP Mail Parser to the new WebKlex PHP IMAP Mail Parser this will open the way to support OAUTH2 for Mail servers such as Microsoft 365 and Google Workspaces

plugins/php-imap/src/Support/AttachmentCollection.php

@@ -0,0 +1,26 @@
+<?php
+/*
+* File:     AttachmentCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  16.03.18 03:13
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support;
+
+use Illuminate\Support\Collection;
+use Webklex\PHPIMAP\Attachment;
+
+/**
+ * Class AttachmentCollection
+ *
+ * @package Webklex\PHPIMAP\Support
+ * @implements Collection<int, Attachment>
+ */
+class AttachmentCollection extends PaginatedCollection {
+
+}

plugins/php-imap/src/Support/FlagCollection.php

@@ -0,0 +1,25 @@
+<?php
+/*
+* File:     FlagCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  21.07.18 23:10
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support;
+
+use Illuminate\Support\Collection;
+
+/**
+ * Class FlagCollection
+ *
+ * @package Webklex\PHPIMAP\Support
+ * @implements Collection<string, string>
+ */
+class FlagCollection extends PaginatedCollection {
+
+}

plugins/php-imap/src/Support/FolderCollection.php

@@ -0,0 +1,26 @@
+<?php
+/*
+* File:     FolderCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  18.03.18 02:21
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support;
+
+use Illuminate\Support\Collection;
+use Webklex\PHPIMAP\Folder;
+
+/**
+ * Class FolderCollection
+ *
+ * @package Webklex\PHPIMAP\Support
+ * @implements Collection<int, Folder>
+ */
+class FolderCollection extends PaginatedCollection {
+
+}

plugins/php-imap/src/Support/Masks/AttachmentMask.php

@@ -0,0 +1,45 @@
+<?php
+/*
+* File: AttachmentMask.php
+* Category: Mask
+* Author: M.Goldenbaum
+* Created: 14.03.19 20:49
+* Updated: -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support\Masks;
+
+use Webklex\PHPIMAP\Attachment;
+
+/**
+ * Class AttachmentMask
+ *
+ * @package Webklex\PHPIMAP\Support\Masks
+ * @mixin Attachment
+ */
+class AttachmentMask extends Mask {
+
+    /** @var Attachment $parent */
+    protected mixed $parent;
+
+    /**
+     * Get the attachment content base64 encoded
+     *
+     * @return string|null
+     */
+    public function getContentBase64Encoded(): ?string {
+        return base64_encode($this->parent->content);
+    }
+
+    /**
+     * Get a base64 image src string
+     *
+     * @return string|null
+     */
+    public function getImageSrc(): ?string {
+        return 'data:'.$this->parent->content_type.';base64,'.$this->getContentBase64Encoded();
+    }
+}

plugins/php-imap/src/Support/Masks/Mask.php

@@ -0,0 +1,137 @@
+<?php
+/*
+* File: Mask.php
+* Category: Mask
+* Author: M.Goldenbaum
+* Created: 14.03.19 20:49
+* Updated: -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support\Masks;
+
+use Illuminate\Support\Str;
+use Webklex\PHPIMAP\Exceptions\MethodNotFoundException;
+
+/**
+ * Class Mask
+ *
+ * @package Webklex\PHPIMAP\Support\Masks
+ */
+class Mask {
+
+    /**
+     * Available attributes
+     *
+     * @var array $attributes
+     */
+    protected array $attributes = [];
+
+    /**
+     * Parent instance
+     *
+     * @var mixed $parent
+     */
+    protected mixed $parent;
+
+    /**
+     * Mask constructor.
+     * @param $parent
+     */
+    public function __construct($parent) {
+        $this->parent = $parent;
+
+        if(method_exists($this->parent, 'getAttributes')){
+            $this->attributes = array_merge($this->attributes, $this->parent->getAttributes());
+        }
+
+        $this->boot();
+    }
+
+    /**
+     * Boot method made to be used by any custom mask
+     */
+    protected function boot(): void {}
+
+    /**
+     * Call dynamic attribute setter and getter methods and inherit the parent calls
+     * @param string $method
+     * @param array $arguments
+     *
+     * @return mixed
+     * @throws MethodNotFoundException
+     */
+    public function __call(string $method, array $arguments) {
+        if(strtolower(substr($method, 0, 3)) === 'get') {
+            $name = Str::snake(substr($method, 3));
+
+            if(isset($this->attributes[$name])) {
+                return $this->attributes[$name];
+            }
+
+        }elseif (strtolower(substr($method, 0, 3)) === 'set') {
+            $name = Str::snake(substr($method, 3));
+
+            if(isset($this->attributes[$name])) {
+                $this->attributes[$name] = array_pop($arguments);
+
+                return $this->attributes[$name];
+            }
+
+        }
+
+        if(method_exists($this->parent, $method) === true){
+            return call_user_func_array([$this->parent, $method], $arguments);
+        }
+
+        throw new MethodNotFoundException("Method ".self::class.'::'.$method.'() is not supported');
+    }
+
+    /**
+     * Magic setter
+     * @param $name
+     * @param $value
+     *
+     * @return mixed
+     */
+    public function __set($name, $value) {
+        $this->attributes[$name] = $value;
+
+        return $this->attributes[$name];
+    }
+
+    /**
+     * Magic getter
+     * @param $name
+     *
+     * @return mixed|null
+     */
+    public function __get($name) {
+        if(isset($this->attributes[$name])) {
+            return $this->attributes[$name];
+        }
+
+        return null;
+    }
+
+    /**
+     * Get the parent instance
+     *
+     * @return mixed
+     */
+    public function getParent(): mixed {
+        return $this->parent;
+    }
+
+    /**
+     * Get all available attributes
+     *
+     * @return array
+     */
+    public function getAttributes(): array {
+        return $this->attributes;
+    }
+
+}

plugins/php-imap/src/Support/Masks/MessageMask.php

@@ -0,0 +1,87 @@
+<?php
+/*
+* File: MessageMask.php
+* Category: Mask
+* Author: M.Goldenbaum
+* Created: 14.03.19 20:49
+* Updated: -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support\Masks;
+
+use Webklex\PHPIMAP\Attachment;
+use Webklex\PHPIMAP\Message;
+
+/**
+ * Class MessageMask
+ *
+ * @package Webklex\PHPIMAP\Support\Masks
+ * @mixin Message
+ */
+class MessageMask extends Mask {
+
+    /** @var Message $parent */
+    protected mixed $parent;
+
+    /**
+     * Get the message html body
+     *
+     * @return null
+     */
+    public function getHtmlBody(){
+        $bodies = $this->parent->getBodies();
+        if (!isset($bodies['html'])) {
+            return null;
+        }
+
+        if(is_object($bodies['html']) && property_exists($bodies['html'], 'content')) {
+            return $bodies['html']->content;
+        }
+        return $bodies['html'];
+    }
+
+    /**
+     * Get the Message html body filtered by an optional callback
+     * @param callable|null $callback
+     *
+     * @return string|null
+     */
+    public function getCustomHTMLBody(?callable $callback = null): ?string {
+        $body = $this->getHtmlBody();
+        if($body === null) return null;
+
+        if ($callback !== null) {
+            $aAttachment = $this->parent->getAttachments();
+            $aAttachment->each(function($oAttachment) use(&$body, $callback) {
+                /** @var Attachment $oAttachment */
+                if(is_callable($callback)) {
+                    $body = $callback($body, $oAttachment);
+                }elseif(is_string($callback)) {
+                    call_user_func($callback, [$body, $oAttachment]);
+                }
+            });
+        }
+
+        return $body;
+    }
+
+    /**
+     * Get the Message html body with embedded base64 images
+     * the resulting $body.
+     *
+     * @return string|null
+     */
+    public function getHTMLBodyWithEmbeddedBase64Images(): ?string {
+        return $this->getCustomHTMLBody(function($body, $oAttachment){
+            /** @var Attachment $oAttachment */
+            if ($oAttachment->id) {
+                $body = str_replace('cid:'.$oAttachment->id, 'data:'.$oAttachment->getContentType().';base64, '.base64_encode($oAttachment->getContent()), $body);
+            }
+
+            return $body;
+        });
+    }
+}

plugins/php-imap/src/Support/MessageCollection.php

@@ -0,0 +1,26 @@
+<?php
+/*
+* File:     MessageCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  16.03.18 03:13
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support;
+
+use Illuminate\Support\Collection;
+use Webklex\PHPIMAP\Message;
+
+/**
+ * Class MessageCollection
+ *
+ * @package Webklex\PHPIMAP\Support
+ * @implements Collection<int, Message>
+ */
+class MessageCollection extends PaginatedCollection {
+
+}

plugins/php-imap/src/Support/PaginatedCollection.php

@@ -0,0 +1,82 @@
+<?php
+/*
+* File:     PaginatedCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  16.03.18 03:13
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\PHPIMAP\Support;
+
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
+use Illuminate\Pagination\Paginator;
+
+/**
+ * Class PaginatedCollection
+ *
+ * @package Webklex\PHPIMAP\Support
+ */
+class PaginatedCollection extends Collection {
+
+    /**
+     * Number of total entries
+     *
+     * @var int $total
+     */
+    protected int $total = 0;
+
+    /**
+     * Paginate the current collection.
+     * @param int $per_page
+     * @param int|null $page
+     * @param string $page_name
+     * @param boolean $prepaginated
+     *
+     * @return LengthAwarePaginator
+     */
+    public function paginate(int $per_page = 15, ?int $page = null, string $page_name = 'page', bool $prepaginated = false): LengthAwarePaginator {
+        $page = $page ?: Paginator::resolveCurrentPage($page_name);
+
+        $total = $this->total ?: $this->count();
+
+        $results = !$prepaginated && $total ? $this->forPage($page, $per_page)->toArray() : $this->all();
+
+        return $this->paginator($results, $total, $per_page, $page, [
+            'path'      => Paginator::resolveCurrentPath(),
+            'pageName'  => $page_name,
+        ]);
+    }
+
+    /**
+     * Create a new length-aware paginator instance.
+     * @param array $items
+     * @param int $total
+     * @param int $per_page
+     * @param int|null $current_page
+     * @param  array    $options
+     *
+     * @return LengthAwarePaginator
+     */
+    protected function paginator(array $items, int $total, int $per_page, ?int $current_page, array $options): LengthAwarePaginator {
+        return new LengthAwarePaginator($items, $total, $per_page, $current_page, $options);
+    }
+
+    /**
+     * Get and set the total amount
+     * @param null $total
+     *
+     * @return int|null
+     */
+    public function total($total = null): ?int {
+        if($total === null) {
+            return $this->total;
+        }
+
+        return $this->total = $total;
+    }
+}