Overview

Packages

IMP

Classes

Interfaces

Class IMP_Ajax_Application_ShowMessage

Message viewing action for AJAX application handler.

Package: IMP
Category: Horde
Copyright: 2005-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Ajax/Application/ShowMessage.php

Methods summary
`public`	# `__construct( IMP_Indices $indices, boolean $peek = false )` Constructor. Constructor. Parameters `$indices` The index of the message. `$peek` Don't set seen flag?
`public array`	# `showMessage( array $args )` Create the object used to display the message. Create the object used to display the message. Parameters `$args` <p>Configuration parameters: - headers: (array) The headers desired in the returned headers array (only used with non-preview view). - preview: (boolean) Is this the preview view?</p> Returns `array` Array with the following keys: - atc_download: The download all link - atc_label: The label to use for Attachments - atc_list: The list (HTML code) of attachments - bcc (FULL): The Bcc addresses - cc: The CC addresses - fulldate (FULL): The full canonical date. - from: The From addresses - headers (FULL): An array of headers (not including basic headers) - js: Javascript code to run on display - list_info (FULL): List information. - localdate (PREVIEW): The date formatted to the user's timezone - md: Metadata - msgtext: The text of the message - onepart: True if message only contains one part. - replyTo (FULL): The Reply-to addresses - save_as: The save link - subject: The subject - subjectlink: The subject with linked URLs/email addresses (defaults to 'subject') - title (FULL): The title of the page - to: The To addresses Throws `IMP_Exception`
`public array`	# `getAddressHeader( string $header, integer $limit = 50 )` Return data to build an address header. Return data to build an address header. Parameters `$header` The address header. `$limit` <p>Limit display to this many addresses. If null, shows all addresses.</p> Returns `array` An array with the following entries: - addr: (array) List of addresses/groups. Group keys: 'a' (list of addresses); 'g' (group name) Address keys: 'b' (bare address); 'p' (personal part) - limit: (integer) If limit was reached, the number of total addresses. - raw: (string) A raw string to display instead of addresses.