Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Copyright 2013-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: 2013-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 440 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Cache_Backend_Mongo:: (15 methods):
  __construct()
  _initOb()
  get()
  getCachedUids()
  set()
  getMetaData()
  setMetaData()
  deleteMsgs()
  deleteMailbox()
  clear()
  _getUid()
  _createUid()
  _value()
  checkMongoIndices()
  createMongoIndices()


Class: Horde_Imap_Client_Cache_Backend_Mongo  - X-Ref

A MongoDB database implementation for caching IMAP/POP data.

Requires the Horde_Mongo class.

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

param: array $params  Configuration parameters:

_initOb()   X-Ref
No description

get($mailbox, $uids, $fields, $uidvalid)   X-Ref
No description

getCachedUids($mailbox, $uidvalid)   X-Ref
No description

set($mailbox, $data, $uidvalid)   X-Ref
No description

getMetaData($mailbox, $uidvalid, $entries)   X-Ref
No description

setMetaData($mailbox, $data)   X-Ref
No description

deleteMsgs($mailbox, $uids)   X-Ref
No description

deleteMailbox($mailbox)   X-Ref
No description

clear($lifetime)   X-Ref
No description

_getUid($mailbox)   X-Ref
Return the UID for a mailbox/user/server combo.

param: string $mailbox  Mailbox name.
return: string  UID from base table.

_createUid($mailbox)   X-Ref
Create and return the UID for a mailbox/user/server combo.

param: string $mailbox  Mailbox name.
return: string  UID from base table.

_value($data)   X-Ref
Convert data from/to storage format.

param: mixed|MongoBinData $data  The data object.
return: mixed|MongoBinData  The converted data.

checkMongoIndices()   X-Ref
No description

createMongoIndices()   X-Ref
No description