| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| mantisbt:plugins:emailreporting [2026/09/18 12:07] – [mail_engine] SL-Gundam | mantisbt:plugins:emailreporting [2026/10/12 15:57] (current) – [mail_engine] SL-Gundam |
|---|
| ^ Mail transport engine ^ State ^ IMAP ^ POP3 ^ Notes ^ | ^ Mail transport engine ^ State ^ IMAP ^ POP3 ^ Notes ^ |
| | PEAR (Net_IMAP and Net_POP3) | Working | Supported | Supported | These are the legacy mail transport packages. They are included by default | | | PEAR (Net_IMAP and Net_POP3) | Working | Supported | Supported | These are the legacy mail transport packages. They are included by default | |
| | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Legacy and Modern)]] | In development | Supported | Supported | | | | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Legacy and Modern)]] | Working (beta) | Supported | Supported | Horde Modern does not process attachments properly. Issue reported here: [[https://github.com/horde/Imap_Client/issues/54|#54]] | |
| | [[https://packagist.org/packages/javanile/php-imap2|Javanile/PHP-IMAP2]] | Removed | Supported | Not supported | Javanile/PHP-IMAP2 is migrating its code to use Webklex/PHP-IMAP. So would not be a good addition. | | | [[https://packagist.org/packages/javanile/php-imap2|Javanile/PHP-IMAP2]] | Removed | Supported | Not supported | Javanile/PHP-IMAP2 is migrating its code to use Webklex/PHP-IMAP. So would not be a good addition. | |
| | [[https://packagist.org/packages/webklex/php-imap|Webklex/PHP-IMAP]] | Working | Supported | Not supported | | | | [[https://packagist.org/packages/webklex/php-imap|Webklex/PHP-IMAP]] | Working (beta) | Supported | Not supported | | |
| | [[https://packagist.org/packages/zetacomponents/mail|ZetaComponents/Mail]] | In development | Supported | Supported | | | | [[https://packagist.org/packages/zetacomponents/mail|ZetaComponents/Mail]] | Working (beta) | Supported | Supported | | |
| | [[https://packagist.org/packages/directorytree/imapengine|DirectoryTree/ImapEngine]] | In development | Supported | Supported | | | | [[https://packagist.org/packages/directorytree/imapengine|DirectoryTree/ImapEngine]] | Working (beta) | Supported | Not supported | | |
| |
| Support for any of these packages may be removed based on compatibility and requirements. | Support for any of these packages may be removed based on compatibility and requirements. |
| |
| The general advise is to use the default (PEAR). If it does not work properly for you try one of the others. Report to use which one worked for you and which one didn't. | The general advise is to use the default (PEAR). If it does not work properly for you try one of the others. Report on the MantisBT forum which one worked for you and which one didn't. |
| All of the engines should offer the same functionality where possible. Currently the only difference is the support for POP3 which is missing from some of them. | All of the engines should offer the same functionality where possible. Currently the only difference is the support for POP3 which is missing from some of them. |
| | |
| | == Some performance numbers for EmailReporting 0.13.0 == |
| | All transport engines were given 4 emails, in 2 IMAP folders. Every email contained a total attachment size of around 5 MiB |
| | |
| | ^ Mail transport engine ^ Runtime in seconds ^ Peak Memory usage (real) ^ Notes ^ |
| | | PEAR (Net_IMAP) | 3.6906 | 26.42 MiB (30 MiB) | Performs surprisingly well | |
| | | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Legacy)]] | 3.3303 | 27.4 MiB (30 MiB) | Surprisingly close to PEAR | |
| | | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Modern)]] | 14.2741 | 42.3 MiB (46 MiB) | Only partially processed the first attachment in each email. Issue reported here: [[https://github.com/horde/Imap_Client/issues/54|#54]] | |
| | | [[https://packagist.org/packages/webklex/php-imap|Webklex/PHP-IMAP]] | 8.7441 (incomplete) | 89.06 MiB (120 MiB) | Crashed with error on the third email. "Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 446464 bytes)". Implementation needs more work. | |
| | | [[https://packagist.org/packages/zetacomponents/mail|ZetaComponents/Mail]] | Unknown | Unknown | Zeta did everything correctly but crashed on cleanup. "SYSTEM WARNING 'dir(C:\WINDOWS\TEMP\20120-1/): Access is deni (code: 5)'". This needs to be investigated | |
| | | [[https://packagist.org/packages/directorytree/imapengine|DirectoryTree/ImapEngine]] | 3.4043 | 43.24 MiB (46 MiB) | A little more memory usage but otherwise performed well. There is potential for improvement on EmailReportings implementation | |
| | |
| | == Some performance numbers for EmailReporting 0.14.0 == |
| | |
| | ^ Mail transport engine ^ Runtime in seconds ^ Peak Memory usage (real) ^ Notes ^ |
| | | PEAR (Net_IMAP) | 3.6906 | 26.42 MiB (30 MiB) | Unchanged | |
| | | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Legacy)]] | 3.3303 | 27.4 MiB (30 MiB) | Unchanged | |
| | | [[https://packagist.org/packages/horde/imap_client|Horde/Imap_Client (Modern)]] | 4.4009 | 26.67 MiB (34 MiB) | **Still has issues**. Performance numbers with Option 1 fix from [[https://github.com/horde/Imap_Client/issues/54|#54]] which is not included in 0.14.0 | |
| | | [[https://packagist.org/packages/webklex/php-imap|Webklex/PHP-IMAP]] | 17.9368 | 31.09 MiB (42 MiB) | Implementation issues fixed for EmailReporting 0.14.0. Implementation could be better but at least the memory usage is not getting out of hand. | |
| | | [[https://packagist.org/packages/zetacomponents/mail|ZetaComponents/Mail]] | 3.5994 | 26.76 MiB (30 MiB) | Implementation issues fixed for EmailReporting 0.14.0 | |
| | | [[https://packagist.org/packages/directorytree/imapengine|DirectoryTree/ImapEngine]] | 3.3861 | 34.53 MiB (38 MiB) | Minor optimization for message retrieval | |
| | |
| | |
| === mail_max_memory_usage === | === mail_max_memory_usage === |
| Name: Maximum memory usage during mail processing | Name: Maximum memory usage during mail processing |
| |
| For most situations it is advised to choose USER for POP3 and PLAIN for IMAP where OAuth is __not__ required. Choose XOAUTH2 for Modern OAuth authentication like with Microsoft 365 and Google Workspaces. | For most situations it is advised to choose USER for POP3 and PLAIN for IMAP where OAuth is __not__ required. Choose XOAUTH2 for Modern OAuth authentication like with Microsoft 365 and Google Workspaces. |
| | |
| | Some of the [[#mail_engine|Mail engines]] do not reliably use the specified authentication method. This is because they have no way to set the one we one want to use besides XOAUTH2 and not XOAUTH2. Often they will employ detection what the mail server supports and then choose the most secure option they have available within the supported options. In these cases PLAIN and LOGIN were still kept so that migrating between [[#mail_engine|Mail engines]] would not cause to much issues. |
| |
| === erp_username === | === erp_username === |
| Scope information: [[https://developers.google.com/workspace/gmail/imap/xoauth2-protocol]] | Scope information: [[https://developers.google.com/workspace/gmail/imap/xoauth2-protocol]] |
| |
| Scope to be used for domain wide delegation: https://www.googleapis.com/auth/gmail.imap_admin | Scope to be used for domain wide delegation: |
| | <code> |
| !!! Google Serviceaccount credentials have not been tested yet because i don't have access to a Google Workspace account. In theory it works but the instructions are less detailed then Microsoft. | https://www.googleapis.com/auth/gmail.imap_admin |
| | </code> |
| === m_mailbox === | === m_mailbox === |
| Name: Mailbox email address | Name: Mailbox email address |
