dadadev/imap-bundle

PHP-IMAP Symfony integration.

1.0.1 2022-01-10 06:47 UTC

This package is auto-updated.

Last update: 2022-05-10 09:19:00 UTC


README

Simple php-imap integration for Symfony 2.8, 3.x, 4.x, 5.x and 6.x.

Installation

1. Composer

From the command line run

$ composer require dadadev/imap-bundle

If you're using Symfony Flex you're done and you can go to the configuration section otherwise you must manually register this bundle.

2. Register bundle

If you're not using Symfony Flex you must manually register this bundle in your AppKernel by adding the bundle declaration

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            ...
            new DaDaDev\ImapBundle\ImapBundle(),
        ];

        ...
    }
}

Configuration

Setup your mailbox configuration. If your are using symfony 2.8 or 3.x without Symfony Flex add your configuration in app/config/config.yml. If you're using Symfony 4 or Symfony 3.x with Flex open the config/packages/imap.yaml and adjust its content.

Here is the example configuration:

imap:
    connections:
        example_connection:
            mailbox: "{localhost:993/imap/ssl/novalidate-cert}INBOX"
            username: "email@example.com"
            password: "password"

        another_connection:
            mailbox: "{localhost:143}INBOX"
            username: "username"
            password: "password"
            attachments_dir: "%kernel.root_dir%/../var/imap/attachments"
            server_encoding: "UTF-8"

If you're using Symfony to connect to a Microsoft 365 business environment, there's a good chance you'll want to connect to a shared mailbox. In that case you need to specify the parameters authuser and user. Where shared_account is the username without domain, like:

imap:
    connections:
        example_connection:
            mailbox: "{outlook.office365.com:993/imap/ssl/authuser=first.last@example.com/user=shared_account}Root/Folder"
            username: "email@example.com"
            password: "password"

Usage

With autowiring

In your controller:

<?php

namespace App\Controller;

use DaDaDev\ImapBundle\Service\Imap;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class IndexController extends AbstractController
{
    public function indexAction(Imap $imap)
    {
        $exampleConnection = $imap->get('example_connection');
        $anotherConnection = $imap->get('another_connection');

        ...
    }

    ...
}

With service container

In your controller:

<?php

namespace App\Controller;

use DaDaDev\ImapBundle\Service\Imap;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class IndexController extends Controller
{
    public function indexAction()
    {
        $exampleConnection = $this->get('dadadev.imap')->get('example_connection');
        $anotherConnection = $this->get('dadadev.imap')->get('another_connection');

        ...
    }

    ...
}

From this point you can use any of the methods provided by the php-imap library. For example

$exampleConnection = $this->get('dadadev.imap')->get('example_connection');
$exampleConnection->getMailboxInfo();

To quickly test the connection to the server you can use the testConnection() method

// testing with a boolean response
$isConnectable = $this->get('dadadev.imap')->testConnection('example_connection');
var_dump($isConnectable);

// testing with a full error message
try {
    $isConnectable = $this->get('dadadev.imap')->testConnection('example_connection', true);
} catch (\Exception $exception) {
    echo $exception->getMessage();
}

Be aware that this will disconnect your current connection and create a new one on success. In most cases this is not a problem.