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.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402]

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

Defines 1 class

Horde_Imap_Client_Fetch_Query:: (28 methods):
  fullText()
  headerText()
  bodyText()
  mimeHeader()
  bodyPart()
  bodyPartSize()
  headers()
  structure()
  envelope()
  flags()
  imapDate()
  size()
  uid()
  seq()
  modseq()
  contains()
  remove()
  hash()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()
  count()
  current()
  key()
  next()
  rewind()
  valid()


Class: Horde_Imap_Client_Fetch_Query  - X-Ref

Fetch query object for use with Horde_Imap_Client_Base#fetch().

fullText(array $opts = array()   X-Ref
Get the full text of the message.

param: array $opts  The following options are available:

headerText(array $opts = array()   X-Ref
Return header text.

Header text is defined only for the base RFC 2822 message or
message/rfc822 parts.

param: array $opts  The following options are available:

bodyText(array $opts = array()   X-Ref
Return body text.

Body text is defined only for the base RFC 2822 message or
message/rfc822 parts.

param: array $opts  The following options are available:

mimeHeader($id, array $opts = array()   X-Ref
Return MIME header text.

MIME header text is defined only for non-RFC 2822 messages and
non-message/rfc822 parts.

param: string $id   The MIME ID to obtain the MIME header text for.
param: array $opts  The following options are available:

bodyPart($id, array $opts = array()   X-Ref
Return the body part data for a MIME ID.

param: string $id   The MIME ID to obtain the body part text for.
param: array $opts  The following options are available:

bodyPartSize($id)   X-Ref
Returns the decoded body part size for a MIME ID.

param: string $id  The MIME ID to obtain the decoded body part size

headers($label, $search, array $opts = array()   X-Ref
Returns RFC 2822 header text that matches a search string.

This header search work only with the base RFC 2822 message or
message/rfc822 parts.

param: string $label  A unique label associated with this particular
param: array $search  The search string(s) (case-insensitive).
param: array $opts    The following options are available:

structure()   X-Ref
Return MIME structure information.


envelope()   X-Ref
Return envelope header data.


flags()   X-Ref
Return flags set for the message.


imapDate()   X-Ref
Return the internal (IMAP) date of the message.


size()   X-Ref
Return the size (in bytes) of the message.


uid()   X-Ref
Return the unique ID of the message.


seq()   X-Ref
Return the sequence number of the message.


modseq()   X-Ref
Return the mod-sequence value for the message.

The server must support the CONDSTORE IMAP extension, and the mailbox
must support mod-sequences.

contains($criteria)   X-Ref
Does the query contain the given criteria?

param: integer $criteria  The criteria to remove.
return: boolean  True if the query contains the given criteria.

remove($criteria, $key)   X-Ref
Remove an entry under a given criteria.

param: integer $criteria  Criteria ID.
param: string $key        The key to remove.

hash()   X-Ref
Returns a hash of the current query object.

return: string  Hash.

offsetExists($offset)   X-Ref
No description

offsetGet($offset)   X-Ref
No description

offsetSet($offset, $value)   X-Ref
No description

offsetUnset($offset)   X-Ref
No description

count()   X-Ref
No description

current()   X-Ref
No description

key()   X-Ref
No description

next()   X-Ref
No description

rewind()   X-Ref
No description

valid()   X-Ref
No description