Documentation

IMP_Mailbox

in package

• IMP

This object is a clearinghouse for actions related to an IMP mailbox.

Tags

author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2011-2017 Horde LLC

license

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

Table of Contents

Constants

MBOX_DRAFTS  = 'drafts_folder'

MBOX_SENT  = 'sent_mail_folder'

MBOX_SPAM  = 'spam_folder'

MBOX_TEMPLATES  = 'composetemplates_mbox'

MBOX_TRASH  = 'trash_folder'

MBOX_USERSPECIAL  = 'user_special'

SPECIAL_COMPOSETEMPLATES  = 'composetemplates'

SPECIAL_DRAFTS  = 'drafts'

SPECIAL_SENT  = 'sent'

SPECIAL_SPAM  = 'spam'

SPECIAL_TRASH  = 'trash'

SPECIAL_USER  = 'userspecial'

Properties

$abbrev_label  : string

$access_creatembox  : bool

$access_deletembox  : bool

$access_deletembox_acl  : bool

$access_deletemsgs  : bool

$access_empty  : bool

$access_expunge  : bool

$access_filters  : bool

$access_flags  : bool

$access_search  : bool

$access_sort  : bool

$access_sortthread  : bool

$acl  : mixed

$basename  : string

$cacheid  : string

$cacheid_date  : string

$children  : bool

$container  : bool

$display  : string

$display_html  : string

$drafts  : bool

$editquery  : bool

$editvfolder  : bool

$exists  : bool

$form_to  : string

$icon  : object

$imap_mbox  : string

$imap_mbox_ob  : Horde_Imap_Client_Mailbox

$imp_imap  : IMP_Imap

$inbox  : bool

$innocent_show  : bool

$is_imap  : bool

$is_open  : bool

$label  : string

$level  : int

$list_ob  : IMP_Mailbox_List

$namespace  : string

$namespace_append  : IMP_Mailbox

$namespace_delimiter  : string

$namespace_info  : Horde_Imap_Client_Data_Namespace

$nonimap  : bool

$parent  : IMP_Mailbox

$parent_imap  : string

$permflags  : IMP_Imap_PermanentFlags

$poll_info  : object

$polled  : bool

$pref_from  : string

$pref_to  : string

$query  : bool

$readonly  : bool

$remote  : bool

$remote_account  : IMP_Remote_Account

$remote_container  : bool

$remote_mbox  : bool

$search  : bool

$size  : string

$sortob  : IMP_Prefs_Sort

$spam  : bool

$spam_show  : bool

$special  : bool

$special_outgoing  : bool

$specialvfolder  : bool

$sub  : bool

$subfolders  : array<string|int, mixed>

$subfolders_only  : array<string|int, mixed>

$systemquery  : bool

$templates  : bool

$trash  : bool

$tree_elt  : IMP_Ftree_Element

$uidvalid  : string

$value  : string

$vfolder  : bool

$vfolder_container  : bool

$vinbox  : bool

$vtrash  : bool

$_mbox  : string

The IMAP mailbox name (UTF-8).

Methods

__construct()  : mixed

Constructor.

__get()  : mixed

__set()  : mixed

__toString()  : mixed

create()  : bool

Create this mailbox on the server.

createMailboxName()  : IMP_Mailbox

Return the mailbox name to create given a submailbox name.

delete()  : bool

Deletes mailbox.

emptyMailbox()  : mixed

Empties the entire mailbox.

equals()  : bool

Determines if this mailbox is equal to the given mailbox.

expunge()  : IMP_Indices

Expunges all deleted messages.

filter()  : mixed

Runs filters on this mailbox.

filterOnDisplay()  : bool

Filters this mailbox if it is the INBOX and the filter on display pref is active.

flagAll()  : bool

Adds or removes flag(s) for all messages in the mailbox.

formFrom()  : mixed

Converts a mailbox string from a form representation.

formTo()  : mixed

Converts a mailbox string to a form representation.

fromBuids()  : IMP_Indices

Create an indices object from a list of browser-UIDs.

get()  : mixed

Shortcut to obtaining mailbox object(s).

getImapMboxOb()  : mixed

Shortcut to obtaining Horde_Imap_Client_Mailbox object(s).

getIndicesOb()  : IMP_Indices

Return an indices object for this mailbox.

getPref()  : IMP_Mailbox

Shortcut to obtaining a mailbox object from a preference name.

getSearchOb()  : IMP_Search_Query

Return the search query object for this mailbox.

getSort()  : IMP_Prefs_Sort_Sortpref

Return the sorting preference for this mailbox.

getSpecialMailboxes()  : array<string|int, mixed>

Return the list of special mailboxes.

getSpecialMailboxesSort()  : array<string|int, mixed>

Return the list of sorted special mailboxes.

hideDeletedMsgs()  : bool

Are deleted messages hidden in this mailbox?

prefFrom()  : string

Converts a mailbox name from a value stored in the preferences.

prefTo()  : string

Converts a mailbox name to a value to be stored in a preference.

rename()  : bool

Rename this mailbox on the server. The subscription status remains the same. All subfolders will also be renamed.

runSearchQuery()  : IMP_Indices

Run a search query on this mailbox that is not stored in the current session. Allows custom queries with custom sorts to be used without affecting cached mailboxes.

setHideDeletedMsgs()  : mixed

Sets the 'delhide' preference and clears necessary cached data.

setSort()  : mixed

Set the sorting preference for this mailbox.

subscribe()  : bool

Subscribe/unsubscribe to an IMAP mailbox.

toBuids()  : IMP_Indices

Create a BUID indices object from a list of UIDs.

url()  : Horde_Url

Generate a URL using the current mailbox.

urlParams()  : array<string|int, mixed>

Returns list of URL parameters necessary to indicate current mailbox status.

_getCacheID()  : string

Returns a unique identifier for this mailbox's status.

_getDisplay()  : string

If there is information available to tell us about a prefix in front of mailbox names that shouldn't be displayed to the user, then use it to strip that prefix out. Additionally, translate prefix text if this is a special mailbox.

_getIcon()  : object

Return icon information.

_onDelete()  : mixed

Do the necessary cleanup/cache updates when deleting mailboxes.