rcube_imap_cache
Interface class for accessing Roundcube messages cache
Located in /lib/Roundcube/rcube_imap_cache.php (line 28)
array
get_index
(string $mailbox, [string $sort_field = null], [string $sort_order = null], [ $existing = false], bool $exiting)
rcube_message_header
get_message
(string $mailbox, int $uid, [bool $update = true], [ $cache = true], bool $no_cache)
mixed
$flags
= array(1 => 'SEEN', // RFC3501
2 => 'DELETED', // RFC3501
4 => 'ANSWERED', // RFC3501
8 => 'FLAGGED', // RFC3501
16 => 'DRAFT', // RFC3501
32 => 'MDNSENT', // RFC3503
64 => 'FORWARDED', // RFC5550
128 => 'SUBMITPENDING', // RFC5550
256 => 'SUBMITTED', // RFC5550
512 => 'JUNK',
1024 => 'NONJUNK',
2048 => 'LABEL1',
4096 => 'LABEL2',
8192 => 'LABEL3',
16384 => 'LABEL4',
32768 => 'LABEL5',
) (line 64)
List of known flags. Thanks to this we can handle flag changes with good performance. Bad thing is we need to know used flags.
Constructor __construct (line 87)
Object constructor.
- $db
- $imap
- $userid
- $skip_deleted
add_message (line 404)
Saves the message in cache.
- string $mailbox: Folder name
- rcube_message_header $message: Message data
- bool $force: Skips message in-cache existance check
change_flag (line 456)
Sets the flag for specified message.
- string $mailbox: Folder name
- array $uids: Message UIDs or null to change flag of all messages in a folder
- string $flag: The name of the flag
- bool $enabled: Flag state
clear (line 598)
Clears the cache.
- string $mailbox: Folder name
- array $uids: Message UIDs, NULL removes all messages in a folder
close (line 99)
Cleanup actions (on shutdown).
expunge (line 611)
Delete cache entries older than TTL
- string $ttl: Lifetime of message cache entries
get_index (line 117)
Return (sorted) messages index (UIDs).
If index doesn't exist or is invalid, will be updated.
- string $mailbox: Folder name
- string $sort_field: Sorting column
- string $sort_order: Sorting order (ASC|DESC)
- bool $exiting: Skip index initialization if it doesn't exist in DB
- $existing
get_message (line 346)
Returns message data.
- string $mailbox: Folder name
- int $uid: Message UID
- bool $update: If message doesn't exists in cache it will be fetched from IMAP server
- bool $no_cache: Enables internal cache usage
- $cache
get_messages (line 288)
Returns list of messages (headers). See rcube_imap::fetch_headers().
- string $mailbox: Folder name
- array $msgs: Message UIDs
get_thread (line 224)
Return messages thread.
If threaded index doesn't exist or is invalid, will be updated.
- string $mailbox: Folder name
- string $sort_field: Sorting column
- string $sort_order: Sorting order (ASC|DESC)
remove_index (line 533)
Clears index cache.
- string $mailbox: Folder name
- bool $remove: Enable to remove the DB row
remove_message (line 500)
Removes message(s) from cache.
- string $mailbox: Folder name
- array $uids: Message UIDs, NULL removes all messages
remove_thread (line 572)
Clears thread cache.
- string $mailbox: Folder name
synchronize (line 892)
Synchronizes the mailbox.
- string $mailbox: Folder name
Documentation generated on Fri, 03 May 2013 12:45:02 +0200 by phpDocumentor 1.4.4