├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
├── config
    └── imap.php
└── src
    ├── Commands
        ├── ConfigureIdleQuery.php
        ├── HandleMessageReceived.php
        └── WatchMailbox.php
    ├── Events
        ├── MailboxWatchAttemptsExceeded.php
        └── MessageReceived.php
    ├── Facades
        └── Imap.php
    ├── ImapManager.php
    ├── ImapServiceProvider.php
    └── Support
        ├── Loop.php
        ├── LoopFake.php
        └── LoopInterface.php


/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | 
3 | All notable changes to `ImapEngine-Laravel` will be documented in this file.
4 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) Steve Bauman <steven_bauman@outlook.com>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 | <img src="https://github.com/directorytree/imapengine/blob/master/art/logo.svg" width="300">
 3 | </p>
 4 | 
 5 | <p align="center">Working with IMAP doesn't need to be hard.</p>
 6 | 
 7 | <p align="center">ImapEngine provides a simple API for managing mailboxes -- without the PHP extension.</p>
 8 | 
 9 | <p align="center">
10 | <a href="https://github.com/directorytree/imapengine-laravel/actions"><img src="https://img.shields.io/github/actions/workflow/status/directorytree/imapengine-laravel/run-tests.yml?branch=master&style=flat-square"></a>
11 | <a href="https://packagist.org/packages/directorytree/imapengine-laravel"><img src="https://img.shields.io/packagist/dt/directorytree/imapengine-laravel.svg?style=flat-square"></a>
12 | <a href="https://packagist.org/packages/directorytree/imapengine-laravel"><img src="https://img.shields.io/packagist/v/directorytree/imapengine-laravel.svg?style=flat-square"></a>
13 | <a href="https://packagist.org/packages/directorytree/imapengine-laravel"><img src="https://img.shields.io/github/license/directorytree/imapengine-laravel?style=flat-square"/></a>
14 | </p>
15 | 
16 | <p align="center">
17 |   <a href="https://imapengine.com/docs/laravel/introduction">View Documentation</a>
18 | </p>
19 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "directorytree/imapengine-laravel",
 3 |     "description": "This is my package imapengine-laravel",
 4 |     "keywords": [
 5 |         "Steve Bauman",
 6 |         "laravel",
 7 |         "imap"
 8 |     ],
 9 |     "homepage": "https://github.com/directorytree/imapengine-laravel",
10 |     "license": "MIT",
11 |     "authors": [
12 |         {
13 |             "name": "Steve Bauman",
14 |             "email": "steven_bauman@outlook.com",
15 |             "role": "Developer"
16 |         }
17 |     ],
18 |     "require": {
19 |         "php": "^8.1",
20 |         "directorytree/imapengine": "^1.13.0",
21 |         "illuminate/contracts": "^10.0|^11.0|^12.0"
22 |     },
23 |     "require-dev": {
24 |         "laravel/pint": "^1.14",
25 |         "nunomaduro/collision": "^7.10|^8.1",
26 |         "orchestra/testbench": "^8.22|^9.0|^10.0",
27 |         "pestphp/pest": "^2.0|^3.0",
28 |         "pestphp/pest-plugin-arch": "^2.0|^3.0",
29 |         "pestphp/pest-plugin-laravel": "^2.0|^3.0",
30 |         "spatie/laravel-ray": "^1.35"
31 |     },
32 |     "autoload": {
33 |         "psr-4": {
34 |             "DirectoryTree\\ImapEngine\\Laravel\\": "src/"
35 |         }
36 |     },
37 |     "autoload-dev": {
38 |         "psr-4": {
39 |             "DirectoryTree\\ImapEngine\\Laravel\\Tests\\": "tests/"
40 |         }
41 |     },
42 |     "scripts": {
43 |         "post-autoload-dump": "@composer run prepare",
44 |         "prepare": "@php vendor/bin/testbench package:discover --ansi",
45 |         "analyse": "vendor/bin/phpstan analyse",
46 |         "test": "vendor/bin/pest",
47 |         "test-coverage": "vendor/bin/pest --coverage",
48 |         "format": "vendor/bin/pint"
49 |     },
50 |     "config": {
51 |         "sort-packages": true,
52 |         "allow-plugins": {
53 |             "pestphp/pest-plugin": true,
54 |             "phpstan/extension-installer": true
55 |         }
56 |     },
57 |     "extra": {
58 |         "laravel": {
59 |             "providers": [
60 |                 "DirectoryTree\\ImapEngine\\Laravel\\ImapServiceProvider"
61 |             ]
62 |         }
63 |     },
64 |     "minimum-stability": "dev",
65 |     "prefer-stable": true
66 | }
67 | 


