PHP Class IMP, horde

Author: Chuck Hagenbuch ([email protected])
Author: Jon Parise ([email protected])
Author: Michael Slusarz ([email protected])
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
filterText ( string $text ) : string Filters a string, if requested.
getInitialPage ( ) : object Returns the initial page for IMP.
numberFormat ( integer $number, integer $decimals ) : string Workaround broken number_format() prior to PHP 5.4.0.
parseAddressList ( mixed $in, array $opts = [] ) : Horde_Mail_Rfc822_List Wrapper around Horde_Mail_Rfc822#parseAddressList(). Ensures all addresses have a default mail domain appended.
sizeFormat ( integer $size ) : string Get size display information.

Method Details

filterText() public static method

Filters a string, if requested.
public static filterText ( string $text ) : string
$text string The text to filter.
return string The filtered text (if requested).

getInitialPage() public static method

Returns the initial page for IMP.
public static getInitialPage ( ) : object
return object Object with the following properties: - mbox (IMP_Mailbox) - url (Horde_Url)

numberFormat() public static method

Workaround broken number_format() prior to PHP 5.4.0.
public static numberFormat ( integer $number, integer $decimals ) : string
$number integer Number to format.
$decimals integer Number of decimals to display.
return string See number_format().

parseAddressList() public static method

Wrapper around Horde_Mail_Rfc822#parseAddressList(). Ensures all addresses have a default mail domain appended.
public static parseAddressList ( mixed $in, array $opts = [] ) : Horde_Mail_Rfc822_List
$in mixed The address string or an address list object.
$opts array Options to override the default.
return Horde_Mail_Rfc822_List See Horde_Mail_Rfc822#parseAddressList().

sizeFormat() public static method

Get size display information.
public static sizeFormat ( integer $size ) : string
$size integer The byte size of data.
return string A formatted size string.