Class IMP_Mailbox

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

Package: IMP
Category: Horde
Copyright: 2011-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Mailbox.php

Methods summary
`public static mixed`	# `get( mixed $mbox )` Shortcut to obtaining mailbox object(s). Shortcut to obtaining mailbox object(s). Parameters `$mbox` The full IMAP mailbox name(s). Returns `mixed` The IMP_Mailbox object(s).
`public static mixed`	# `getImapMboxOb( mixed $mbox )` Shortcut to obtaining Horde_Imap_Client_Mailbox object(s). Shortcut to obtaining Horde_Imap_Client_Mailbox object(s). Parameters `$mbox` The full IMAP mailbox name(s). Returns `mixed` The Horde_Imap_Client_Mailbox object(s).
`public static IMP_Mailbox`	# `getPref( mixed $pref )` Shortcut to obtaining a mailbox object from a preference name. Shortcut to obtaining a mailbox object from a preference name. Returns `IMP_Mailbox` The IMP_Mailbox object. Var string $pref The preference name.
`public`	# `__construct( mixed $mbox )` Constructor. Constructor. Throws `IMP_Exception` Var string $mbox The full IMAP mailbox name.
`public`	# `__toString( )`
`public`	# `__get( mixed $key )`
`public`	# `__set( mixed $key, mixed $value )`
`public boolean`	# `create( array $opts = array() )` Create this mailbox on the server. Create this mailbox on the server. Parameters `$opts` <p>Additional options: - special_use: (array) An array of special-use attributes to attempt to add to the mailbox. DEFAULT: NONE - subscribe: (boolean) Override preference value of subscribe.</p> Returns `boolean` True on success. Throws Horde_Exception
`public boolean`	# `delete( array $opts = array() )` Deletes mailbox. Deletes mailbox. Parameters `$opts` <p>Addtional options: - subfolders: (boolean) Delete all subfolders? DEFAULT: false - subfolders_only: (boolean) If deleting subfolders, delete only subfolders (not current mailbox)? DEFAULT: false</p> Returns `boolean` True on success.
`public boolean`	# `rename( string $new_name )` Rename this mailbox on the server. The subscription status remains the same. All subfolders will also be renamed. Rename this mailbox on the server. The subscription status remains the same. All subfolders will also be renamed. Parameters `$new_name` The new mailbox name (UTF-8). Returns `boolean` True on success
`public boolean`	# `subscribe( boolean $sub, array $opts = array() )` Subscribe/unsubscribe to an IMAP mailbox. Subscribe/unsubscribe to an IMAP mailbox. Parameters `$sub` True to subscribe, false to unsubscribe. `$opts` <p>Additional options: - subfolders: (boolean) If true, applies actions to all subfolders.</p> Returns `boolean` True on success.
`public`	# `filter( )` Runs filters on this mailbox. Runs filters on this mailbox.
`public boolean`	# `filterOnDisplay( )` Filters this mailbox if it is the INBOX and the filter on display pref is active. Filters this mailbox if it is the INBOX and the filter on display pref is active. Returns `boolean` True if filter() was called.
`public IMP_Search_Query`	# `getSearchOb( )` Return the search query object for this mailbox. Return the search query object for this mailbox. Returns `IMP_Search_Query` The search query object.
`public IMP_Indices`	# `getIndicesOb( mixed $in )` Return an indices object for this mailbox. Return an indices object for this mailbox. Parameters `$in` <p>Either a single UID, array of UIDs, or a Horde_Imap_Client_Ids object.</p> Returns `IMP_Indices` An indices object.
`public IMP_Prefs_Sort_Sortpref`	# `getSort( boolean $convert = false )` Return the sorting preference for this mailbox. Return the sorting preference for this mailbox. Parameters `$convert` Convert 'by' to a Horde_Imap_Client constant? Returns `IMP_Prefs_Sort_Sortpref` Sortpref object.
`public`	# `setSort( integer $by = null, integer $dir = null, boolean $delete = false )` Set the sorting preference for this mailbox. Set the sorting preference for this mailbox. Parameters `$by` The sort type. `$dir` The sort direction. `$delete` Delete the entry?
`public boolean`	# `hideDeletedMsgs( boolean $deleted = false )` Are deleted messages hidden in this mailbox? Are deleted messages hidden in this mailbox? Parameters `$deleted` <p>Return value is what should be done with deleted messages in general, as opposed to any deleted message in the mailbox.</p> Returns `boolean` True if deleted messages should be hidden.
`public`	# `setHideDeletedMsgs( boolean $value )` Sets the 'delhide' preference and clears necessary cached data. Sets the 'delhide' preference and clears necessary cached data. Parameters `$value` The value to set 'delhide' to.
`public IMP_Indices`	# `runSearchQuery( Horde_Imap_Client_Search_Query $query, integer $sortby = null, integer $sortdir = null )` 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. 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. Parameters `$query` The search query object. `$sortby` The sort criteria. `$sortdir` The sort directory. Returns `IMP_Indices` An indices object.
`public Horde_Url`	# `url( string\|Horde_Url $page, string $buid = null, boolean $encode = true )` Generate a URL using the current mailbox. Generate a URL using the current mailbox. Parameters `$page` Page name to link to. `$buid` The BUID to use on the linked page. `$encode` Encode the argument separator? Returns `Horde_Url` URL to $page with any necessary mailbox information added to the parameter list of the URL.
`public array`	# `urlParams( string $buid = null )` Returns list of URL parameters necessary to indicate current mailbox status. Returns list of URL parameters necessary to indicate current mailbox status. Parameters `$buid` The BUID to use on the linked page. Returns `array` The list of parameters needed to indicate the current mailbox status.
`public boolean`	# `equals( mixed $mbox )` Determines if this mailbox is equal to the given mailbox. Needed because directly comparing two mailbox objects may fail (the member variables may be different). Determines if this mailbox is equal to the given mailbox. Needed because directly comparing two mailbox objects may fail (the member variables may be different). Parameters `$mbox` The mailbox to compare to. Returns `boolean` True if the mailboxes are the same.
`public IMP_Indices`	# `fromBuids( IMP_Indices\|array $buids )` Create an indices object from a list of browser-UIDs. Create an indices object from a list of browser-UIDs. Parameters `$buids` Browser-UIDs. Returns `IMP_Indices` An indices object.
`public IMP_Indices`	# `toBuids( IMP_Indices $uids )` Create a BUID indices object from a list of UIDs. Create a BUID indices object from a list of UIDs. Parameters `$uids` UIDs. Returns `IMP_Indices` An indices object.
`public IMP_Mailbox`	# `createMailboxName( string $new )` Return the mailbox name to create given a submailbox name. Return the mailbox name to create given a submailbox name. Parameters `$new` The submailbox name (UTF-8). Returns `IMP_Mailbox` The mailbox to create.
`public static mixed`	# `formFrom( mixed $mbox )` Converts a mailbox string from a form representation. Needed because null characters (used for various internal non-IMAP mailbox representations) will not work in form elements. Converts a mailbox string from a form representation. Needed because null characters (used for various internal non-IMAP mailbox representations) will not work in form elements. Parameters `$mbox` The mailbox name(s). Returns `mixed` The mailbox object(s).
`public static mixed`	# `formTo( mixed $mbox )` Converts a mailbox string to a form representation. Needed because null characters (used for various internal non-IMAP mailbox representations) will not work in form elements. Converts a mailbox string to a form representation. Needed because null characters (used for various internal non-IMAP mailbox representations) will not work in form elements. Parameters `$mbox` The mailbox name(s). Returns `mixed` The converted mailbox string(s).
`public static array`	# `getSpecialMailboxes( )` Return the list of special mailboxes. Return the list of special mailboxes. Returns `array` A list of mailboxes, with the self::SPECIAL_* constants as keys and values containing the IMP_Mailbox objects or null if the mailbox doesn't exist (self::SPECIAL_SENT contains an array of objects).
`public static array`	# `getSpecialMailboxesSort( )` Return the list of sorted special mailboxes. Return the list of sorted special mailboxes. Returns `array` The list of sorted special mailboxes (IMP_Mailbox objects).
`public static string`	# `prefFrom( string $mbox )` Converts a mailbox name from a value stored in the preferences. Converts a mailbox name from a value stored in the preferences. Parameters `$mbox` The mailbox name as stored in a preference. Returns `string` The full IMAP mailbox name (UTF-8).
`public static string`	# `prefTo( string $mbox )` Converts a mailbox name to a value to be stored in a preference. Converts a mailbox name to a value to be stored in a preference. Parameters `$mbox` The full IMAP mailbox name (UTF-8). Returns `string` The value to store in a preference.

