Documentation

IMP
in package

IMP base class.

Tags
author

Chuck Hagenbuch chuck@horde.org

author

Jon Parise jon@horde.org

author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

1999-2017 Horde LLC

license

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

Table of Contents

Constants

ENCRYPT_NONE  = 'encrypt_none'
IMAP_SORT_DATE  = 100
INITIAL_FOLDERS  = "initial\x00folders"
MAILBOX_START_FIRSTPAGE  = 3
MAILBOX_START_FIRSTUNSEEN  = 1
MAILBOX_START_LASTPAGE  = 4
MAILBOX_START_LASTUNSEEN  = 2

Methods

filterText()  : string
Filters a string, if requested.
getInitialPage()  : object
Returns the initial page for IMP.
numberFormat()  : string
Workaround broken number_format() prior to PHP 5.4.0.
parseAddressList()  : Horde_Mail_Rfc822_List
Wrapper around Horde_Mail_Rfc822#parseAddressList(). Ensures all addresses have a default mail domain appended.
sizeFormat()  : string
Get size display information.

Constants

ENCRYPT_NONE

public mixed ENCRYPT_NONE = 'encrypt_none'

IMAP_SORT_DATE

public mixed IMAP_SORT_DATE = 100

INITIAL_FOLDERS

public mixed INITIAL_FOLDERS = "initial\x00folders"

MAILBOX_START_FIRSTPAGE

public mixed MAILBOX_START_FIRSTPAGE = 3

MAILBOX_START_FIRSTUNSEEN

public mixed MAILBOX_START_FIRSTUNSEEN = 1

MAILBOX_START_LASTPAGE

public mixed MAILBOX_START_LASTPAGE = 4

MAILBOX_START_LASTUNSEEN

public mixed MAILBOX_START_LASTUNSEEN = 2

Methods

filterText()

Filters a string, if requested.

public static filterText(string $text) : string
Parameters
$text : string

The text to filter.

Return values
string

The filtered text (if requested).

getInitialPage()

Returns the initial page for IMP.

public static getInitialPage() : object
Return values
object

Object with the following properties:

  • mbox (IMP_Mailbox)
  • url (Horde_Url)

numberFormat()

Workaround broken number_format() prior to PHP 5.4.0.

public static numberFormat(int $number, int $decimals) : string
Parameters
$number : int

Number to format.

$decimals : int

Number of decimals to display.

Return values
string

See number_format().

parseAddressList()

Wrapper around Horde_Mail_Rfc822#parseAddressList(). Ensures all addresses have a default mail domain appended.

public static parseAddressList(mixed $in[, array<string|int, mixed> $opts = array() ]) : Horde_Mail_Rfc822_List
Parameters
$in : mixed

The address string or an address list object.

$opts : array<string|int, mixed> = array()

Options to override the default.

Tags
throws
Horde_Mail_Exception
Return values
Horde_Mail_Rfc822_List

See Horde_Mail_Rfc822#parseAddressList().

sizeFormat()

Get size display information.

public static sizeFormat(int $size) : string
Parameters
$size : int

The byte size of data.

Return values
string

A formatted size string.


        
On this page

Search results