meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
plugin:imap2 [2023/02/04 14:22] – created duncancplugin:imap2 [2025/02/08 11:00] (current) – [Usage] duncanc
Line 1: Line 1:
 +====== Imap2 plugin ======
 +
 +Description: This plugin enables the phplist bounce processing when the php IMAP extension is not installed.
 +Author     : Duncan Cameron
 +
 +source repo : https://github.com/bramley/phplist-plugin-imap2/
 +
 +
 +===== Purpose =====
 +
 +This plugin uses the javanile/php-imap2 package to emulate the php imap_xxx functions that are used by phplist for bounce processing.
 +
 +Those functions are provided by the IMAP extension, but that extension has been removed in php version 8.4. This plugin provides an alternative implementation that will allow phplist to continue processing bounces.
 +
 +This plugin can also be used with php versions prior to 8.4 if the hosting provider does not provide the IMAP extension.
 +
 +If your php configuration already includes the IMAP extension then you do not need this plugin. The plugin can be installed but will not have any effect.
 +
 +
 +===== Installation =====
 +
 +See the README file on the GitHub page https://github.com/bramley/phplist-plugin-imap2 for how to install the plugin.
 +
 +===== Usage =====
 +
 +=== Use of localhost ===
 +Using ''localhost'' for the bounce mailbox host is not supported, the server name should be used instead. For example instead of 
 +
 +<code php>$bounce_mailbox_host = 'localhost';</code>
 +use something like
 +<code php>$bounce_mailbox_host = 'mail.mysite.com';</code>
 +
 +=== Use IMAP instead of POP3 ===
 +The php-imap2 package supports only the IMAP protocol, not the POP3 protocol. This is compatible with the phplist bounce processing and should not be a problem.
 +
 +The plugin will detect when POP3 is trying to be used and change the port and protocol to the equivalent IMAP values but for clarity you may want to change the setting in the config.php file. You might also need to change the value of ''$bounce_mailbox_host'' because that might differ between POP3 and IMAP.
 +
 +For example, if you currently access the mailbox using POP3
 +
 +<code php>$bounce_mailbox_port = '110/pop3';</code>
 +
 +That needs to be changed to use IMAP on port 143
 +
 +<code php>$bounce_mailbox_port = '143/imap';</code>
 +
 +Or if you currently access the mailbox using secure POP3
 +
 +<code php>$bounce_mailbox_port = '995/pop3/ssl';</code>
 +
 +That needs to be changed to use IMAP on port 993
 +
 +<code php>$bounce_mailbox_port = '993/imap/ssl';</code>
 +
 +
 +
 +