CakePHP : Add “List-Unsubscribe” in email header using Email component - php

Question

I am usign cakephp 2.x and using Email components to send email.
I am trying to add List-Unsubscribe at headers.
$this->Email->headers = [
'List-Unsubscribe'=>'<mailto:'.$email_from.'?subject=Remove from Mailing List>, <'.$SITEURL.'unsubscribe?em='.$email_to.'>',
'List-Unsubscribe-Post'=>'List-Unsubscribe=One-Click'
];
Now in email source its showing in X-header.
X-List-Unsubscribe: <mailto:clients#example.com?subject=Remove from Mailing List>, <http://example.com/unsubscribe?em=xyz#example.com>
X-List-Unsubscribe-Post: List-Unsubscribe=One-Click
But it's not showing Unsubscribe link with From.
I need List-Unsubscribe in message header to avoid spam email.
When i try to use $this->Email->additionalParams its not showing List-Unsubscribe in email header.
Here is code that i am using
$send_from = $email_from_name . "<" . $email_from . ">";
$this->Email->sendAs = 'both'; // text / html / both
$this->Email->from = $send_from;
$this->Email->replyTo = $email_from;
$this->Email->return = $email_from;
$this->Email->to = $email_to;
$this->Email->delivery = 'smtp';
$this->Email->smtpOptions = ['host'=>$imap_server,'port'=>587,'username'=>$email,'password'=>$password];
$this->Email->subject = $subject;
$this->Email->headers = [
'List-Unsubscribe'=>'<mailto:'.$email_from.'?subject=Remove from Mailing List>, <'.SITEURL.'unsubscribe?em='.$email_to.'>',
'List-Unsubscribe-Post'=>'List-Unsubscribe=One-Click' ];
$this->Email->textMessage = $this->_html_to_text($content);
//$this->Email->delivery = 'debug';
$this->Email->send($content);

Answer 1

The email component doesn't support custom non X-prefixed headers, if you need that you'll have to use CakeEmail, which by default doesn't prefix headers, and requires you to explicitly pass prefixed headers in case required.
Given that the email component is long deprecated, ever since the first release of CakePHP 2 to be specific, now is probably a good time for you to finally drop it.
Quick and dirty example:
App::uses('CakeEmail', 'Network/Email');
// The transport/connection configuration should probably better be moved into a config file
$Email = new CakeEmail(array(
'transport' => 'Smtp',
'host' => $imap_server,
'port' => 587,
'username' => $email,
'password' => $password
));
$Email
->emailFormat('both')
->template('subscribe')
->from($send_from)
->replyTo($email_from)
->returnPath($email_from)
->to($email_to)
->subject($subject)
->addHeaders(array(
'List-Unsubscribe' =>
'<mailto:' . $email_from . '?subject=Remove from Mailing List>, ' .
'<' . $SITEURL . 'unsubscribe?em=' . $email_to . '>',
'List-Unsubscribe-Post' => 'List-Unsubscribe=One-Click'
))
->send($content);
This would require two templates, one for HTML in app/View/Emails/html/subscribe.ctp:
<?php
// $content contains the data passed to the `send()` method, wrapped to max 998 chars per line
echo $content;
and one for text in app/View/Emails/text/subscribe.ctp, requiring you to move the HTML to text conversion into the template. You should probably make it a helper, the following should just illustrate the principle:
<?php
echo _html_to_text($content);
See also
Cookbook > Core Libraries > Utilities > CakeEmail > Configuration
Cookbook > Core Libraries > Utilities > CakeEmail > Sending templated emails