macromindonline/laravel-imap

Laravel IMAP client

IMAP Library for Laravel

![Software License][ico-license] ![Total Downloads][ico-downloads] , _(*1)

Install

Via Composer, _(*2)

``` bash $ composer require webklex/laravel-imap, <sub>(*3)</sub>

## Setup

Add the service provider to the providers array in config/app.php.

``` php
'providers' => [
    Webklex\IMAP\Providers\LaravelServiceProvider::class,
];

If you are planning to use a single account, you might want to add the following to your .env file., <sub>(*4)</sub>

IMAP_HOST=somehost.com
IMAP_PORT=993
IMAP_ENCRYPTION=ssl
IMAP_VALIDATE_CERT=true
IMAP_USERNAME=root@example.com
IMAP_PASSWORD=secret

The following encryption methods are supported:, <sub>(*5)</sub>

false   - Disable encryption 
ssl     - Use SSL
tls     - Use TLS

Publishing

You can publish everything at once, <sub>(*6)</sub>

``` php php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider", <sub>(*7)</sub>

Access the IMAP Client by its Facade [\Webklex\IMAP\Facades\Client::class](src/IMAP/Facades/Client.php). 
Therefor you might want to add an alias to the aliases array within the [config/imap.php](src/config/imap.php) file.

``` php
'aliases' => [
    'Client' => Webklex\IMAP\Facades\Client::class
];

Usage

This library is designed to handle the native php imap functions more easily and to be able to integrate this package within your current laravel installation., <sub>(*8)</sub>

Here is a basic example, which will echo out all Mails within all imap folders and will move every message into INBOX.read. Please be aware that this should not ben tested in real live but it gives an impression on how things work., <sub>(*9)</sub>

``` php use Webklex\IMAP\Client;, <sub>(*10)</sub>

$oClient = new Client([ 'host' => 'somehost.com', 'port' => 993, 'encryption' => 'ssl', 'validate_cert' => true, 'username' => 'username', 'password' => 'password', ]);, <sub>(*11)</sub>

//Connect to the IMAP Server $oClient->connect();, <sub>(*12)</sub>

//Get all Mailboxes $aMailboxes = $oClient->getFolders();, <sub>(*13)</sub>

//Loop through every Mailbox /** @var \Webklex\IMAP\Folder $oMailbox */ foreach($aMailboxes as $oMailbox){, <sub>(*14)</sub>

//Get all Messages of the current Mailbox
/** @var \Webklex\IMAP\Message $oMessage */
foreach($oMailbox->getMessages() as $oMessage){
    echo $oMessage->subject.'<br />';
    echo 'Attachments: '.$oMessage->getAttachments()->count().'<br />';
    echo $oMessage->getHTMLBody(true);

    //Move the current Message to 'INBOX.read'
    if($oMessage->moveToFolder('INBOX.read') == true){
        echo 'Message has ben moved';
    }else{
        echo 'Message could not be moved';
    }
}

}, <sub>(*15)</sub>

If you use the Facade [\Webklex\IMAP\Facades\Client::class](src/IMAP/Facades/Client.php) please select an account first:

``` php
use Webklex\IMAP\Facades\Client;

$oClient = Webklex\IMAP\Facades\Client::account('default');
$oClient->connect();

You can define your accounts inside the config/imap.php file:, <sub>(*16)</sub>

'accounts' => [ 
    'default' => [
        'host'  => env('IMAP_HOST', 'localhost'),
        'port'  => env('IMAP_PORT', 993),
        'encryption'    => env('IMAP_ENCRYPTION', 'ssl'),
        'validate_cert' => env('IMAP_VALIDATE_CERT', true),
        'username' => env('IMAP_USERNAME', 'root@example.com'),
        'password' => env('IMAP_PASSWORD', ''),
    ], 
    'gmail' => [.. ]
]

Documentation

Client::class

Message::class

Folder::class

Known issues

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*17)</sub>

Testing

bash $ composer test, <sub>(*18)</sub>

Security

If you discover any security related issues, please email github@webklex.com instead of using the issue tracker., <sub>(*19)</sub>

Credits

• Webklex
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>