Docs For Class rcube

rcube_storage

Description

Abstract class for accessing mail messages storage server

author: Aleksander Machniak <[email protected]>
author: Thomas Bruederli <[email protected]>
version: 2.0
abstract:

Direct descendents

Class	Description
rcube_imap	Interface class for accessing an IMAP server

Class Constant Summary

ALREADYEXISTS = 6

CONTACTADMIN = 8

INUSE = 4

NONEXISTENT = 7

NOPERM = 1

OVERQUOTA = 5

READONLY = 2

TRYCREATE = 3

UNKNOWN = 0

Variable Summary

array $all_headers

mixed $conn

mixed $default_charset

mixed $default_folders

mixed $folder

mixed $options

mixed $page_size

mixed $search_set

mixed $threading

Method Summary

bool check_connection ()

boolean check_permflag (string $flag)

void clear_cache ([string $key = null], [boolean $prefix_mode = false])

boolean clear_folder ([string $folder = null])

void close ()

boolean connect (string $host, string $user, string $pass, [integer $port = 143], [string $use_ssl = null])

boolean copy_message (mixed $uids, string $to, [string $from = null])

int count ([string $folder = null], [string $mode = 'ALL'], [boolean $force = false], [boolean $status = true])

void create_default_folders ()

boolean create_folder (string $folder, [boolean $subscribe = false])

boolean delete_acl (string $folder, string $user)

boolean delete_folder (string $folder)

boolean delete_message (mixed $uids, [string $folder = null])

boolean delete_metadata (string $folder, array $entries)

void expunge_cache ()

boolean expunge_folder ([string $folder = null], [boolean $clear_cache = true])

boolean expunge_message (mixed $uids, [string $folder = null], [boolean $clear_cache = true])

array folder_attributes (string $folder, [bool $force = false])

array folder_data (string $folder)

boolean folder_exists (string $folder, [boolean $subscription = false])

array folder_info (string $folder)

string folder_namespace (string $folder)

int folder_size (string $folder)

int folder_status ([string $folder = null])

void folder_sync (string $folder)

array get_acl (string $folder)

string get_body (int $uid, [ $part = 1])

mixed get_cache (string $key)

mixed get_capability (string $cap)

int get_error_code ()

string get_error_str ()

string get_folder ()

string get_hierarchy_delimiter ()

object rcube_mail_header get_message (int $uid, [string $folder = null])

rcube_mail_header get_message_headers ( $uid, [string $folder = null], [bool $force = false], int $id)

string get_message_part (int $uid, [string $part = 1], [rcube_message_part $o_part = null], [mixed $print = null], [resource $fp = null], [boolean $skip_charset_conv = false])

array get_metadata (string $folder, array $entries, [array $options = array()])

array get_namespace ([string $name = null])

int get_page ()

int get_pagesize ()

mixed get_quota ()

string get_raw_body (int $uid, [resource $fp = null])

string get_raw_headers (int $uid)

int get_response_code ()

array get_search_set ()

mixed get_threading ()

rcube_result_index|rcube_result_thread index ([string $folder = null], [string $sort_field = null], [string $sort_order = null])

boolean is_connected ()

array list_folders ([string $root = ''], [string $name = '*'], [mixed $filter = null], [string $rights = null], [bool $skip_sort = false])

array list_folders_subscribed ([string $root = ''], [string $name = '*'], [string $filter = null], [string $rights = null], [bool $skip_sort = false])

array list_messages ([string $folder = null], [int $page = null], [string $sort_field = null], [string $sort_order = null], [int $slice = 0])

array list_rights (string $folder, string $user)

string mod_folder (string $folder, [string $mode = 'out'])

boolean move_message (mixed $uids, string $to, [string $from = null])

array my_rights (string $folder)

array parse_uids (mixed $uids)

void print_raw_body ( $uid)

array refresh_search ()

boolean rename_folder (string $folder, string $new_name)

int|bool save_message (string $folder, &$message, [string $headers = ''], [boolean $is_file = false], string $message)

void search ([string $folder = null], [string $str = 'ALL'], [string $charset = null], [string $sort_field = null])

