Merge branch 'dev'

Author: ThorstenSuckow

.env.example

@@ -5,3 +5,4 @@ APP_ENV=production
 APP_URL=https://ddev-ms-email.ddev.site
 APP_EMAIL_PATH=rest-api-email
 APP_AUTH_PATH=rest-imapuser
+AUTH_PROVIDER=single-imap-user

.github/workflows/run.tests.yml

@@ -35,8 +35,11 @@ jobs:
       - name: Install dependencies
         run: composer install --no-progress
 
-      - name: Execute Unit Tests
-        run: ./vendor/bin/phpunit --do-not-cache-result
+      - name: Execute Unit Tests with AUTH_PROVIDER=single-imap-user
+        run: AUTH_PROVIDER=single-imap-user ./vendor/bin/phpunit --do-not-cache-result
+
+      - name: Execute Unit Tests with AUTH_PROVIDER=local-mail-account
+        run: AUTH_PROVIDER=local-mail-account ./vendor/bin/phpunit --do-not-cache-result
 
       - name: Check Project Coding Standards
         run: vendor/bin/phpcs

README.md

@@ -20,17 +20,15 @@ Please refer to the official [documentation](./docs) of **lumen-app-email** for
 ## Features
 
 **lumen-app-email** follows a service oriented approach. 
-Services are easily replacable with the help of upfront DI configurations and related bindings. 
+Services are easily replaceable with the help of upfront DI configurations and related bindings. 
 
 **Use lumen-app-email, if you...**
 - need a fully functional middleware for communicating with IMAP / SMTP servers
-- want to provide webmail solutions with domain-specific sign-in to IMAP accounts
-- are looking for a distribution with minimal footprint and easy setup
-- require a headless, service oriented standalone application with your infrastructure 
-
-**do not use lumen-app-email, if you...**
- - are looking for a stateful, session based webmail backend
- - need baked-in caching
+- want to provide webmail solutions with various authentication methods, such as 
+  - domain-specific sign-in to IMAP accounts, orchestrated by the server 
+  - connecting to IMAP accounts solely configured by the users 
+- are looking for an email messaging solution with minimal footprint that's easy to distribute 
+- require a headless, service oriented standalone application in your infrastructure that can also be run frontend agnostic
 
 ## API Examples
 

app/bootstrap/app.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (c) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (c) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -29,7 +29,6 @@
 
 require_once __DIR__ . '/../../vendor/autoload.php';
 
-use App\Providers\ImapAuthServiceProvider;
 use Fruitcake\Cors\CorsServiceProvider;
 use Fruitcake\Cors\HandleCors;
 use Laravel\Lumen\Bootstrap\LoadEnvironmentVariables;
@@ -55,9 +54,8 @@
 );
 
 $app->withFacades();
-
 $app->configure('app');
-$app->configure('imapserver');
+
 /*
 |--------------------------------------------------------------------------
 | Register Container Bindings
@@ -84,7 +82,7 @@
 $app->configure('cors');
 $app->middleware([HandleCors::class]);
 
-$versions = config("app.api.versions");
+$versions = config("app.api.service.email.versions");
 $authMiddleware = [];
 foreach ($versions as $version) {
     $version = ucfirst($version);
@@ -103,7 +101,11 @@
 |
 */
 
