Class MIMP_Contents

Description

The MIMP_Contents:: class extends the IMP_Contents:: class and contains all functions related to handling the content and output of mail messages in MIMP.

$Horde: mimp/lib/MIME/Contents.php,v 1.48.2.4 2009/01/06 15:24:53 jan Exp $

Copyright 2002-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/MIME/Contents.php (line 20)

IMP_Contents
   |
   --MIMP_Contents
Method Summary
 boolean buildMessage ()
 string formatStatusMsg (mixed $msg, [string $img = null], [ $printable = true], [string $class = null], boolean $print)
 void getAttachments ( &$hb, Horde_Mobile_block $hb)
 string getMessage ()
 array partSummary (MIME_Part &$mime_part, [boolean $guess = false])
 string renderMIMEPart (MIME_Part &$mime_part)
 MIMP_Contents &singleton (mixed $in)
Methods
buildMessage (line 178)

Build the message deciding what MIME Parts to show.

  • return: False on error.
boolean buildMessage ()
formatStatusMsg (line 198)

Prints out the status message for a given MIME Part.

  • return: The formatted status message string.
string formatStatusMsg (mixed $msg, [string $img = null], [ $printable = true], [string $class = null], boolean $print)
  • mixed $msg: The message(s) to output.
  • string $img: NOT USED.
  • boolean $print: NOT USED.
  • string $class: NOT USED.
  • $printable
getAttachments (line 55)

Return the attachment list, in Horde_Mobile:: objects for header listing.

void getAttachments ( &$hb, Horde_Mobile_block $hb)
  • Horde_Mobile_block $hb: The Horde_Mobile_block object to add to.
  • &$hb
getMessage (line 75)

Return all viewable message parts (plain text, for Horde_Mobile:: to deal with).

  • return: The full message.
string getMessage ()
partSummary (line 106)

Returns an array summarizing a part of a MIME message.

  • return: See MIME_Contents::partSummary(). Ignores guessed parts.
array partSummary (MIME_Part &$mime_part, [boolean $guess = false])
  • MIME_Part &$mime_part: The MIME_Part to summarize.
  • boolean $guess: Is this a temporary guessed-type part?
renderMIMEPart (line 124)

Render a MIME Part.

  • return: The rendered data.
string renderMIMEPart (MIME_Part &$mime_part)
  • MIME_Part &$mime_part: A MIME_Part object.
singleton (line 36)

Attempts to return a reference to a concrete MIMP_Contents instance.

If an MIMP_Contents object is currently stored in the local cache, recreate that object. Else, create a new instance. Ensures that only one MIMP_Contents instance for any given message is available at any one time.

This method must be invoked as: $mimp_contents = &MIMP_Contents::singleton($in);

  • return: The MIMP_Contents object or null.
MIMP_Contents &singleton (mixed $in)
  • mixed $in: Either an index string or a MIME_Message object.

Documentation generated on Sun, 30 Jan 2011 05:32:52 +0000 by phpDocumentor 1.4.3