Constants summary
`string`	`MBOX_DRAFTS`	# `'drafts_folder'`
`string`	`MBOX_SENT`	# `'sent_mail_folder'`
`string`	`MBOX_SPAM`	# `'spam_folder'`
`string`	`MBOX_TEMPLATES`	# `'composetemplates_mbox'`
`string`	`MBOX_TRASH`	# `'trash_folder'`
`string`	`MBOX_USERSPECIAL`	# `'user_special'`
`string`	`SPECIAL_COMPOSETEMPLATES`	# `'composetemplates'`
`string`	`SPECIAL_DRAFTS`	# `'drafts'`
`string`	`SPECIAL_SENT`	# `'sent'`
`string`	`SPECIAL_SPAM`	# `'spam'`
`string`	`SPECIAL_TRASH`	# `'trash'`
`string`	`SPECIAL_USER`	# `'userspecial'`

Magic properties summary
`public string`	`$display` Display version of mailbox. Special mailboxes are replaced with localized strings and namespace information is removed.
`public string`	`$abbrev_label` Abbreviated version of $label - displays only the bare mailbox name (no parents).
`public boolean`	`$access_creatembox` Can sub mailboxes be created?
`public boolean`	`$access_deletembox` Can this mailbox be deleted?
`public boolean`	`$access_deletembox_acl` Can this mailbox be deleted according to ACL rules?
`public boolean`	`$access_deletemsgs` Can messages be deleted in this mailbox?
`public boolean`	`$access_empty` Can this mailbox be emptied?
`public boolean`	`$access_expunge` Can messages be expunged in this mailbox?
`public boolean`	`$access_filters` Is filtering available?
`public boolean`	`$access_flags` Are flags available?
`public boolean`	`$access_search` Is searching available?
`public boolean`	`$access_sort` Is sorting available?
`public boolean`	`$access_sortthread` Is thread sort available?
`public mixed`	`$acl` Either an ACL object for the mailbox, or null if no ACL found for the mailbox.
`public string`	`$basename` The basename of the mailbox (UTF-8).
`public string`	`$cacheid` Cache ID for the mailbox.
`public string`	`$cacheid_date` Cache ID for the mailbox, with added data information.
`public boolean`	`$children` Does the element have children?
`public boolean`	`$container` Is this a container element?
`public string`	`$display_html` $display that has been HTML encoded.
`public boolean`	`$drafts` Is this a Drafts mailbox?
`public boolean`	`$editquery` Can this search query be edited?
`public boolean`	`$editvfolder` Can this virtual folder be edited?
`public boolean`	`$exists` Does this mailbox exist on the IMAP server?
`public string`	`$form_to` Converts this mailbox to a form representation.
`public object`	`$icon` Icon information for the mailbox. Properties: - alt: (string) The alt text for the icon. - class: (string) The CSS class name. - icon: (Horde_Themes_Image) The icon graphic to use. - iconopen: (Horde_Themes_Image) The openicon to use. - user_icon: (boolean) Use a user defined icon?
`public IMP_Imap`	`$imp_imap` The IMP_Imap object for this mailbox.
`public string`	`$imap_mbox` The actual name of the underlying IMAP mailbox.
`public Horde_Imap_Client_Mailbox`	`$imap_mbox_ob` Convert this object tp an Imap_Client mailbox object.
`public boolean`	`$inbox` Is this the INBOX?
`public boolean`	`$innocent_show` Show the innocent action in this mailbox?
`public boolean`	`$invisible` Is this mailbox invisible?
`public boolean`	`$is_imap` Is this an IMAP mailbox?
`public boolean`	`$is_open` Is this level expanded?
`public string`	`$label` The mailbox label. Essentially is $display that can be modified by user hook.
`public integer`	`$level` The child level of this element.
`public IMP_Mailbox_List`	`$list_ob` Returns the List object for the mailbox.
`public string`	`$namespace` Is this a namespace element?
`public IMP_Mailbox`	`$namespace_append` The mailbox with necessary namespace information appended.
`public string`	`$namespace_delimiter` The delimiter for this namespace.
`public Horde_Imap_Client_Data_Namespace`	`$namespace_info` Namespace info.
`public boolean`	`$nonimap` Is this a non-IMAP element?
`public IMP_Mailbox`	`$parent` The parent element. Returns null if no parent. (Base of tree is returned as a special element).
`public string`	`$parent_imap` The IMAP parent name.
`public IMP_Imap_PermanentFlags`	`$permflags` Return the list of permanent flags available to set in the mailbox.
`public boolean`	`$polled` Show polled information?
`public object`	`$poll_info` Poll information for the mailbox. Properties: - msgs: (integer) The number of total messages in the element, if polled. - recent: (integer) The number of new messages in the element, if polled. - unseen: (integer) The number of unseen messages in the element, if polled.
`public string`	`$pref_from` Convert mailbox name from preference storage.
`public string`	`$pref_to` Convert mailbox name to preference storage.
`public boolean`	`$query` Is this a search query?
`public boolean`	`$readonly` Is this mailbox read-only?
`public boolean`	`$remote` Is this a remote element?
`public IMP_Remote_Account`	`$remote_account` Return the account object for this element (null if not a remote element).
`public boolean`	`$remote_container` Is this mailbox a remote special element?
`public boolean`	`$remote_mbox` Is this mailbox on a remote server?
`public boolean`	`$search` Is this a search mailbox?
`public string`	`$size` Human readable size of the mailbox.
`public IMP_Prefs_Sort`	`$sortob` Sort ob for use with this mailbox.
`public boolean`	`$spam` Is this a Spam mailbox?
`public boolean`	`$spam_show` Show the spam action in this mailbox?
`public boolean`	`$special` Is this is a "special" element?
`public boolean`	`$special_outgoing` Is this a "special" element dealing with outgoing messages?
`public boolean`	`$specialvfolder` Is this a "special" virtual folder?
`public boolean`	`$sub` Is this mailbox subscribed to?
`public array`	`$subfolders` Returns the list of subfolders as mailbox objects (including the current mailbox).
`public array`	`$subfolders_only` Returns the list of subfolders as mailbox objects (NOT including the current mailbox).
`public boolean`	`$systemquery` Is this a system (built-in) search query?
`public boolean`	`$templates` Is this a Templates mailbox?
`public boolean`	`$trash` Is this a Trash mailbox?
`public IMP_Ftree_Element`	`$tree_elt` The tree element (null if it doesn't exist in the tree).
`public string`	`$uidvalid` Returns the UIDVALIDITY string. Throws an IMP_Exception on error.
`public string`	`$utf7imap` The UTF7-IMAP representation of this object.
`public string`	`$value` The value of this element (IMAP mailbox name; UTF-8).
`public boolean`	`$vfolder` Is this a virtual folder?
`public boolean`	`$vfolder_container` Is this the virtual folder container?
`public boolean`	`$vinbox` Is this the virtual inbox?
`public boolean`	`$vtrash` Is this the virtual trash?

Packages

Classes

Interfaces

Class IMP_Mailbox

Parameters

Returns

Parameters

Returns

Returns

Var

Throws

Var

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns