phpList version 3.0.x - Code Enhancements

List-Unsubscribe and Mailto Headers


small phplist logo Well it looks as though the developers have included some of the envelope headers but not all are working as they ought to be. I compared the results from a 2.10.19 newsletter to that received from the newly installed 3.0.0 (& 3.0.4)

v3.0.2 eMail Headers - Out of the Box


To: jasper@mail.com
Subject: Testing Preferences Placeholder v2
Received: from host77-122-16-84.range77-122.btcentralplus.com [77.111.19.64] 
by www.website.com with https; Tue, 20 Aug 2013 00:34:08 +0100
Date: Tue, 20 Aug 2013 00:34:09 +0100
From: admin <master@website.com>
Reply-To: admin <master@website.com>
Message-ID: <59489f77e50665209447629849caf657@www.website.com>
X-Priority: 3
X-Mailer: PHPMailer 5.2.5 (https://github.com/Synchro/PHPMailer/)
X-Mailer: phpList v3.0.0
X-MessageID: 5
X-ListMember: jasper@mail.com
Precedence: bulk
Bounces-To: bounceAddress@website.com
List-Help: <>
List-Unsubscribe: <>
List-Subscribe: <https://www.awebsite/lists/?p=subscribe>
List-Owner: <mailto:master@website.com>

The developers though in the meantime for the v3.0.0 release have added some new options and have only partially addressed those that should have been in the v2.10 series.

In the above v3 example, the ones that I have an issue with are :-


Received: from

Why is this in here I do not want to display the remote IP address of my broadband hub everytime I run ProcessQueue from my workstation. I've added the removal of this as an optional hack to the download instructions. It should also be noted that too many "Received-From" headers can mark email as spam, so best to remove this one.

Resolution: Removed in the hack


Precedence: bulk

The developers have re-instated this option, so I've removed it from my hack.

Resolution: No Problem


Bounces-To:

Looks as though this replaces the Errors-To header, though you will need to modify the message-envelope in the config.php file to reflect the address that you want the bounces to go to. This one does not appear to be in any of the available RFC guidelines relating to Envelope Headers so not entirely sure where the developers got this from. It will be removed from my system until such time that it is officially recognised by the RFC.

Resolution: Removed in the hack and replaced by Errors-To:


List-Help: <>

Obviously not fully operational as yet. Will have to wait and see what the developers do. For now I have removed it.

Resolution: Left this one in. Works with SMTP not phpMailer ?


List-Unsubscribe: <>

Again not operational as all the relevant data is missing and no obvious means of editing the settings from the admin pages. See my hack to correct this.

Resolution: Removed the phpList variant and replaced with mine in the hack.


Reply-To:

This has been added by the developers, however it appears that the user cannot define the email address to be used..

Resolution: Removed the phpList version and re-installed my hack from v2. According to some reports this is the header to use for Bounce Handling as the Return-Path is considered flakey. Set this to the same as the Return-Path for now..


List-Subscribe:

This is new, so we'll leave it alone

Resolution: No Changes


List-Owner:

Another new option, which we will also leave as is.

Resolution: No Change


Errors-To:

This was replaced by the Bounces-To header by the developers, however picking up the wrong email address.

Resolution: The emailing jury is out on this one, some say yes, others no. For now it stays


Return Path

A lot of mail delivery systems use this when a mail is bounced but by default phpList sets this to the From Address..

Resolution: Not a major Problem, just make sure that you enter the correct email address for the message evvelope in the bounces section of the config.php file.



v3.0.2 eMail Headers - After a little pruning and hacking.


Return-Path: <agp.temp@alangeorge-photography.com> 

To: jasper@alangeorge-photography.com
Subject: Summer Style v5 - Envelope headers
Date: Thu, 5 Sep 2013 21:56:12 +0100

From: AlanGeorge <system@alangeorge-photography.com> 
Message-ID: <abbbc9bda33e354b80baca4a9b3005aa@www.alangeorge-photography.com> 

X-Priority: 3
X-Mailer: PHPMailer 5.2.5 (https://github.com/Synchro/PHPMailer/)
X-Mailer: phpList v3.0.2
X-MessageID: 48

X-ListMember: jasper@alangeorge-photography.com

List-Unsubscribe: <mailto:un-sub@alangeorge-photography.com?subject=ac4bdfae64> ,
   <https://www.alangeorge-photography.com/agp_newsfeed/?p=unsubscribe&uid=ac4bdfae64> 

Reply-To: agp_temp@alangeorge-photography.com

Errors-To: errors@alangeorge-photography.com

Precedence: bulk

List-Help: <> 
List-Subscribe: <https://www.alangeorge-photography.com/agp_newsfeed/?p=subscribe> 
List-Owner: <mailto:master@alangeorge-photography.com> 


Download

Shown below are all the code modifications required to include the List-Unsubscribe header in your eMails based on the original phpList forum contributors work (cs & btushar).

These modifications can be added to version 3.0.2 and have been tested on my production environment on a hosted server.

As with all hacks make sure you take the necessary precautions before updating your production system..

List-Unsubscribe options appear in both gmail and hotmail, however only the gmail has so far successfully replied which is not a surprise due to the lack of speed with the other.

DO NOT

Do Not apply these modifications to phpList v2.10.19 and below.





Rel. Date Ver. Notes
14-06-2017 2.1.9 Documentation for phpList v3.3.1
02-06-2017 2.1.8 Documentation for phpList v3.3.0
31-01-2017 2.1.7 Documentation for phpList v3.3.0 RC4
08-01-2017 2.1.6 Documentation for phpList v3.2.7.
10-11-2016 2.1.5 Documentation for phpList v3.2.6.
06-10-2016 2.1.4 Documentation for phpList v3.2.6 rc1.
28-05-2016 2.1.3 Documentation for phpList v3.2.5.
25-02-2016 2.1.2 Documentation for phpList v3.2.4.
23-02-2016 2.1.1 Documentation for phpList v3.2.3.
21-02-2016 2.1.0 Code & Documentation for phpList v3.2.2.
13-02-2016 2.0.9 Confirmed compatability with phpList v3.2.1 and updated documentation.
06-02-2016 2.0.8 Confirmed compatability with phpList v3.2.0 and updated documentation.
05-02-2015 2.0.7 Confirmed compatability with phpList v3.0.12 and updated documentation.
12-01-2015 2.0.6 Confirmed compatability with phpList v3.0.11 and updated documentation.
24-10-2014 2.0.5 Confirmed compatability with phpList v3.0.9 & 10 and updated documentation.
13-09-2014 2.0.4 Confirmed compatability with phpList v3.0.8 and updated documentation.
21-08-2014 2.0.3 Confirmed compatability with phpList v3.0.7 and updated documentation.
26-04-2014 2.0.2 Confirmed compatability with phpList v3.0.6 and updated documentation.
Release Date Rel-Date Version Ver. Notes php
List
Download
phpList with AG-P Hacks is distributed under the LGPL. Read More
14.02.2017 2.1.9 Documentation changes for phpList 3.3.1 3.3.1 Download
06.02.2017 2.1.8 Documentation changes for phpList 3.3.0 3.3.0 Download
31.01.2017 2.1.7 Documentation changes for phpList 3.3.0 RC4 3.3.0 RC4 Download
08.01.2017 2.1.6 Documentation changes for phpList 3.2.7 3.2.7 Download
10.11.2016 2.1.5 Documentation changes for phpList 3.2.6 3.2.6 Download
06.10.2016 2.1.4 Documentation changes for phpList 3.2.6 rc1 3.2.6 rc1 Download
28.05.2016 2.1.3 Documentation changes for phpList 3.2.5 3.2.5 Download
25.02.2016 2.1.2 Documentation changes for phpList 3.2.4 3.2.4 Download
23.02.2016 2.1.1 Documentation changes for phpList 3.2.3 3.2.3 Download
21.02.2016 2.1.0 Code & Documentation changes for phpList 3.2.2 3.2.2 Download
13.02.2016 2.0.9 Coding changes for phpList 3.2.1 3.2.1 Download
06.02.2016 2.0.8 Coding changes for phpList 3.2.0 3.2.0 Download
05.02.2015 2.0.7 Coding changes for phpList 3.0.12 3.0.12 Download
12.01.2015 2.0.6 Coding changes for phpList 3.0.11 3.0.11 Download
24.10.2014 2.0.5 Coding changes for phpList 3.0.9 & 10 3.0.10 Download
13.09.2014 2.0.4 Coding changes for phpList 3.0.8 3.0.8 Download
21.08.2014 2.0.3 Coding changes for phpList 3.0.7 3.0.7 Download
26.04.2013 2.0.2 phpList 3.0.6 Documentation Update 3.0.6 Download
23.02.2012 1.0.0 Original Release 3.0.1 Download


All photographs & images are the copyright of Alan G Fairhall and may not be reproduced or downloaded without express permission from the photographer
alangeorge-photography