Class MIME_MDN

Description

The MIME_MDN:: class implements Message Disposition Notifications as described by RFC 3798.

$Horde: framework/MIME/MIME/MDN.php,v 1.4.10.14 2009/01/06 15:23:20 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /MIME/MIME/MDN.php (line 16)


	
			
Variable Summary
Method Summary
 MIME_MDN MIME_MDN ([MIME_Headers $mime_headers = null])
 void addMDNRequestHeaders (MIME_Headers &$headob, string $to)
 mixed generate (boolean $action, boolean $sending, string $type, [array $mod = array()], [array $err = array()])
 string getMDNReturnAddr ()
 void originalMessageText (string $text)
Variables
MIME_Headers $_headers (line 23)

The MIME_Headers object.

string $_msgtext = false (line 30)

The text of the original message.

Methods
Constructor MIME_MDN (line 37)

Constructor.

MIME_MDN MIME_MDN ([MIME_Headers $mime_headers = null])
addMDNRequestHeaders (line 243)

Add a MDN (read receipt) request headers to the MIME_Headers object.

void addMDNRequestHeaders (MIME_Headers &$headob, string $to)
  • MIME_Headers &$headob: The MIME_Headers object to add the headers to.
  • string $to: The address the receipt should be mailed to.
generate (line 140)

Generate the MDN according to the specifications listed in RFC 3798 [3].

  • return: True on success, PEAR_Error object on error.
mixed generate (boolean $action, boolean $sending, string $type, [array $mod = array()], [array $err = array()])
  • boolean $action: Was this MDN type a result of a manual action on part of the user?
  • boolean $sending: Was this MDN sent as a result of a manual action on part of the user?
  • string $type: The type of action performed by the user.
     Per RFC 3798 [3.2.6.2] the following types are valid:
     ====================================================
     'displayed'
     'deleted'
  • array $mod: The list of modifications.
     Per RFC 3798 [3.2.6.3] the following modifications are valid:
     ============================================================
     'error'
  • array $err: If $mod is 'error', the additional information to provide. Key is the type of modification, value is the text.
getMDNReturnAddr (line 49)

Returns the address to return the MDN to.

Returns null if no MDN is requested.

  • return: The address to send the MDN to. Returns null if no MDN is requested.
string getMDNReturnAddr ()
originalMessageText (line 108)

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.

void originalMessageText (string $text)
  • string $text: The text of the original message.
userConfirmationNeeded (line 63)

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: Is explicit user input required to send the MDN?
boolean userConfirmationNeeded ()

Documentation generated on Sun, 30 Jan 2011 05:19:33 +0000 by phpDocumentor 1.4.3