PHPXRef 0.7.1 : Unnamed Project : Detail view of Mdn.php

(no description)

File Size:	257 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Horde_Mime_Mdn:: (6 methods):
  __construct()
  getMdnReturnAddr()
  userConfirmationNeeded()
  originalMessageText()
  generate()
  addMdnRequestHeaders()

Class: Horde_Mime_Mdn - X-Ref

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

Copyright 2004-2014 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.

__construct(Horde_Mime_Headers $headers) X-Ref

Constructor.

param: Horde_Mime_Headers $mime_headers A headers object.

getMdnReturnAddr() X-Ref

Returns the address to return the MDN to.

return: string The address to send the MDN to. Returns null if no

userConfirmationNeeded() X-Ref

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?

originalMessageText($text) X-Ref

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.

generate($action, $sending, $type, $name, $mailer,array $opts = array() X-Ref

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

param: boolean $action   Was this MDN type a result of a manual
param: boolean $sending  Was this MDN sent as a result of a manual
param: string $type      The type of action performed by the user.
param: string $name      The name of the local server.
param: Mail $mailer      A Mail driver.
param: array $opts       Additional options:
param: array $mod        The list of modifications. Per RFC 3798
param: array $err        If $mod is 'error', the additional

addMdnRequestHeaders($to) X-Ref

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

param: string $to The address the receipt should be mailed to.

PHP Cross Reference of Unnamed Project

/lib/horde/framework/Horde/Mime/ -> Mdn.php (summary)

Defines 1 class