modMail to insert List-Unsubscribe header

mintnl · December 4, 2022, 9:24pm

Hi, i’m developing a snippet to send a email to an eligable person for voting on a subject.
I want to insert a header in the email “List-Unsubscribe” with a value. Anyone know how to insert this header?

$modx->getService('mail', 'mail.modPHPMailer');
$modx->mail->set(modMail::MAIL_BODY,$message);
$modx->mail->set(modMail::MAIL_FROM,'website@mydomainname.tld');
$modx->mail->set(modMail::MAIL_SENDER,'website@mydomainname.tld');
$modx->mail->set(modMail::MAIL_FROM_NAME,'My website name');
$modx->mail->set(modMail::MAIL_SUBJECT,'Subject for the email');
$modx->header->set('List-Unsubscribe','unsub@mydomainname.tld');
$modx->mail->address('to','eligableperson@hisdomainname.tld', 'Name person');
$modx->mail->address('reply-to','website@mydomainname.tld');
$modx->mail->setHTML(true);
if (!$modx->mail->send()) {
    $modx->log(modX::LOG_LEVEL_ERROR,'Fout bij verzenden email: '.$modx->mail->mailer->ErrorInfo);
}
$modx->mail->reset();

halftrainedharry · December 4, 2022, 9:50pm

I haven’t tested it, but the class “modPHPMailer” has a function “header”.

github.com

modxcms/revolution/blob/43356abb78689670542726ace23a0b0f348858a4/core/model/modx/mail/modphpmailer.class.php#L185-L197


      
          /**
           * Adds a custom header to the mailer
           *
           * @param string $header The header to set
           * @return boolean True if the header was successfully set
           */
          public function header($header) {
              $set= parent :: header($header);
              if ($set) {
                  $this->mailer->addCustomHeader($header);
              }
              return $set;
          }

So you probably have to call $modx->mail->header() and it seems that the header must have the format name:value (name and value separated by a colon :).

bobray · December 5, 2022, 6:36am

The Subscribe extra (in conjunction with the Notify extra) puts an unsubscribe link in the text of the email. The link is obfuscated and contains an encoded key to identify the user, otherwise, bad actors could unsubscribe people. The class is here, but you may have to look at other parts of the two extras to understand it.