PHP-IMAP integration bundle
Simple php-imap integration for Symfony 4.x, 5.x and 6.x.
The version 1.5 and above are only compatible with Symfony 4+. Previous versions support was dropped. If you'd like to use it with Symfony 2.8 or 3.x you should use the version 1.4 which was the last compatible with Symfony 2.8 and 3.x.
Want to support this bundle?
Consider buying our MacOS app which allows you to customize your MacOS menu bar.
Infinite Menu Bar allows you to add to your menu bar custom elements. Want to have current IP (local or external), Macbook battery state, Bitcoin price or even custom contet from any HTTP URL or API? No problem! This app can do this and many more!
Installation
1. Composer
From the command line run
$ composer require secit-pl/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 SecIT\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 protected]"
password: "password"
another_connection:
mailbox: "{localhost:143}INBOX"
username: "username"
password: "password"
attachments_dir: "%kernel.project_dir%/var/imap/attachments"
server_encoding: "UTF-8"
full_config_connection:
mailbox: "{localhost:143}INBOX"
username: "username"
password: "password"
attachments_dir: "%kernel.project_dir%/var/imap/attachments"
create_attachments_dir_if_not_exists: true # default true
created_attachments_dir_permissions: 777 # default 770
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/[email protected]/user=shared_account}Root/Folder"
username: "[email protected]"
password: "password"
Usage
With autowiring
In your controller:
<?php
namespace App\Controller;
use SecIT\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 SecIT\ImapBundle\Service\Imap;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
class IndexController extends Controller
{
public function indexAction()
{
$exampleConnection = $this->get('secit.imap')->get('example_connection');
$anotherConnection = $this->get('secit.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('secit.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('secit.imap')->testConnection('example_connection');
var_dump($isConnectable);
// testing with a full error message
try {
$isConnectable = $this->get('secit.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.
22 Jan 2, 2023
86 Oct 5, 2022
13 Apr 2, 2022
1 May 3, 2022
369 Jan 3, 2023
12 Jun 12, 2023
48 Jan 5, 2023
3 Nov 15, 2022
9 Oct 21, 2022
65 Feb 3, 2022
3 Oct 7, 2022
6 Jun 5, 2023
175 Sep 3, 2022
47 May 23, 2022
48 Jan 2, 2023
10 Oct 6, 2022
1 Nov 18, 2021
443 Dec 19, 2022
6 Nov 6, 2022