-$app->register(ImapAuthServiceProvider::class);
+$app->configure('auth');
+$provider = config("auth.defaults.provider");
+$providers =  config("auth.providers");
+$authProviderClass = $providers[$provider]["providerClass"];
+$app->register($authProviderClass);
 
 /*
 |--------------------------------------------------------------------------

app/bootstrap/bindings.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -34,7 +34,8 @@
 use Conjoon\Horde\Mail\Client\Message\Composer\HordeBodyComposer;
 use Conjoon\Horde\Mail\Client\Message\Composer\HordeHeaderComposer;
 use Conjoon\Illuminate\Auth\Imap\DefaultImapUserProvider;
-use Conjoon\Illuminate\Auth\Imap\ImapUserProvider;
+use Conjoon\Illuminate\Auth\ImapUserProvider;
+use Conjoon\Illuminate\Mail\Client\Request\Attachment\Transformer\LaravelAttachmentListJsonTransformer;
 use Conjoon\Mail\Client\Attachment\Processor\InlineDataProcessor;
 use Conjoon\Mail\Client\Data\MailAccount;
 use Conjoon\Mail\Client\Folder\Tree\DefaultMailFolderTreeBuilder;
@@ -45,7 +46,6 @@
 use Conjoon\Mail\Client\Reader\PurifiedHtmlStrategy;
 use Conjoon\Mail\Client\Reader\ReadableMessagePartContentProcessor;
 use Conjoon\Mail\Client\Request\Attachment\Transformer\AttachmentListJsonTransformer;
-use Conjoon\Illuminate\Mail\Client\Request\Attachment\Transformer\LaravelAttachmentListJsonTransformer;
 use Conjoon\Mail\Client\Request\Message\Transformer\DefaultMessageBodyDraftJsonTransformer;
 use Conjoon\Mail\Client\Request\Message\Transformer\DefaultMessageItemDraftJsonTransformer;
 use Conjoon\Mail\Client\Request\Message\Transformer\MessageBodyDraftJsonTransformer;

app/config/app.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (c) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (c) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -44,11 +44,12 @@
 */
 "api" => [
     "service" => [
-        "email" => env("APP_EMAIL_PATH", "rest-api-email"),
-        "auth"  => env("APP_AUTH_PATH", "rest-imapuser")
-    ],
-    "versions" => ["v0"],
-    "latest" => "v0"
+        "email" => [
+            "path" => env("APP_EMAIL_PATH", "rest-api-email"),
+            "versions" => ["v0"],
+            "latest" => "v0"
+        ]
+    ]
 ],
 
 /*

app/config/auth.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (c) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (c) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -27,31 +27,34 @@
 
 declare(strict_types=1);
 
+use App\Providers\LocalAccountServiceProvider;
+use App\Providers\ImapAuthServiceProvider;
+
 return [
-    "defaults" => [
+
+     "defaults" => [
         "guard" => env("AUTH_GUARD", "api"),
 
         /**
          * The default provider.
-         * Change this to a provider that suits your needs and make
-         * sure you update app.php with the proper (Auth)ServiceProvider.
          */
-        "provider" => "single-imap-user"
-    ],
+        "provider" => env("AUTH_PROVIDER", "single-imap-user")
+     ],
 
-    "guards" => [
+     "guards" => [
         "api" => [
             "driver" => "api"
         ],
-    ],
+     ],
 
-    "providers" => [
+     "providers" => [
+        "local-mail-account" => [
+            "providerClass" => LocalAccountServiceProvider::class,
+            "driver" => "LocalAccountProviderDriver"
+        ],
         "single-imap-user" => [
-            /**
-             * Must be registered in the (Auth)ServiceProvider used with this
-             * app and allows for returning a custom UserProvider.
-             */
+            "providerClass" => ImapAuthServiceProvider::class,
             "driver" => "ImapUserProviderDriver"
         ]
-    ]
+     ]
 ];

app/config/imapserver.php.example

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (c) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (c) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -49,14 +49,14 @@ declare(strict_types=1);
 |        "outbox_address"  => "smtp.gmail.com",
 |        "outbox_port"     => 465,
 |        "outbox_secure"   => "ssl",
-|        // the root mailbox. For most IMAP servers, this will
+|        // the mailbox(es) the account is subscribed to.
+|        // For most IMAP servers, this will
 |        // be "INBOX". Gmail users can use  "[Gmail]" instead.
-|        // You can also provide a separate mailbox named "conjoon".
-|        // The root folders are the only folders which will be
+|        // These mailboxes are the only folders which will be
 |        // queried and displayed in the folder hierarchy for the
 |        // Mail Account, along with its contents, including sub folders.
 |        // leave empty to return all mailboxes