rcube_result_index search_once ([string $folder = null], [string $str = 'ALL'])

boolean set_acl (string $folder, string $user, string $acl)

void set_charset (string $cs)

void set_debug ([boolean $dbg = true])

void set_default_folders (array $arr)

bool set_flag (mixed $uids, string $flag, [string $folder = null], [boolean $skip_cache = false])

void set_folder (string $folder)

boolean set_metadata (string $folder, array $entries)

void set_options (array $opt)

void set_page (int $page)

void set_pagesize (int $size)

void set_search_set (mixed $set)

mixed set_threading ([boolean $enable = false])

boolean subscribe (array $folders)

bool unset_flag (mixed $uids, string $flag, [string $folder = null])

boolean unsubscribe (array $folders)

Variables

array $all_headers = array(
'IN-REPLY-TO',
'BCC',
'MESSAGE-ID',
'CONTENT-TRANSFER-ENCODING',
'REFERENCES',
'X-DRAFT-INFO',
'MAIL-FOLLOWUP-TO',
'MAIL-REPLY-TO',
'RETURN-PATH',
) (line 60)

All (additional) headers used (in any way) by Roundcube Not listed here: DATE, FROM, TO, CC, REPLY-TO, SUBJECT, CONTENT-TYPE, LIST-POST (used for messages listing) are hardcoded in rcube_imap_generic::fetchHeaders()

access: protected

mixed $conn (line 43)

Instance of connection object e.g. rcube_imap_generic

access: public

Redefined in descendants as:

rcube_imap::$conn : Instance of rcube_imap_generic

mixed $default_charset = 'ISO-8859-1' (line 46)

access: protected

mixed $default_folders = array('INBOX') (line 47)

access: protected

mixed $folder = 'INBOX' (line 45)

access: protected

mixed $options = array('auth_method' => 'check') (line 49)

access: protected

Redefined in descendants as:

rcube_imap::$options

mixed $page_size = 10 (line 50)

access: protected

mixed $search_set (line 48)

access: protected

Redefined in descendants as:

rcube_imap::$search_set

mixed $threading = false (line 51)

access: protected

Redefined in descendants as:

rcube_imap::$threading

Methods

check_connection (line 116)

Check connection state, connect if not connected.

return: Connection state.
abstract:

bool check_connection ()

Redefined in descendants as:

rcube_imap::check_connection() : Check connection state, connect if not connected.

check_permflag (line 332)

Checks the PERMANENTFLAGS capability of the current folder and returns true if the given flag is supported by the server.

return: True if this flag is supported
abstract:

boolean check_permflag (string $flag)

string $flag: Permanentflag name

Redefined in descendants as:

rcube_imap::check_permflag() : Checks the PERMANENTFLAGS capability of the current folder and returns true if the given flag is supported by the IMAP server

clear_cache (line 971)

Clears the cache.

abstract:

void clear_cache ([string $key = null], [boolean $prefix_mode = false])

string $key: Cache key name or pattern
boolean $prefix_mode: Enable it to clear all keys starting with prefix specified in $key

Redefined in descendants as:

rcube_imap::clear_cache() : Clears the cache.

clear_folder (line 739)

Remove all messages in a folder..

return: True on success, False on error
access: public

boolean clear_folder ([string $folder = null])

string $folder: Folder name

close (line 100)

Close connection. Usually done on script shutdown

abstract:

void close ()

Redefined in descendants as:

rcube_imap::close() : Close IMAP connection.

connect (line 94)

Connect to the server

return: TRUE on success, FALSE on failure
abstract:

boolean connect (string $host, string $user, string $pass, [integer $port = 143], [string $use_ssl = null])

string $host: Host to connect
string $user: Username for IMAP account
string $pass: Password for IMAP account
integer $port: Port to connect to
string $use_ssl: SSL schema (either ssl or tls) or null if plain connection

Redefined in descendants as:

rcube_imap::connect() : Connect to an IMAP server

copy_message (line 575)

Copy message(s) from one mailbox to another.

return: True on success, False on error
abstract:

boolean copy_message (mixed $uids, string $to, [string $from = null])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $to: Target folder
string $from: Source folder

