Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/horde/framework/Horde/Imap/Client/ -> Cache.php (source)

[Source view]

Copyright 2005-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Copyright: 2005-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 263 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Cache:: (8 methods):
  __construct()
  get()
  set()
  getMetaData()
  setMetaData()
  deleteMsgs()
  deleteMailbox()
  clear()


Class: Horde_Imap_Client_Cache  - X-Ref

An interface to cache data retrieved from the IMAP server.

__construct(array $params = array()   X-Ref
Constructor.

param: array $params  Configuration parameters:

get($mailbox, array $uids = array()   X-Ref
Get information from the cache.

param: string $mailbox    An IMAP mailbox string.
param: array $uids        The list of message UIDs to retrieve
param: array $fields      An array of fields to retrieve. If empty,
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.
return: array  An array of arrays with the UID of the message as the

set($mailbox, $data, $uidvalid)   X-Ref
Store information in cache.

param: string $mailbox    An IMAP mailbox string.
param: array $data        The list of data to save. The keys are the
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.

getMetaData($mailbox, $uidvalid = null,array $entries = array()   X-Ref
Get metadata information for a mailbox.

param: string $mailbox    An IMAP mailbox string.
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.
param: array $entries     An array of entries to return. If empty,
return: array  The requested metadata. Requested entries that do not

setMetaData($mailbox, $uidvalid, array $data = array()   X-Ref
Set metadata information for a mailbox.

param: string $mailbox    An IMAP mailbox string.
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.
param: array $data        The list of data to save. The keys are the

deleteMsgs($mailbox, $uids)   X-Ref
Delete messages in the cache.

param: string $mailbox  An IMAP mailbox string.
param: array $uids      The list of message UIDs to delete.

deleteMailbox($mbox)   X-Ref
Delete a mailbox from the cache.

param: string $mbox  The mailbox to delete.

clear($lifetime = null)   X-Ref
Clear the cache.

param: integer $lifetime  Only delete entries older than this (in