Module EMail Collector

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Numero/ID of module 50320
User doc. of module This page
Developer doc. of module Module EMail Collector (developer)


This module permits to collect emails from a mailbox using the IMAP protocol and record event or data in your Dolbarr using information found into email.


This module is included with the Dolibarr distribution, so there is no need to install it.


To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg at end of line of the module, click on it to access the setup page specific to the module.

Create an email collector

Create as many email collector you need.

Source directory

  • To collect received email, enter here "INBOX"
  • To collect email sent, enter here "Sent"

Target directory A good practice is to move the collected email into another folder to avoid to have them collected twice. You must create the output target IMAP directory manually before running your email collector.

For example, with Gmail, to create a new IMAP directory:

  • Sign in to your Gmail account.
  • At the top right of the Gmail window, click Settings See all settings.
  • Click Labels.
  • Create Label and check the box "Show in IMAP"


Operations to do

Examples and explanation of some collectors



Let the job scheduler being executed automatically and see your data being recorded into Dolibarr.

To avoid to wait the batch, you can force to execute the email collector manually from the Email collector record with the button "Run now". When making test, a good practice is to set the maximum number of email collected to a low value.