-|        "root"            => ["Gmail"],
+|        "subscriptions" => ["Gmail"],
 |        // a regular expression that makes sure a user's email-address
 |        // is matched against "this" entry, e.g. a sign-in with the
 |        // username "dev@googlemail.com" would be associated with "this",
@@ -80,7 +80,7 @@ return [
         "outbox_address" => "smtp.gmail.com",
         "outbox_port"    => 465,
         "outbox_secure"  => "ssl",
-        "root"           => ["INBOX", "[Gmail]", "[Google Mail]"],
+        "subscriptions"  => ["INBOX", "[Gmail]", "[Google Mail]"],
         "match"          => ["/\@(googlemail.|gmail.)(com)$/mi"]
     ],
 
@@ -97,7 +97,7 @@ return [
         "outbox_address"  => "smtp-mail.outlook.com",
         "outbox_port"     => 587,
         "outbox_secure"   => "tls",
-        "root"            => [],
+        "subscriptions"   => [],
         "match"           => ["/\@(outlook.)(com)$/mi"]
     ],
 
@@ -114,7 +114,7 @@ return [
         "outbox_address"  => "smtp.mail.yahoo.com",
         "outbox_port"     => 587,
         "outbox_secure"   => "ssl",
-        "root"            => ["INBOX"],
+        "subscriptions"   => ["INBOX"],
         "match"           => ["/\@(freenet.)(de)$/mi"]
     ],
 
@@ -131,7 +131,7 @@ return [
         "outbox_address"  => "smtp.aol.com",
         "outbox_port"     => 465,
         "outbox_secure"   => "ssl",
-        "root"            => [],
+        "subscriptions"   => [],
         "match"           => ["/\@(aol.)(com)$/mi"]
     ],
 
@@ -148,7 +148,7 @@ return [
         "outbox_address"  => "mx.freenet.de",
         "outbox_port"     => 587,
         "outbox_secure"   => "tls",
-        "root"            => ["INBOX"],
+        "subscriptions"   => ["INBOX"],
         "match"           => ["/\@(freenet.)(de)$/mi"]
     ],
 
@@ -165,7 +165,7 @@ return [
         "outbox_address"  => "mail.gmx.net",
         "outbox_port"     => 587,
         "outbox_secure"   => "tls",
-        "root"            => [],
+        "subscriptions"   => [],
         "match"           => ["/\@(gmx.)(de|net)$/mi"]
     ],
 
@@ -182,7 +182,7 @@ return [
         "outbox_address"  => "smtp.web.de",
         "outbox_port"     => 587,
         "outbox_secure"   => "tls",
-        "root"            => [],
+        "subscriptions"   => [],
         "match"           => ["/\@(web.)(de)$/mi"]
     ]
 

app/routes/rest-api-email/web.php

@@ -37,10 +37,10 @@
 */
 
 $router = $app->router;
-$versions = config("app.api.versions");
-$latest = config("app.api.latest");
+$versions = config("app.api.service.email.versions");
+$latest = config("app.api.service.email.latest");
 
-$prefix = config("app.api.service.email");
+$prefix = config("app.api.service.email.path");
 
 foreach ($versions as $version) {
     $router->group([

app/routes/rest-imapuser/web.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * lumen-app-email
- * Copyright (C) 2020-2022 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
+ * Copyright (C) 2020-2023 Thorsten Suckow-Homberg https://github.com/conjoon/lumen-app-email
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -37,13 +37,13 @@
 */
 
 $router = $app->router;
-$versions = config("app.api.versions");
-$latest = config("app.api.latest");
+$versions = config("app.api.service.imapuser.versions");
+$latest = config("app.api.service.imapuser.latest");
 
-$prefix = config("app.api.service.auth");
+$prefix = config("app.api.service.imapuser.path");
 
 foreach ($versions as $version) {
-    $app->router->group([
+    $router->group([
         'namespace' => "App\Http\\" . ucfirst($version) . "\Controllers",
         'prefix' => "$prefix/" . $version
     ], function () use ($router, $version) {