Class IMP_Ui_Mailbox
The IMP_Ui_Mailbox:: class is designed to provide a place to store common
code shared among IMP's various UI views for the mailbox page.
Copyright 2006-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
|
|
public
array
|
#
getFrom( Horde_Imap_Client_Data_Envelope $ob, array $options = array() )
Get From address information for display on mailbox page.
Get From address information for display on mailbox page.
Parameters
- $ob
- An envelope object.
- $options
- <p>Additional options:
- fullfrom: (boolean) If true, returns 'fullfrom' information.
DEFAULT: false
- specialchars: (string) If set, run 'from' return through
htmlspecialchars() using the given charset.</p>
Returns
arrayAn array of information:
'error' - (boolean) True on error.
'from' - (string) The personal part of the From address.
'fullfrom' - (string) The full From address.
'to' - (boolean) True if this is who the message was sent to.
|
public
string
|
#
getSize( integer $size )
Get size display information.
Get size display information.
Parameters
- $size
- The size of the message, in bytes.
Returns
string
A formatted size string.
|
public
string
|
#
getDate( mixed $date, integer $format = 0 )
Formats the date header.
Parameters
- $date
- <p>The date object. Either a DateTime object or a
date string.</p>
- $format
- <p>Mask of formatting options:
- IMP_Ui_Mailbox::DATE_FORCE - Force use of date formatting, instead
of time formatting, for all dates.
- IMP_Ui_Mailbox::DATE_FULL - Use full representation of date,
including time information.</p>
Returns
string
The formatted date header.
|
public
string
|
#
getSubject( string $subject, string $htmlspaces = false )
Formats the subject header.
Formats the subject header.
Parameters
- $subject
- The MIME encoded subject header.
- $htmlspaces
- HTML-ize spaces?
Returns
string
The formatted subject header.
|