/usr/share/php/Horde/Mime/Mdn.php is in php-horde-mime 2.2.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | <?php
/**
* The Horde_Mime_Mdn:: class implements Message Disposition Notifications as
* described by RFC 3798.
*
* Copyright 2004-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Michael Slusarz <slusarz@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Mime
*/
class Horde_Mime_Mdn
{
/* RFC 3798 header for requesting a MDN. */
const MDN_HEADER = 'Disposition-Notification-To';
/**
* The Horde_Mime_Headers object.
*
* @var Horde_Mime_Headers
*/
protected $_headers;
/**
* The text of the original message.
*
* @var string
*/
protected $_msgtext = false;
/**
* Constructor.
*
* @param Horde_Mime_Headers $mime_headers A headers object.
*/
public function __construct(Horde_Mime_Headers $headers)
{
$this->_headers = $headers;
}
/**
* Returns the address to return the MDN to.
*
* @return string The address to send the MDN to. Returns null if no
* MDN is requested.
*/
public function getMdnReturnAddr()
{
/* RFC 3798 [2.1] requires the Disposition-Notification-To header
* for an MDN to be created. */
return $this->_headers->getValue(self::MDN_HEADER);
}
/**
* Is user input required to send the MDN?
* Explicit confirmation is needed in some cases to prevent mail loops
* and the use of MDNs for mail bombing.
*
* @return boolean Is explicit user input required to send the MDN?
*/
public function userConfirmationNeeded()
{
$return_path = $this->_headers->getValue('Return-Path');
/* RFC 3798 [2.1]: Explicit confirmation is needed if there is no
* Return-Path in the header. Also, "if the message contains more
* than one Return-Path header, the implementation may [] treat the
* situation as a failure of the comparison." */
if (empty($return_path) || is_array($return_path)) {
return true;
}
/* RFC 3798 [2.1]: Explicit confirmation is needed if there is more
* than one distinct address in the Disposition-Notification-To
* header. */
$rfc822 = new Horde_Mail_Rfc822();
$addr_ob = $rfc822->parseAddressList($this->getMdnReturnAddr());
switch (count($addr_ob)) {
case 0:
return false;
case 1:
// No-op
break;
default:
return true;
}
/* RFC 3798 [2.1] states that "MDNs SHOULD NOT be sent automatically
* if the address in the Disposition-Notification-To header differs
* from the address in the Return-Path header." This comparison is
* case-sensitive for the mailbox part and case-insensitive for the
* host part. */
$ret_ob = new Horde_Mail_Rfc822_Address($return_path);
return ($ret_ob->valid &&
($addr_ob->bare_address == $ret_ob->bare_address));
}
/**
* When generating the MDN, should we return the enitre text of the
* original message? The default is no - we only return the headers of
* the original message. If the text is passed in via this method, we
* will return the entire message.
*
* @param string $text The text of the original message.
*/
public function originalMessageText($text)
{
$this->_msgtext = $text;
}
/**
* Generate the MDN according to the specifications listed in RFC
* 3798 [3].
*
* @param boolean $action Was this MDN type a result of a manual
* action on part of the user?
* @param boolean $sending Was this MDN sent as a result of a manual
* action on part of the user?
* @param string $type The type of action performed by the user.
* Per RFC 3798 [3.2.6.2] the following types are
* valid:
* - deleted
* - displayed
* @param string $name The name of the local server.
* @param Mail $mailer A Mail driver.
* @param array $opts Additional options:
* - charset: (string) Default charset.
* DEFAULT: NONE
* - from_addr: (string) From address.
* DEFAULT: NONE
* @param array $mod The list of modifications. Per RFC 3798
* [3.2.6.3] the following modifications are
* valid:
* - error
* @param array $err If $mod is 'error', the additional
* information to provide. Key is the type of
* modification, value is the text.
*
* @throws Horde_Mime_Exception
*/
public function generate($action, $sending, $type, $name, $mailer,
array $opts = array(), array $mod = array(),
array $err = array())
{
$opts = array_merge(array(
'charset' => null,
'from_addr' => null
), $opts);
$to = $this->getMdnReturnAddr();
$ua = $this->_headers->getUserAgent();
$orig_recip = $this->_headers->getValue('Original-Recipient');
if (!empty($orig_recip) && is_array($orig_recip)) {
$orig_recip = $orig_recip[0];
}
$msg_id = $this->_headers->getValue('Message-ID');
/* Create the Disposition field now (RFC 3798 [3.2.6]). */
$dispo = 'Disposition: ' .
(($action) ? 'manual-action' : 'automatic-action') .
'/' .
(($sending) ? 'MDN-sent-manually' : 'MDN-sent-automatically') .
'; ' .
$type;
if (!empty($mod)) {
$dispo .= '/' . implode(', ', $mod);
}
/* Set up the mail headers. */
$msg_headers = new Horde_Mime_Headers();
$msg_headers->addMessageIdHeader();
$msg_headers->addUserAgentHeader($ua);
$msg_headers->addHeader('Date', date('r'));
if ($opts['from_addr']) {
$msg_headers->addHeader('From', $opts['from_addr']);
}
$msg_headers->addHeader('To', $this->getMdnReturnAddr());
$msg_headers->addHeader('Subject', Horde_Mime_Translation::t("Disposition Notification"));
/* MDNs are a subtype of 'multipart/report'. */
$msg = new Horde_Mime_Part();
$msg->setType('multipart/report');
$msg->setContentTypeParameter('report-type', 'disposition-notification');
/* The first part is a human readable message. */
$part_one = new Horde_Mime_Part();
$part_one->setType('text/plain');
$part_one->setCharset($opts['charset']);
if ($type == 'displayed') {
$contents = sprintf(Horde_Mime_Translation::t("The message sent on %s to %s with subject \"%s\" has been displayed.\n\nThis is no guarantee that the message has been read or understood."), $this->_headers->getValue('Date'), $this->_headers->getValue('To'), $this->_headers->getValue('Subject'));
$flowed = new Horde_Text_Flowed($contents, $opts['charset']);
$flowed->setDelSp(true);
$part_one->setContentTypeParameter('format', 'flowed');
$part_one->setContentTypeParameter('DelSp', 'Yes');
$part_one->setContents($flowed->toFlowed());
}
// TODO: Messages for other notification types.
$msg->addPart($part_one);
/* The second part is a machine-parseable description. */
$part_two = new Horde_Mime_Part();
$part_two->setType('message/disposition-notification');
$part_two_text = array('Reporting-UA: ' . $name . '; ' . $ua . "\n");
if (!empty($orig_recip)) {
$part_two_text[] = 'Original-Recipient: rfc822;' . $orig_recip . "\n";
}
if ($opts['from_addr']) {
$part_two_text[] = 'Final-Recipient: rfc822;' . $opts['from_addr'] . "\n";
}
if (!empty($msg_id)) {
$part_two_text[] = 'Original-Message-ID: rfc822;' . $msg_id . "\n";
}
$part_two_text[] = $dispo . "\n";
if (in_array('error', $mod) && isset($err['error'])) {
$part_two_text[] = 'Error: ' . $err['error'] . "\n";
}
$part_two->setContents($part_two_text);
$msg->addPart($part_two);
/* The third part is the text of the original message. RFC 3798 [3]
* allows us to return only a portion of the entire message - this
* is left up to the user. */
$part_three = new Horde_Mime_Part();
$part_three->setType('message/rfc822');
$part_three_text = array($this->_headers->toString());
if (!empty($this->_msgtext)) {
$part_three_text[] = $part_three->getEOL() . $this->_msgtext;
}
$part_three->setContents($part_three_text);
$msg->addPart($part_three);
return $msg->send($to, $msg_headers, $mailer);
}
/**
* Add a MDN (read receipt) request headers to the Horde_Mime_Headers::
* object.
*
* @param string $to The address the receipt should be mailed to.
*/
public function addMdnRequestHeaders($to)
{
/* This is the RFC 3798 way of requesting a receipt. */
$this->_headers->addHeader(self::MDN_HEADER, $to);
}
}
|