Redefined in descendants as:

rcube_imap::copy_message() : Copy a message from one folder to another

count (line 365)

Get messages count for a specific folder.

return: Number of messages
abstract:

int count ([string $folder = null], [string $mode = 'ALL'], [boolean $force = false], [boolean $status = true])

string $folder: Folder name
string $mode: Mode for count [ALL|THREADS|UNSEEN|RECENT]
boolean $force: Force reading from server and update cache
boolean $status: Enables storing folder status info (max UID/count), required for folder_status()

Redefined in descendants as:

rcube_imap::count() : Get message count for a specific folder

create_default_folders (line 843)

Create all folders specified as default

access: public

void create_default_folders ()

Redefined in descendants as:

rcube_imap::create_default_folders() : Create all folders specified as default

create_folder (line 694)

Create a new folder on the server.

return: True on success, False on error
abstract:

boolean create_folder (string $folder, [boolean $subscribe = false])

string $folder: New folder name
boolean $subscribe: True if the newvfolder should be subscribed

Redefined in descendants as:

rcube_imap::create_folder() : Create a new folder on the server and register it in local cache

delete_acl (line 891)

Removes any <identifier,rights> pair for the specified user from the ACL for the specified folder (DELETEACL).

return: True on success, False on failure
abstract:

boolean delete_acl (string $folder, string $user)

string $folder: Folder name
string $user: User name

Redefined in descendants as:

rcube_imap::delete_acl() : Removes any <identifier,rights> pair for the specified user from the ACL for the specified folder (DELETEACL)

delete_folder (line 715)

Remove a folder from the server.

return: True on success, False on error
abstract:

boolean delete_folder (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::delete_folder() : Remove folder from server

delete_message (line 586)

Mark message(s) as deleted and expunge.

return: True on success, False on error
abstract:

boolean delete_message (mixed $uids, [string $folder = null])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $folder: Source folder

Redefined in descendants as:

rcube_imap::delete_message() : Mark messages as deleted and expunge them

delete_metadata (line 945)

Unsets metadata/annotations (SETMETADATA/SETANNOTATION)

return: True on success, False on failure
abstract:

boolean delete_metadata (string $folder, array $entries)

string $folder: Folder name (empty for server metadata)
array $entries: Entry names array

Redefined in descendants as:

rcube_imap::delete_metadata() : Unsets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)

expunge_cache (line 985)

Delete outdated cache entries

abstract:

void expunge_cache ()

Redefined in descendants as:

rcube_imap::expunge_cache() : Delete outdated cache entries

expunge_folder (line 726)

Send expunge command and clear the cache.

return: True on success, False on error
access: public

boolean expunge_folder ([string $folder = null], [boolean $clear_cache = true])

string $folder: Folder name
boolean $clear_cache: False if cache should not be cleared

expunge_message (line 598)

Expunge message(s) and clear the cache.

return: True on success, False on error
abstract:

boolean expunge_message (mixed $uids, [string $folder = null], [boolean $clear_cache = true])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $folder: Folder name
boolean $clear_cache: False if cache should not be cleared

Redefined in descendants as:

rcube_imap::expunge_message() : Send IMAP expunge command and clear cache

folder_attributes (line 784)

Gets folder attributes (from LIST response, e.g. \Noselect, \Noinferiors).

return: Options list
abstract:

array folder_attributes (string $folder, [bool $force = false])

string $folder: Folder name
bool $force: Set to True if attributes should be refreshed

Redefined in descendants as:

rcube_imap::folder_attributes() : Gets folder attributes from LIST response, e.g. \Noselect, \Noinferiors

folder_data (line 795)

Gets connection (and current folder) data: UIDVALIDITY, EXISTS, RECENT, PERMANENTFLAGS, UIDNEXT, UNSEEN

return: Data
abstract:

