Documentation

IMP_Contents_Message
in package

Prepare details for viewing a message.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2005-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Properties

$contents  : IMP_Contents
Contents object.
$headersUsed  : array<string|int, mixed>
The list of headers used by this class.
$_cache  : array<string|int, mixed>
Cached values.
$_envelope  : Horde_Imap_Client_Data_Envelope
Envelope object.
$_headers  : Horde_Mime_Headers
Header information.
$_indices  : IMP_Indices
Indices object.
$_peek  : bool
Don't seen seen flag?

Methods

__construct()  : mixed
Constructor.
addChangedFlag()  : mixed
Add changed flag information to the AJAX queue output, if necessary.
getAddressHeader()  : array<string|int, mixed>
Return data to build an address header.
getDateOb()  : mixed
Return date data.
getInlineOutput()  : array<string|int, mixed>
Get the inline display output for a message.
getResentData()  : array<string|int, mixed>
Return resent message data.
getSaveAs()  : Horde_Url
Return the save link for the message source.
getSubject()  : array<string|int, mixed>
Return subject header data.
getUserHeaders()  : array<string|int, mixed>
Get the user-specified headers.
showMessage()  : array<string|int, mixed>
Create the object used to display the message.
_formatSummary()  : string
Prints out a MIME summary (in HTML).
_getInlineOutput()  : array<string|int, mixed>
Generate inline message display.
_loadHeaders()  : mixed
Loads the MIME headers object internally.

Properties

$headersUsed

The list of headers used by this class.

public static array<string|int, mixed> $headersUsed = array('resent-date', 'resent-from')

$_cache

Cached values.

protected array<string|int, mixed> $_cache = array()

$_envelope

Envelope object.

protected Horde_Imap_Client_Data_Envelope $_envelope

$_headers

Header information.

protected Horde_Mime_Headers $_headers

$_peek

Don't seen seen flag?

protected bool $_peek

Methods

__construct()

Constructor.

public __construct(IMP_Indices $indices[, bool $peek = false ]) : mixed
Parameters
$indices : IMP_Indices

The index of the message.

$peek : bool = false

Don't set seen flag?

addChangedFlag()

Add changed flag information to the AJAX queue output, if necessary.

public addChangedFlag() : mixed

getAddressHeader()

Return data to build an address header.

public getAddressHeader(mixed $header[, int $limit = 50 ]) : array<string|int, mixed>
Parameters
$header : mixed

The address header name (string) or a Horde_Mime_Rfc822_List object.

$limit : int = 50

Limit display to this many addresses. If null, shows all addresses.

Return values
array<string|int, mixed> —

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) Both: 'v' (full value)
  • limit: (integer) If limit was reached, the number of total addresses.
  • raw: (string) A raw string to display instead of addresses.

getDateOb()

Return date data.

public getDateOb() : mixed
Return values
mixed —

Either a IMP_Message_Date object or null if no date information is available.

getInlineOutput()

Get the inline display output for a message.

public getInlineOutput([string $mimeid = null ]) : array<string|int, mixed>
Parameters
$mimeid : string = null

Restrict output to this MIME ID (and children).

Return values
array<string|int, mixed> —

An array with the following keys:

  • atc_parts: (array) The list of attachment MIME IDs.
  • display_ids: (array) The list of display MIME IDs.
  • metadata: (array) A list of metadata.
  • msgtext: (string) The rendered HTML code.
  • one_part: (boolean) If true, the message only consists of one part.

getResentData()

Return resent message data.

public getResentData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of arrays, each sub-array representing a resent action and containing these keys:

  • date: (IMP_Message_Date) Date object of the resent action.
  • from: (Horde_Mail_Rfc822_List) Address object containing the address(es) that resent the message.

getSaveAs()

Return the save link for the message source.

public getSaveAs() : Horde_Url
Return values
Horde_Url —

URL for the save link.

getSubject()

Return subject header data.

public getSubject() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array with these possible keys:

  - subject: (string) The subject.
  - subjectlink: (string) The subject with linked URLs/email addresses
                 (if not present, is same as 'subject').
  - title: (string) The title of the page derived from the subject.

getUserHeaders()

Get the user-specified headers.

public getUserHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The list of user-defined headers. Array of arrays with these keys:

  - name: (string) Header name.
  - value: (string) Header value.

showMessage()

Create the object used to display the message.

public showMessage() : array<string|int, mixed>
Tags
throws
IMP_Exception
Return values
array<string|int, mixed> —

Array with the following keys:

  • atc: (object) Attachment information.
    • download: (string) The URL for the download all action.
    • label: (string) The attachment label.
    • list: (array) Attachment information.
  • md: (array) Metadata.
  • msgtext: (string) The text of the message.
  • onepart: (boolean) True if message only contains one part.

_formatSummary()

Prints out a MIME summary (in HTML).

protected _formatSummary(array<string|int, mixed> $summary[, bool $atc = false ]) : string
Parameters
$summary : array<string|int, mixed>

Summary information.

$atc : bool = false

Is this an attachment?

Return values
string —

The formatted summary string.

_getInlineOutput()

Generate inline message display.

protected _getInlineOutput(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed>

Options:

  • mask: (integer) The mask needed for a getSummary() call.
  • mimeid: (string) Restrict output to this MIME ID (and children).
Return values
array<string|int, mixed> —

See getInlineOutput().

_loadHeaders()

Loads the MIME headers object internally.

protected _loadHeaders() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results