====== 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. 
From version 8.4 php does not include the IMAP extension, which provides those functions. This plugin provides an alternative implementation that will allow the phplist bounce processing to continue.

This plugin can 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.


===== Installation =====

See the README file on the GitHub page https://github.com/bramley/phplist-plugin-imap2 for how to install the plugin.

===== Usage =====

The php-imap2 package supports only the IMAP protocol, not the POP3 protocol. The phplist bounce processing will work with the IMAP protocol but you need to ensure that the mailbox port is set correctly in the config.php file.

As an example to access the mailbox on port 143

<code php>$bounce_mailbox_port = "143/notls";</code>

or on port 993 over ssl

<code php>$bounce_mailbox_port = "993/imap/ssl";</code>

Using ''localhost'' for the bounce mailbox host does not work, 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>