topcu/laravelimap

Laravel wrapper for php-imap

Laravel Wrapper for Php-Imap

Installation

$ composer require php-imap/php-imap

Add following lines into config/app.php, _(*1)

    'providers' => [
        ...
    Topcu\Dumber\DumberServiceProvider::class,
    ...
    ],
    'aliases' => [ 
        ...
    'Imap' => \Topcu\LaravelImap\Facades\Imap::class,
    ...
    ],

Configuration

If you'd like to use a single connection, add imap into config/services.php and define your credentials in .env file, _(*2)

    'imap' => [
        "imap_path" => env("IMAP_SERVER_PATH"), // "{imap.gmail.com:993/imap/ssl}INBOX", 
        "login"     => env("IMAP_SERVER_LOGIN"), // "mail@example.com", 
        "password"  => env("IMAP_SERVER_PASSWORD")
    ]

Otherwise, you can call Imap::connection() anytime with config parameters as:, _(*3)

    Imap::connection([
         "imap_path" => "{imap.gmail.com:993/imap/ssl}INBOX", 
         "login"     => "mail@example.com", 
         "password"  => "somepassword",
     ]);

Usage examples

Using Facade

    $mail_ids = Imap::searchMailbox("UNSEEN");
    $mail = Imap::getMail($mail_ids[0]);

Using IoC

use Topcu\LaravelImap\Mailbox;

class Foo
{
    //...
    public function bar(Mailbox $imap)
    {
        $mail_ids = $imap->searchMailbox("UNSEEN");
        $mail = $imap->getMail($mail_ids[0]);
    }
    //...
}

Setting connection parameters dynamically

    $mail_ids = Imap::connection($imap_config)->searchMailbox("UNSEEN");
    $mail = Imap::getMail($mail_ids[0]);