--------------------------------------------------------------------------------
/config/imap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Mailboxes
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | Here you may define all of the IMAP mailboxes your application connects to.
11 |     | Each mailbox contains its connection settings such as host, port, and
12 |     | credentials. You are free to add as many mailboxes as needed.
13 |     |
14 |     */
15 | 
16 |     'mailboxes' => [
17 |         'default' => [
18 |             'port' => env('IMAP_PORT', 993),
19 |             'host' => env('IMAP_HOST'),
20 |             'timeout' => env('IMAP_TIMEOUT', 30),
21 |             'debug' => env('IMAP_DEBUG', false),
22 |             'username' => env('IMAP_USERNAME'),
23 |             'password' => env('IMAP_PASSWORD'),
24 |             'encryption' => env('IMAP_ENCRYPTION', 'ssl'),
25 |             'validate_cert' => env('IMAP_VALIDATE_CERT', true),
26 |             'authentication' => env('IMAP_AUTHENTICATION', 'plain'),
27 |             'proxy' => [
28 |                 'socket' => env('IMAP_PROXY_SOCKET'),
29 |                 'username' => env('IMAP_PROXY_USERNAME'),
30 |                 'password' => env('IMAP_PROXY_PASSWORD'),
31 |                 'request_fulluri' => env('IMAP_PROXY_REQUEST_FULLURI', false),
32 |             ],
33 |         ],
34 |     ],
35 | ];
36 | 


