Class Horde_Mime_Mdn

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

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Mime
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Mime/Mdn.php

Methods summary
`public`	# `__construct( Horde_Mime_Headers $headers )` Constructor. Constructor. Parameters `$headers` $mime_headers A headers object.
`public string`	# `getMdnReturnAddr( )` Returns the address to return the MDN to. Returns the address to return the MDN to. Returns `string` The address to send the MDN to. Returns null if no MDN is requested.
`public boolean`	# `userConfirmationNeeded( )` 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. 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. Returns `boolean` Is explicit user input required to send the MDN?
`public`	# `originalMessageText( string $text )` 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. 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. Parameters `$text` The text of the original message.
`public`	# `generate( boolean $action, boolean $sending, string $type, string $name, Mail $mailer, array $opts = array(), array $mod = array(), array $err = array() )` Generate the MDN according to the specifications listed in RFC 3798 [3]. Generate the MDN according to the specifications listed in RFC 3798 [3]. Parameters `$action` <p>Was this MDN type a result of a manual action on part of the user?</p> `$sending` <p>Was this MDN sent as a result of a manual action on part of the user?</p> `$type` The type of action performed by the user. <pre>Per RFC <span class="php-num">3798</span> [<span class="php-num">3.2.6.2</span>] the following types are valid: <span class="php-quote">'displayed'</span> <span class="php-quote">'deleted'</span></pre> `$name` The name of the local server. `$mailer` A Mail driver. `$opts` Additional options: <pre><span class="php-quote">'charset'</span> - (string) <span class="php-keyword1">Default</span> charset. <span class="php-keyword1">DEFAULT</span>: NONE <span class="php-quote">'from_addr'</span> - (string) From address. <span class="php-keyword1">DEFAULT</span>: NONE</pre> `$mod` The list of modifications. <pre>Per RFC <span class="php-num">3798</span> [<span class="php-num">3.2.6.3</span>] the following modifications are valid: <span class="php-quote">'error'</span></pre> `$err` <p>If $mod is 'error', the additional information to provide. Key is the type of modification, value is the text.</p> Throws `Horde_Mime_Exception`
`public`	# `addMdnRequestHeaders( string $to )` Add a MDN (read receipt) request headers to the Horde_Mime_Headers:: object. Add a MDN (read receipt) request headers to the Horde_Mime_Headers:: object. Parameters `$to` The address the receipt should be mailed to.

Constants summary
`string`	`MDN_HEADER`	# `'Disposition-Notification-To'`

Packages

Classes

Class Horde_Mime_Mdn

Parameters

Returns

Returns

Parameters

Parameters

Throws

Parameters