meta data for this page
  •  

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin:imap2 [2024/05/20 00:00] – external edit 127.0.0.1plugin:imap2 [2025/05/29 10:39] (current) – [Installation] duncanc
Line 9: Line 9:
 ===== Purpose ===== ===== Purpose =====
  
-This plugin uses the javanile/php-imap2 package to emulate the php imap_xxx functions that are used by phplist for bounce processing. Some hosting providers, such as GoDaddy shared hosting, do not provide the imap extension that is needed by the phplist bounce processing.+This plugin uses the javanile/php-imap2 package to emulate the php imap_xxx functions that are used by phplist for bounce processing.
  
-If your php configuration already includes the imap extension then you do not need this plugin.+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 ===== ===== Installation =====
  
-See the README file on the GitHub page https://github.com/bramley/phplist-plugin-imap2 for how to install the plugin.+Install on the Manage Plugins page (menu Config > Manage Plugins) using the package URL 
 +    https://github.com/bramley/phplist-plugin-imap2/archive/master.zip 
 + 
 +Then enable the Common plugin.
  
 ===== Usage ===== ===== Usage =====
  
-The php-imap2 package supports only the IMAP protocol, not the POP3 protocol. The phplist bounce processing will work with IMAP but you need to ensure that the mailbox port is set correctly in the config.php file.+=== 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> 
 + 
 + 
 +=== Debugging === 
 + 
 +You can log the dialogue with the mail server by including ''/debug'' within the value of ''$bounce_mailbox_port'', e.g.  
 + 
 +<code php>$bounce_mailbox_port = '993/imap/ssl/debug';</code> 
 + 
 +and by setting a variable in config.php
  
-As an example to access the mailbox on port 143+<code php>$log_options = [ 
 +    'threshold' => 'DEBUG', 
 +];</code>
  
-<code php>$bounce_mailbox_port = "143/notls";</code>+Now the plugin will write the dialogue to a file in the phplist temporary directory, identfied by the ''$tmpdir'' variable in config.php. The file will be named for the current day, ''log_yyyy-mm-dd.txt''. 
  
-or on port 993 over ssl+Alternatively you can specify a particular directory for the log file. The directory must be writeable by the web server process.  
 +<code php>$log_options = [ 
 +    'threshold' => 'DEBUG', 
 +    'dir' => '/path/to/directory', 
 +];</code>
  
-<code php>$bounce_mailbox_port = "993/imap/ssl";</code>+The dialogue will be logged similar to this
  
 +<code>[06:33:10] [debug] [BC29] Connecting to ssl://imap.gmail.com:993...
 +[06:33:10] [debug] [BC29] S: * OK Gimap ready for requests from 87.115.225.95 h41mb25057261wmp
 +[06:33:10] [debug] [BC29] C: A0001 CAPABILITY
 +[06:33:10] [debug] [BC29] S: * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1 XYZZY SASL-IR AUTH=XOAUTH2 AUTH=PLAIN AUTH=PLAIN-CLIENTTOKEN AUTH=OAUTHBEARER
 +</code>