Configuration

To connect to an IMAP mailbox, create a new Mailbox instance with your connection configuration:

use DirectoryTree\ImapEngine\Mailbox;

$mailbox = new Mailbox([
    'port' => 993,
    'username' => 'your-username',
    'password' => 'your-password',
    'encryption' => 'ssl',
    'host' => 'imap.example.com',
]);

OAuth Connection

To connect using an OAuth token, pass the token as the password and set the authentication method to 'oauth':

use DirectoryTree\ImapEngine\Mailbox;

$token = 'your-oauth-token';

$mailbox = new Mailbox([
    'port' => 993,
    'username' => 'your-username',
    'password' => $token,
    'encryption' => 'ssl',
    'authentication' => 'oauth',
    'host' => 'imap.example.com',
]);

STARTTLS Connection

To connect using STARTTLS, set the encryption option to 'starttls' and use port 143:

use DirectoryTree\ImapEngine\Mailbox;

$mailbox = new Mailbox([
    'port' => 143,
    'encryption' => 'starttls',
    'username' => 'your-username',
    'password' => 'your-password',
    'host' => 'imap.example.com',
]);

Advanced Configuration

ImapEngine supports many configuration options for fine-tuning your connection:

use DirectoryTree\ImapEngine\Mailbox;

$mailbox = new Mailbox([
    'port' => 993,
    'host' => 'imap.example.com',
    'timeout' => 30,
    'debug' => false,
    'username' => 'your-username',
    'password' => 'your-password',
    'encryption' => 'ssl',
    'validate_cert' => true,
    'authentication' => 'plain',
    'proxy' => [
        'socket' => null,
        'username' => null,
        'password' => null,
        'request_fulluri' => false,
    ],
]);

Configuration Options

Debugging

The debug configuration option controls logging behavior for the mailbox.

Boolean

• false – (Default) Disables debugging output
• true – Enables debugging using an EchoLogger, which outputs debug messages to the console

use DirectoryTree\ImapEngine\Mailbox;

// No debug output.
$mailbox = new Mailbox([
    // ...
    'debug' => false,
]);

// Output debug messages to the console.
$mailbox = new Mailbox([
    // ...
    'debug' => true,
]);

String

When set to a file path (e.g., '/path/to/log/file.log'), a FileLogger is instantiated to write debug messages to the specified file.

use DirectoryTree\ImapEngine\Mailbox;

// Output debug messages to a file.
$mailbox = new Mailbox([
    // ...
    'debug' => '/path/to/log/file.log',
]);

Class Name

If provided with a fully-qualified class name (and the class exists), an instance of that logger will be created and used.

The class must implement LoggerInterface.

namespace App\Loggers;

use DirectoryTree\ImapEngine\Connection\Loggers\LoggerInterface;

class CustomLogger implements LoggerInterface
{
    /**
     * Log when a message is sent.
     */
    public function sent(string $message): void
    {
        // Log the sent message...
    }

    /**
     * Log when a message is received.
     */
    public function received(string $message): void
    {
        // Log the received message...
    }
}

use App\Loggers\CustomLogger;
use DirectoryTree\ImapEngine\Mailbox;

$mailbox = new Mailbox([
    // ...
    'debug' => CustomLogger::class,
]);

Or, if you use Spatie Ray, you may use the built in RayLogger:

use DirectoryTree\ImapEngine\Mailbox;
use DirectoryTree\ImapEngine\Connection\Loggers\RayLogger;

$mailbox = new Mailbox([
    // ...
    'debug' => RayLogger::class,
]);