Class IMP

IMP Base Class.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: IMP
Category: Horde
License: GPL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at IMP.php

Methods summary
`public static string`	# `getViewMode( )` Returns the current view mode for IMP. Returns the current view mode for IMP. Returns `string` Either 'dimp', 'imp', 'mimp', or 'mobile'.
`public static boolean`	# `showAjaxView( )` Determines if we should display the ajax view based on a combination of user prefs and browser capabilities. Determines if we should display the ajax view based on a combination of user prefs and browser capabilities. Returns `boolean` A boolean indicating if we should show the ajax view.
`public static string`	# `addAddress( string $newAddress, string $newName )` Adds a contact to the user defined address book. Adds a contact to the user defined address book. Parameters `$newAddress` The contact's email address. `$newName` The contact's name. Returns `string` A link or message to show in the notification area. Throws Horde_Exception
`public static string`	# `flistSelect( array $options = array() )` Generates a select form input from a folder list. The <select> and </select> tags are NOT included in the output. Generates a select form input from a folder list. The <select> and </select> tags are NOT included in the output. Parameters `$options` <p>Optional parameters: - abbrev: (boolean) Abbreviate long mailbox names by replacing the middle of the name with '...'? DEFAULT: Yes - basename: (boolean) Use raw basename instead of abbreviated label? DEFAULT: false - filter: (array) An array of mailboxes to ignore. DEFAULT: Display all - heading: (string) The label for an empty-value option at the top of the list. DEFAULT: '' - inc_notepads: (boolean) Include user's editable notepads in list? DEFAULT: No - inc_tasklists: (boolean) Include user's editable tasklists in list? DEFAULT: No - inc_vfolder: (boolean) Include user's virtual folders in list? DEFAULT: No - new_folder: (boolean) Display an option to create a new folder? DEFAULT: No - selected: (string) The mailbox to have selected by default. DEFAULT: None</p> Returns `string` A string containing
`public static string`	# `getComposeArgs( )` Checks for To:, Subject:, Cc:, and other compose window arguments and pass back an associative array of those that are present. Checks for To:, Subject:, Cc:, and other compose window arguments and pass back an associative array of those that are present. Returns `string` An associative array with compose arguments.
`public static Horde_Url`	# `composeLink( mixed $args = array(), array $extra = array(), string $simplejs = false )` Returns the appropriate link to call the message composition script. Returns the appropriate link to call the message composition script. Parameters `$args` <p>List of arguments to pass to compose script. If this is passed in as a string, it will be parsed as a toaddress?subject=foo&cc=ccaddress (mailto-style) string.</p> `$extra` <p>Hash of extra, non-standard arguments to pass to compose script.</p> `$simplejs` <p>Use simple JS (instead of Horde.popup() JS function)?</p> Returns `Horde_Url` The link to the message composition script.
`public static string`	# `composeLinkSimpleCallback( Horde_Url $url )` Callback for Horde_Url when generating "simple" compose links. Simple links don't require exterior javascript libraries. Callback for Horde_Url when generating "simple" compose links. Simple links don't require exterior javascript libraries. Parameters `$url` URL object. Returns `string` URL string representation.
`public static string`	# `composeLinkJsCallback( Horde_Url $url )` Callback for Horde_Url when generating javascript compose links. Callback for Horde_Url when generating javascript compose links. Parameters `$url` URL object. Returns `string` URL string representation.
`public static string`	# `filterText( string $text )` Filters a string, if requested. Filters a string, if requested. Parameters `$text` The text to filter. Returns `string` The filtered text (if requested).
`public boolean`	# `hasPermission( string $permission, mixed $opts = array() )` Returns whether the specified permission is granted. Returns whether the specified permission is granted. Parameters `$permission` The permission to check. `$opts` $allowed The allowed permissions. Returns `boolean` Whether the specified permission is allowed.
`public static string`	# `menu( )` Build IMP's menu. Build IMP's menu. Returns `string` The menu output.
`public static`	# `status( )` Outputs IMP's status/notification bar. Outputs IMP's status/notification bar.
`public static`	# `quota( )` Outputs IMP's quota information. Outputs IMP's quota information.
`public static array`	# `quotaData( boolean $long = true )` Returns data needed to output quota. Returns data needed to output quota. Parameters `$long` Output long messages? Returns `array` Array with these keys: class, message, percent.
`public static mixed`	# `encryptList( string $default = null, boolean $returnList = false )` Return a list of valid encrypt HTML option tags. Return a list of valid encrypt HTML option tags. Parameters `$default` The default encrypt option. `$returnList` <p>Whether to return a hash with options instead of the options tag.</p> Returns `mixed` The list of option tags. This is empty if no encryption is available.
`public static`	# `setCurrentMailboxInfo( boolean $mbox = null )` Sets mailbox/index information for current page load. This information is accessible via IMP::$mailbox, IMP::$thismailbox, and IMP::$uid. Sets mailbox/index information for current page load. This information is accessible via IMP::$mailbox, IMP::$thismailbox, and IMP::$uid. Parameters `$mbox` Use this mailbox, instead of form data.
`public static Horde_Url`	# `selfUrl( )` Return a selfURL that has had index/mailbox/actionID information removed/altered based on an action that has occurred on the present page. Return a selfURL that has had index/mailbox/actionID information removed/altered based on an action that has occurred on the present page. Returns `Horde_Url` The self URL.
`public static boolean`	# `canCompose( )` Determine the status of composing. Determine the status of composing. Returns `boolean` Is compose allowed? Throws Horde_Exception
`public static array`	# `getAddressbookSearchParams( )` Determines parameters needed to do an address search Determines parameters needed to do an address search Returns `array` An array with two keys: 'fields' and 'sources'.
`public static string`	# `base64urlEncode( string $in )` Base64url (RFC 4648 [5]) encode a string. Base64url (RFC 4648 [5]) encode a string. Parameters `$in` Unencoded string. Returns `string` Encoded string.
`public static string`	# `base64urlDecode( string $in )` Base64url (RFC 4648 [5]) decode a string. Base64url (RFC 4648 [5]) decode a string. Parameters `$in` Encoded string. Returns `string` Decoded string.
`public static string`	# `numberFormat( integer $number, integer $decimals )` Workaround broken number_format() prior to PHP 5.4.0. Workaround broken number_format() prior to PHP 5.4.0. Parameters `$number` Number to format. `$decimals` Number of decimals to display. Returns `string` See number_format().

Constants summary
`string`	`ENCRYPT_NONE`	# `'encrypt_none'`
`integer`	`MAILBOX_START_FIRSTUNSEEN`	# `1`
`integer`	`MAILBOX_START_LASTUNSEEN`	# `2`
`integer`	`MAILBOX_START_FIRSTPAGE`	# `3`
`integer`	`MAILBOX_START_LASTPAGE`	# `4`
`string`	`NOTEPAD_EDIT`	# `"notepad\0"`
`string`	`TASKLIST_EDIT`	# `"tasklist\0"`
`string`	`INITIAL_FOLDERS`	# `"initial\0folders"`
`integer`	`IMAP_SORT_DATE`	# `100`

Properties summary
`public static string`	`$newUrl` Storage place for an altered version of the current URL. Storage place for an altered version of the current URL.	# `null`
`public static IMP_Mailbox`	`$mailbox` The current active mailbox (may be search mailbox). The current active mailbox (may be search mailbox).	#
`public static IMP_Mailbox`	`$thismailbox` The real IMAP mailbox of the current index. The real IMAP mailbox of the current index.	#
`public static integer`	`$uid` The IMAP UID. The IMAP UID.	# `''`

Packages

Classes

Class IMP

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns