Class IMP_Maillog

Description

The IMP_Maillog:: class contains all functions related to handling logging of responses to individual e-mail messages.

$Horde: imp/lib/Maillog.php,v 1.15.10.16 2009/01/06 15:24:04 jan Exp $

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

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

Located in /lib/Maillog.php (line 19)


	
			
Method Summary
 void deleteLog (mixed $msg_ids)
 void displayLog (string $msg_id)
 DataTreeObject &getLog (string $msg_id)
 void log (string $type, mixed $msg_ids, [string $data = null])
 boolean sentMDN (string $msg_id, string $type)
Methods
deleteLog (line 159)

Delete the log entries for a given list of Message-IDs.

void deleteLog (mixed $msg_ids)
  • mixed $msg_ids: Either a single Message-ID or an array of Message-IDs to delete.
displayLog (line 117)

Retrieve any history for the given Message-ID and display via the Horde notification system.

void displayLog (string $msg_id)
  • string $msg_id: The Message-ID of the message.
getLog (line 80)

Retrieve any history for the given Message-ID.

  • return: The DataTreeObject object containing the log information, or PEAR_Error on error.
DataTreeObject &getLog (string $msg_id)
  • string $msg_id: The Message-ID of the message.
log (line 32)

Create a log entry.

void log (string $type, mixed $msg_ids, [string $data = null])
  • string $type: Either 'forward', 'redirect', 'reply', or 'mdn'.
  • mixed $msg_ids: Either a single Message-ID or an array of Message-IDs to log.
  • string $data: Any additional data to store. For 'forward' and 'redirect' this is the list of recipients the message was sent to. For 'mdn' this is the MDN-type of the message that was sent.
sentMDN (line 97)

Determines if an MDN notification of a certain type has been sent previously for this message-ID.

  • return: True if a MDN has been sent for this message with the given type.
boolean sentMDN (string $msg_id, string $type)
  • string $msg_id: The Message-ID of the message.
  • string $type: The type of MDN.

Documentation generated on Sun, 30 Jan 2011 05:28:14 +0000 by phpDocumentor 1.4.3