--------------------------------------------------------------------------------
/src/Commands/ConfigureIdleQuery.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Commands;
 4 | 
 5 | use DirectoryTree\ImapEngine\MessageQueryInterface;
 6 | 
 7 | class ConfigureIdleQuery
 8 | {
 9 |     /**
10 |      * Constructor.
11 |      */
12 |     public function __construct(
13 |         protected array $with = []
14 |     ) {}
15 | 
16 |     /**
17 |      * Configure the query.
18 |      */
19 |     public function __invoke(MessageQueryInterface $query): MessageQueryInterface
20 |     {
21 |         if (in_array('flags', $this->with)) {
22 |             $query->withFlags();
23 |         }
24 | 
25 |         if (in_array('body', $this->with)) {
26 |             $query->withBody();
27 |         }
28 | 
29 |         if (in_array('headers', $this->with)) {
30 |             $query->withHeaders();
31 |         }
32 | 
33 |         return $query;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Commands/HandleMessageReceived.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Commands;
 4 | 
 5 | use DirectoryTree\ImapEngine\Laravel\Events\MessageReceived;
 6 | use DirectoryTree\ImapEngine\MessageInterface;
 7 | use Illuminate\Support\Carbon;
 8 | use Illuminate\Support\Facades\Date;
 9 | use Illuminate\Support\Facades\Event;
10 | 
11 | class HandleMessageReceived
12 | {
13 |     /**
14 |      * Constructor.
15 |      */
16 |     public function __construct(
17 |         protected WatchMailbox $command,
18 |         protected int &$attempts = 0,
19 |         protected ?Carbon &$lastReceivedAt = null,
20 |     ) {}
21 | 
22 |     /**
23 |      * Handle the message received event.
24 |      */
25 |     public function __invoke(MessageInterface $message): void
26 |     {
27 |         $this->command->info(
28 |             "Message received: [{$message->uid()}]"
29 |         );
30 | 
31 |         $this->attempts = 0;
32 | 
33 |         $this->lastReceivedAt = Date::now();
34 | 
35 |         Event::dispatch(new MessageReceived($message));
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Commands/WatchMailbox.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace DirectoryTree\ImapEngine\Laravel\Commands;
  4 | 
  5 | use DirectoryTree\ImapEngine\FolderInterface;
  6 | use DirectoryTree\ImapEngine\Laravel\Events\MailboxWatchAttemptsExceeded;
  7 | use DirectoryTree\ImapEngine\Laravel\Facades\Imap;
  8 | use DirectoryTree\ImapEngine\Laravel\Support\LoopInterface;
  9 | use DirectoryTree\ImapEngine\MailboxInterface;
 10 | use DirectoryTree\ImapEngine\Message;
 11 | use Exception;
 12 | use Illuminate\Console\Command;
 13 | use Illuminate\Support\Facades\Event;
 14 | use Illuminate\Support\Str;
 15 | 
 16 | class WatchMailbox extends Command
 17 | {
 18 |     /**
 19 |      * The name and signature of the console command.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     protected $signature = 'imap:watch {mailbox} {folder?} {--with=} {--timeout=30} {--attempts=5} {--debug=false}';
 24 | 
 25 |     /**
 26 |      * The console command description.
 27 |      *
 28 |      * @var string
 29 |      */
 30 |     protected $description = 'Watch a mailbox for new messages.';
 31 | 
 32 |     /**
 33 |      * Execute the console command.
 34 |      */
 35 |     public function handle(LoopInterface $loop): void
 36 |     {
 37 |         $mailbox = Imap::mailbox($name = $this->argument('mailbox'));
 38 | 
 39 |         $with = explode(',', $this->option('with'));
 40 | 
 41 |         $this->info("Watching mailbox [$name]...");
 42 | 
 43 |         $attempts = 0;
 44 | 
 45 |         $lastReceivedAt = null;
 46 | 
 47 |         $loop->run(function () use ($mailbox, $name, $with, &$attempts, &$lastReceivedAt) {
 48 |             try {
 49 |                 $folder = $this->folder($mailbox);
 50 | 
 51 |                 $folder->idle(
 52 |                     new HandleMessageReceived($this, $attempts, $lastReceivedAt),
 53 |                     new ConfigureIdleQuery($with),
 54 |                     $this->option('timeout')
 55 |                 );
 56 |             } catch (Exception $e) {
 57 |                 if ($this->isMessageMissing($e)) {
 58 |                     return;
 59 |                 }
 60 | 
 61 |                 if ($this->isDisconnection($e)) {
 62 |                     sleep(2);
 63 | 
 64 |                     return;
 65 |                 }
 66 | 
 67 |                 if ($attempts >= $this->option('attempts')) {
 68 |                     $this->info("Exception: {$e->getMessage()}");
 69 | 
 70 |                     Event::dispatch(
 71 |                         new MailboxWatchAttemptsExceeded($name, $attempts, $e, $lastReceivedAt)
 72 |                     );
 73 | 
 74 |                     throw $e;
 75 |                 }
 76 | 
 77 |                 $attempts++;
 78 |             }
 79 |         });
 80 |     }
 81 | 
 82 |     /**
 83 |      * Get the mailbox folder to idle.
 84 |      */
 85 |     protected function folder(MailboxInterface $mailbox): FolderInterface
 86 |     {
 87 |         return ($folder = $this->argument('folder'))
 88 |              ? $mailbox->folders()->findOrFail($folder)
 89 |              : $mailbox->inbox();
 90 |     }
 91 | 
 92 |     /**
 93 |      * Determine if the exception is due to a message missing error.
 94 |      */
 95 |     protected function isMessageMissing(Exception $e): bool
 96 |     {
 97 |         return Str::contains($e->getMessage(), [
 98 |             'no longer exist',
 99 |         ], true);
100 |     }
101 | 
102 |     /**
103 |      * Determine if the exception is caused by a disconnection.
104 |      */
105 |     protected function isDisconnection(Exception $e): bool
106 |     {
107 |         return Str::contains($e->getMessage(), [
108 |             'connection reset by peer',
109 |             'temporary system problem',
110 |             'failed to fetch content',
111 |             'connection failed',
112 |             'empty response',
113 |             'not connected',
114 |             'no response',
115 |             'broken pipe',
116 |             'unavailable',
117 |         ], true);
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------
/src/Events/MailboxWatchAttemptsExceeded.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Events;
 4 | 
 5 | use Carbon\Carbon;
 6 | use Exception;
 7 | 
 8 | class MailboxWatchAttemptsExceeded
 9 | {
10 |     /**
11 |      * Constructor.
12 |      */
13 |     public function __construct(
14 |         public string $mailbox,
15 |         public int $attempts,
16 |         public Exception $exception,
17 |         public ?Carbon $lastReceivedAt = null,
18 |     ) {}
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Events/MessageReceived.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Events;
 4 | 
 5 | use DirectoryTree\ImapEngine\MessageInterface;
 6 | 
 7 | class MessageReceived
 8 | {
 9 |     /**
10 |      * Create a new event instance.
11 |      */
12 |     public function __construct(
13 |         public MessageInterface $message
14 |     ) {}
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Facades/Imap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Facades;
 4 | 
 5 | use DirectoryTree\ImapEngine\Laravel\ImapManager;
 6 | use DirectoryTree\ImapEngine\Testing\FakeMailbox;
 7 | use Illuminate\Support\Facades\Facade;
 8 | 
 9 | /**
10 |  * @method static \DirectoryTree\ImapEngine\MailboxInterface mailbox(string $name)
11 |  * @method static \DirectoryTree\ImapEngine\MailboxInterface swap(string $name, \DirectoryTree\ImapEngine\MailboxInterface $mailbox)
12 |  */
13 | class Imap extends Facade
14 | {
15 |     /**
16 |      * Get the registered name of the component.
17 |      */
18 |     protected static function getFacadeAccessor(): string
19 |     {
20 |         return ImapManager::class;
21 |     }
22 | 
23 |     /**
24 |      * Fake the given mailbox.
25 |      */
26 |     public static function fake(
27 |         string $mailbox,
28 |         array $config = [],
29 |         array $folders = [],
30 |         array $capabilities = []
31 |     ): FakeMailbox {
32 |         /** @var \DirectoryTree\ImapEngine\Laravel\ImapManager $manager */
33 |         $manager = static::getFacadeRoot();
34 | 
35 |         $fake = new FakeMailbox($config, $folders, $capabilities);
36 | 
37 |         $manager->swap($mailbox, $fake);
38 | 
39 |         return $fake;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/ImapManager.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel;
 4 | 
 5 | use DirectoryTree\ImapEngine\Mailbox;
 6 | use DirectoryTree\ImapEngine\MailboxInterface;
 7 | use InvalidArgumentException;
 8 | 
 9 | class ImapManager
10 | {
11 |     /**
12 |      * The IMAP configuration.
13 |      */
14 |     protected array $config = [];
15 | 
16 |     /**
17 |      * The mailbox instances.
18 |      */
19 |     protected array $mailboxes = [];
20 | 
21 |     /**
22 |      * Constructor.
23 |      */
24 |     public function __construct(array $config)
25 |     {
26 |         $this->config = $config;
27 |     }
28 | 
29 |     /**
30 |      * Get a mailbox instance.
31 |      */
32 |     public function mailbox(string $name): MailboxInterface
33 |     {
34 |         if (isset($this->mailboxes[$name])) {
35 |             return $this->mailboxes[$name];
36 |         }
37 | 
38 |         if (! array_key_exists($name, $this->config['mailboxes'] ?? [])) {
39 |             throw new InvalidArgumentException(
40 |                 "Mailbox [{$name}] is not defined. Please check your IMAP configuration."
41 |             );
42 |         }
43 | 
44 |         return $this->mailboxes[$name] = $this->build($this->config['mailboxes'][$name]);
45 |     }
46 | 
47 |     /**
48 |      * Register a mailbox instance.
49 |      */
50 |     public function register(string $name, array $config): static
51 |     {
52 |         $this->mailboxes[$name] = $this->build($config);
53 | 
54 |         return $this;
55 |     }
56 | 
57 |     /**
58 |      * Build an on-demand mailbox instance.
59 |      */
60 |     public function build(array $config): MailboxInterface
61 |     {
62 |         return new Mailbox($config);
63 |     }
64 | 
65 |     /**
66 |      * Remove a mailbox from the in-memory cache.
67 |      */
68 |     public function forget(string $name): static
69 |     {
70 |         unset($this->mailboxes[$name]);
71 | 
72 |         return $this;
73 |     }
74 | 
75 |     /**
76 |      * Swap out a mailbox instance with a new one.
77 |      */
78 |     public function swap(string $name, MailboxInterface $mailbox): void
79 |     {
80 |         $this->mailboxes[$name] = $mailbox;
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/src/ImapServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel;
 4 | 
 5 | use DirectoryTree\ImapEngine\Laravel\Support\Loop;
 6 | use DirectoryTree\ImapEngine\Laravel\Support\LoopInterface;
 7 | use Illuminate\Support\ServiceProvider;
 8 | 
 9 | class ImapServiceProvider extends ServiceProvider
10 | {
11 |     /**
12 |      * Register application services.
13 |      */
14 |     public function register(): void
15 |     {
16 |         $this->app->singleton(ImapManager::class, function () {
17 |             return new ImapManager(config('imap', []));
18 |         });
19 | 
20 |         $this->app->bind(LoopInterface::class, Loop::class);
21 |     }
22 | 
23 |     /**
24 |      * Bootstrap application services.
25 |      */
26 |     public function boot(): void
27 |     {
28 |         if ($this->app->runningInConsole()) {
29 |             $this->commands([
30 |                 Commands\WatchMailbox::class,
31 |             ]);
32 |         }
33 | 
34 |         $this->publishes([
35 |             __DIR__.'/../config/imap.php' => config_path('imap.php'),
36 |         ]);
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Support/Loop.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Support;
 4 | 
 5 | class Loop implements LoopInterface
 6 | {
 7 |     /**
 8 |      * {@inheritDoc}
 9 |      */
10 |     public function run(callable $tick): void
11 |     {
12 |         while (true) {
13 |             $tick();
14 |         }
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Support/LoopFake.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Support;
 4 | 
 5 | class LoopFake implements LoopInterface
 6 | {
 7 |     /**
 8 |      * {@inheritDoc}
 9 |      */
10 |     public function run(callable $tick): void
11 |     {
12 |         $tick();
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Support/LoopInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DirectoryTree\ImapEngine\Laravel\Support;
 4 | 
 5 | interface LoopInterface
 6 | {
 7 |     /**
 8 |      * Execute the loop.
 9 |      */
10 |     public function run(callable $tick): void;
11 | }
12 | 


--------------------------------------------------------------------------------