array folder_data (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_data() : Gets connection (and current folder) data: UIDVALIDITY, EXISTS, RECENT, PERMANENTFLAGS, UIDNEXT, UNSEEN

folder_exists (line 753)

Checks if folder exists and is subscribed

return: True if folder exists, False otherwise
abstract:

boolean folder_exists (string $folder, [boolean $subscription = false])

string $folder: Folder name
boolean $subscription: Enable subscription checking

Redefined in descendants as:

rcube_imap::folder_exists() : Checks if folder exists and is subscribed

folder_info (line 805)

Returns extended information about the folder.

return: Data
abstract:

array folder_info (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_info() : Returns extended information about the folder

folder_namespace (line 773)

Returns the namespace where the folder is in

return: One of 'personal', 'other' or 'shared'
abstract:

string folder_namespace (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_namespace() : Returns the namespace where the folder is in

folder_size (line 763)

Get folder size (size of all messages in a folder)

return: Folder size in bytes, False on error
abstract:

int folder_size (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_size() : Get folder size (size of all messages in a folder)

folder_status (line 815)

Returns current status of a folder

return: Folder status
abstract:

int folder_status ([string $folder = null])

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_status() : Returns current status of folder

folder_sync (line 823)

Synchronizes messages cache.

abstract:

void folder_sync (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::folder_sync() : Synchronizes messages cache.

get_acl (line 901)

Returns the access control list for a folder (GETACL).

return: User-rights array on success, NULL on error
abstract:

array get_acl (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::get_acl() : Returns the access control list for folder (GETACL)

get_body (line 477)

Fetch message body of a specific message from the server

return: Message/part body
see: rcube_imap::get_message_part()
access: public

string get_body (int $uid, [ $part = 1])

int $uid: Message UID
$part

get_cache (line 980)

Returns cached value

return: Cached value
abstract:

mixed get_cache (string $key)

string $key: Cache key

Redefined in descendants as:

rcube_imap::get_cache() : Returns cached value

get_capability (line 287)

Returns the storage server's (IMAP) capability

return: Capability value or TRUE if supported, FALSE if not
abstract:

mixed get_capability (string $cap)

string $cap: Capability name

Redefined in descendants as:

rcube_imap::get_capability() : Returns the IMAP server's capability.

get_error_code (line 124)

Returns code of last error

return: Error code
abstract:

int get_error_code ()

Redefined in descendants as:

rcube_imap::get_error_code() : Returns code of last error

get_error_str (line 132)

Returns message of last error

return: Error message
abstract:

string get_error_str ()

Redefined in descendants as:

rcube_imap::get_error_str() : Returns text of last error

get_folder (line 214)

Returns the currently used folder name

return: Name of the folder
access: public

string get_folder ()

get_hierarchy_delimiter (line 341)

Returns the delimiter that is used by the server for folder hierarchy separation.

return: Delimiter string
abstract:

string get_hierarchy_delimiter ()

Redefined in descendants as:

rcube_imap::get_hierarchy_delimiter() : Returns the delimiter that is used by the IMAP server for folder separation

get_message (line 439)

Fetch message headers and body structure from the server and build an object structure similar to the one generated by PEAR::Mail_mimeDecode

return: Message data
abstract:

object rcube_mail_header get_message (int $uid, [string $folder = null])

int $uid: Message UID to fetch
string $folder: Folder to read from

Redefined in descendants as:

rcube_imap::get_message() : Fetch message headers and body structure from the IMAP server and build an object structure similar to the one generated by PEAR::Mail_mimeDecode

get_message_headers (line 451)

Return message headers object of a specific message

return: Message headers
abstract:

rcube_mail_header get_message_headers ( $uid, [string $folder = null], [bool $force = false], int $id)

int $id: Message sequence ID or UID
string $folder: Folder to read from
bool $force: True to skip cache
$uid

Redefined in descendants as:

rcube_imap::get_message_headers() : Return message headers object of a specific message

get_message_part (line 466)

Fetch message body of a specific message from the server

return: Message/part body if not printed
abstract:

string get_message_part (int $uid, [string $part = 1], [rcube_message_part $o_part = null], [mixed $print = null], [resource $fp = null], [boolean $skip_charset_conv = false])

int $uid: Message UID
string $part: Part number
rcube_message_part $o_part: Part object created by get_structure()
mixed $print: True to print part, ressource to write part contents in
resource $fp: File pointer to save the message part
boolean $skip_charset_conv: Disables charset conversion

Redefined in descendants as:

rcube_imap::get_message_part() : Fetch message body of a specific message from the server

get_metadata (line 957)

Returns folder metadata/annotations (GETMETADATA/GETANNOTATION).

return: Metadata entry-value hash array on success, NULL on error
abstract:

array get_metadata (string $folder, array $entries, [array $options = array()])

string $folder: Folder name (empty for server metadata)
array $entries: Entries
array $options: Command options (with MAXSIZE and DEPTH keys)

Redefined in descendants as:

rcube_imap::get_metadata() : Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION)

get_namespace (line 351)

Get namespace

return: Namespace data
abstract:

array get_namespace ([string $name = null])

string $name: Namespace array index: personal, other, shared, prefix

Redefined in descendants as:

rcube_imap::get_namespace() : Get namespace

get_page (line 236)

Gets internal list page number.

return: Page number
access: public

int get_page ()

get_pagesize (line 258)

Get internal page size

return: Number of messages to display on one page
access: public

int get_pagesize ()

get_quota (line 862)

Get mailbox quota information.

return: Quota info or False if not supported
abstract:

mixed get_quota ()

Redefined in descendants as:

rcube_imap::get_quota() : Get mailbox quota information added by Nuny

get_raw_body (line 493)

Returns the whole message source as string (or saves to a file)

return: Message source string
abstract:

string get_raw_body (int $uid, [resource $fp = null])

int $uid: Message UID
resource $fp: File pointer to save the message

Redefined in descendants as:

rcube_imap::get_raw_body() : Returns the whole message source as string (or saves to a file)

get_raw_headers (line 503)

Returns the message headers as string

return: Message headers string
abstract:

string get_raw_headers (int $uid)

int $uid: Message UID

Redefined in descendants as:

rcube_imap::get_raw_headers() : Returns the message headers as string

get_response_code (line 140)

Returns code of last command response

return: Response code (class constant)
abstract:

int get_response_code ()

Redefined in descendants as:

rcube_imap::get_response_code() : Returns code of last command response

get_search_set (line 277)

Return the saved search set.

return: Search set in driver specific format, NULL if search wasn't initialized
abstract:

array get_search_set ()

Redefined in descendants as:

rcube_imap::get_search_set() : Return the saved search set as hash array

get_threading (line 318)

Get current threading flag.

return: Threading algorithm or False if THREAD is not supported or disabled
access: public

mixed get_threading ()

index (line 391)

Return sorted list of message UIDs

return: List of messages (UIDs)
abstract:

rcube_result_index|rcube_result_thread index ([string $folder = null], [string $sort_field = null], [string $sort_order = null])

string $folder: Folder to get index from
string $sort_field: Sort column
string $sort_order: Sort order [ASC, DESC]

Redefined in descendants as:

rcube_imap::index() : Return sorted list of message UIDs

is_connected (line 108)

Checks connection state.

return: TRUE on success, FALSE on failure
abstract:

boolean is_connected ()

Redefined in descendants as:

rcube_imap::is_connected() : Checks IMAP connection.

list_folders (line 663)

Get a list of all folders available on the server.

return: Indexed array with folder names
abstract:

array list_folders ([string $root = ''], [string $name = '*'], [mixed $filter = null], [string $rights = null], [bool $skip_sort = false])

string $root: IMAP root dir
string $name: Optional name pattern
mixed $filter: Optional filter
string $rights: Optional ACL requirements
bool $skip_sort: Enable to return unsorted list (for better performance)

Redefined in descendants as:

rcube_imap::list_folders() : Get a list of all folders available on the server

list_folders_subscribed (line 649)

Get a list of subscribed folders.

return: List of folders
abstract:

array list_folders_subscribed ([string $root = ''], [string $name = '*'], [string $filter = null], [string $rights = null], [bool $skip_sort = false])

string $root: Optional root folder
string $name: Optional name pattern
string $filter: Optional filter
string $rights: Optional ACL requirements
bool $skip_sort: Enable to return unsorted list (for better performance)

Redefined in descendants as:

rcube_imap::list_folders_subscribed() : Public method for listing subscribed folders.

list_messages (line 379)

Public method for listing headers.

return: Indexed array with message header objects
abstract:

array list_messages ([string $folder = null], [int $page = null], [string $sort_field = null], [string $sort_order = null], [int $slice = 0])

string $folder: Folder name
int $page: Current page to list
string $sort_field: Header field to sort by
string $sort_order: Sort order [ASC|DESC]
int $slice: Number of slice items to extract from result array

Redefined in descendants as:

rcube_imap::list_messages() : Public method for listing headers

list_rights (line 913)

Returns information about what rights can be granted to the user (identifier) in the ACL for the folder (LISTRIGHTS).

return: List of user rights
abstract:

array list_rights (string $folder, string $user)

string $folder: Folder name
string $user: User name

Redefined in descendants as:

rcube_imap::list_rights() : Returns information about what rights can be granted to the user (identifier) in the ACL for the folder (LISTRIGHTS)

mod_folder (line 837)

Modify folder name according to namespace.

For output it removes prefix of the personal namespace if it's possible. For input it adds the prefix. Use it before creating a folder in root of the folders tree.

return: Folder name
abstract:

string mod_folder (string $folder, [string $mode = 'out'])

string $folder: Folder name
string $mode: Mode name (out/in)

Redefined in descendants as:

rcube_imap::mod_folder() : Modify folder name according to namespace.

move_message (line 563)

Move message(s) from one folder to another.

return: True on success, False on error
abstract:

boolean move_message (mixed $uids, string $to, [string $from = null])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $to: Target folder
string $from: Source folder

Redefined in descendants as:

rcube_imap::move_message() : Move a message from one folder to another

my_rights (line 923)

Returns the set of rights that the current user has to a folder (MYRIGHTS).

return: MYRIGHTS response on success, NULL on error
abstract:

array my_rights (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::my_rights() : Returns the set of rights that the current user has to folder (MYRIGHTS)

parse_uids (line 608)

Parse message UIDs input

return: Two elements array with UIDs converted to list and ALL flag
access: protected

array parse_uids (mixed $uids)

mixed $uids: UIDs array or comma-separated list or '*' or '1:*'

print_raw_body (line 509)

Sends the whole message source to stdout

abstract:

void print_raw_body ( $uid)

$uid

Redefined in descendants as:

rcube_imap::print_raw_body() : Sends the whole message source to stdout

refresh_search (line 423)

Refresh saved search set

return: Current search set
abstract:

array refresh_search ()

Redefined in descendants as:

rcube_imap::refresh_search() : Refresh saved search set

rename_folder (line 705)

Set a new name to an existing folder

return: True on success, False on error
abstract:

boolean rename_folder (string $folder, string $new_name)

string $folder: Folder to rename
string $new_name: New folder name

Redefined in descendants as:

rcube_imap::rename_folder() : Set a new name to an existing folder

save_message (line 551)

Append a mail message (source) to a specific folder.

return: Appended message UID or True on success, False on error
abstract:

int|bool save_message (string $folder, &$message, [string $headers = ''], [boolean $is_file = false], string $message)

string $folder: Target folder
string $message: The message source string or filename
string $headers: Headers string if $message contains only the body
boolean $is_file: True if $message is a filename
&$message

Redefined in descendants as:

rcube_imap::save_message() : Append a mail message (source) to a specific folder

search (line 404)

Invoke search request to the server.

abstract:

void search ([string $folder = null], [string $str = 'ALL'], [string $charset = null], [string $sort_field = null])

string $folder: Folder name to search in
string $str: Search criteria
string $charset: Search charset
string $sort_field: Header field to sort by

Redefined in descendants as:

rcube_imap::search() : Invoke search request to IMAP server

search_once (line 415)

Direct (real and simple) search request (without result sorting and caching).

return: Search result (UIDs)
abstract:

rcube_result_index search_once ([string $folder = null], [string $str = 'ALL'])

string $folder: Folder name to search in
string $str: Search string

Redefined in descendants as:

rcube_imap::search_once() : Direct (real and simple) SEARCH request (without result sorting and caching).

set_acl (line 878)

Changes the ACL on the specified folder (SETACL)

return: True on success, False on failure
abstract:

boolean set_acl (string $folder, string $user, string $acl)

string $folder: Folder name
string $user: User name
string $acl: ACL string

Redefined in descendants as:

rcube_imap::set_acl() : Changes the ACL on the specified folder (SETACL)

set_charset (line 169)

Set default message charset.

This will be used for message decoding if a charset specification is not available

access: public

void set_charset (string $cs)

string $cs: Charset string

set_debug (line 159)

Activate/deactivate debug mode.

abstract:

void set_debug ([boolean $dbg = true])

boolean $dbg: True if conversation with the server should be logged

Redefined in descendants as:

rcube_imap::set_debug() : Activate/deactivate debug mode

set_default_folders (line 180)

This list of folders will be listed above all other folders

access: public

void set_default_folders (array $arr)

array $arr: Indexed list of folder names

set_flag (line 522)

Set message flag to one or several messages

return: Operation status
abstract:

bool set_flag (mixed $uids, string $flag, [string $folder = null], [boolean $skip_cache = false])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $flag: Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
string $folder: Folder name
boolean $skip_cache: True to skip message cache clean up

Redefined in descendants as:

rcube_imap::set_flag() : Set message flag to one or several messages

set_folder (line 199)

Set internal folder reference.

All operations will be perfomed on this folder.

access: public

void set_folder (string $folder)

string $folder: Folder name

Redefined in descendants as:

rcube_imap::set_folder() : Set internal folder reference.

set_metadata (line 934)

Sets metadata/annotations (SETMETADATA/SETANNOTATION)

return: True on success, False on failure
abstract:

boolean set_metadata (string $folder, array $entries)

string $folder: Folder name (empty for server metadata)
array $entries: Entry-value array (use NULL value as NIL)

Redefined in descendants as:

rcube_imap::set_metadata() : Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)

set_options (line 148)

Set connection and class options

access: public

void set_options (array $opt)

array $opt: Options array

set_page (line 225)

Set internal list page number.

access: public

void set_page (int $page)

int $page: Page number to list

set_pagesize (line 247)

Set internal page size

access: public

void set_pagesize (int $size)

int $size: Number of messages to display on one page

set_search_set (line 269)

Save a search result for future message listing methods.

abstract:

void set_search_set (mixed $set)

mixed $set: Search set in driver specific format

Redefined in descendants as:

rcube_imap::set_search_set() : Save a search result for future message listing methods

set_threading (line 298)

Sets threading flag to the best supported THREAD algorithm.

Enable/Disable threaded mode.

return: Threading algorithm or False if THREAD is not supported
access: public

mixed set_threading ([boolean $enable = false])

boolean $enable: TRUE to enable and FALSE

subscribe (line 673)

Subscribe to a specific folder(s)

return: True on success
abstract:

boolean subscribe (array $folders)

array $folders: Folder name(s)

Redefined in descendants as:

rcube_imap::subscribe() : Subscribe to a specific folder(s)

unset_flag (line 535)

Remove message flag for one or several messages

return: Operation status
see: rcube_storage::set_flag()
access: public

bool unset_flag (mixed $uids, string $flag, [string $folder = null])

mixed $uids: Message UIDs as array or comma-separated string, or '*'
string $flag: Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
string $folder: Folder name

unsubscribe (line 683)

Unsubscribe folder(s)

return: True on success
abstract:

boolean unsubscribe (array $folders)

array $folders: Folder name(s)

Redefined in descendants as:

rcube_imap::unsubscribe() : Unsubscribe folder(s)

Class Constants

ALREADYEXISTS = 6 (line 78)

CONTACTADMIN = 8 (line 80)

INUSE = 4 (line 76)

NONEXISTENT = 7 (line 79)

NOPERM = 1 (line 73)

OVERQUOTA = 5 (line 77)

READONLY = 2 (line 74)

TRYCREATE = 3 (line 75)

UNKNOWN = 0 (line 72)

Documentation generated on Wed, 23 May 2012 16:40:53 +0200 by phpDocumentor 1.4.4