Included WebKlex PHP-IMAP Library in plugins folder to allow for future use when we convert IMAP to allow OAUTH2

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

@@ -0,0 +1,44 @@
+<?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
+ */
+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/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/Support/Masks/MessageMask.php

@@ -0,0 +1,86 @@
+<?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
+ */
+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;
+        });
+    }
+}