PHP Class IMP_Contents_Message, horde

Author: Michael Slusarz ([email protected])
ファイルを表示 Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$contents IMP_Contents Contents object.
$headersUsed array The list of headers used by this class.

Protected Properties

Property Type Description
$_cache array Cached values.
$_envelope Horde_Imap_Client_Data_Envelope Envelope object.
$_headers Horde_Mime_Headers Header information.
$_indices IMP_Indices Indices object.
$_peek boolean Don't seen seen flag?

Public Methods

Method Description
__construct ( IMP_Indices $indices, boolean $peek = false ) Constructor.
addChangedFlag ( ) Add changed flag information to the AJAX queue output, if necessary.
getAddressHeader ( mixed $header, integer $limit = 50 ) : array Return data to build an address header.
getDateOb ( ) : mixed Return date data.
getInlineOutput ( string $mimeid = null ) : array Get the inline display output for a message.
getResentData ( ) : array Return resent message data.
getSaveAs ( ) : Horde_Url Return the save link for the message source.
getSubject ( ) : array Return subject header data.
getUserHeaders ( ) : array Get the user-specified headers.
showMessage ( ) : array Create the object used to display the message.

Protected Methods

Method Description
_formatSummary ( array $summary, boolean $atc = false ) : string Prints out a MIME summary (in HTML).
_getInlineOutput ( array $options ) : array Generate inline message display.
_loadHeaders ( ) Loads the MIME headers object internally.

Method Details

__construct() public method

Constructor.
public __construct ( IMP_Indices $indices, boolean $peek = false )
$indices IMP_Indices The index of the message.
$peek boolean Don't set seen flag?

_formatSummary() protected method

Prints out a MIME summary (in HTML).
protected _formatSummary ( array $summary, boolean $atc = false ) : string
$summary array Summary information.
$atc boolean Is this an attachment?
return string The formatted summary string.

_getInlineOutput() protected method

Generate inline message display.
protected _getInlineOutput ( array $options ) : array
$options array Options: - mask: (integer) The mask needed for a getSummary() call. - mimeid: (string) Restrict output to this MIME ID (and children).
return array See getInlineOutput().

_loadHeaders() protected method

Loads the MIME headers object internally.
protected _loadHeaders ( )

addChangedFlag() public method

Add changed flag information to the AJAX queue output, if necessary.
public addChangedFlag ( )

getAddressHeader() public method

Return data to build an address header.
public getAddressHeader ( mixed $header, integer $limit = 50 ) : array
$header mixed The address header name (string) or a Horde_Mime_Rfc822_List object.
$limit integer Limit display to this many addresses. If null, shows all addresses.
return 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) 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() public method

Return date data.
public getDateOb ( ) : mixed
return mixed Either a IMP_Message_Date object or null if no date information is available.

getInlineOutput() public method

Get the inline display output for a message.
public getInlineOutput ( string $mimeid = null ) : array
$mimeid string Restrict output to this MIME ID (and children).
return array 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() public method

Return resent message data.
public getResentData ( ) : array
return array 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() public method

Return the save link for the message source.
public getSaveAs ( ) : Horde_Url
return Horde_Url URL for the save link.

getSubject() public method

Return subject header data.
public getSubject ( ) : array
return array 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() public method

Get the user-specified headers.
public getUserHeaders ( ) : array
return array The list of user-defined headers. Array of arrays with these keys:
  - name: (string) Header name.
  - value: (string) Header value.

showMessage() public method

Create the object used to display the message.
public showMessage ( ) : array
return array 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.

Property Details

$_cache protected_oe property

Cached values.
protected array $_cache
return array

$_envelope protected_oe property

Envelope object.
protected Horde_Imap_Client_Data_Envelope $_envelope
return Horde_Imap_Client_Data_Envelope

$_headers protected_oe property

Header information.
protected Horde_Mime_Headers $_headers
return Horde_Mime_Headers

$_indices protected_oe property

Indices object.
protected IMP_Indices $_indices
return IMP_Indices

$_peek protected_oe property

Don't seen seen flag?
protected bool $_peek
return boolean

$contents public_oe property

Contents object.
public IMP_Contents $contents
return IMP_Contents

$headersUsed public_oe static_oe property

The list of headers used by this class.
public static array $headersUsed
return array