Class Horde_Imap_Client_Fetch_Query

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

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Imap_Client_Fetch_Query implements ArrayAccess, Countable, Iterator

Package: Imap\Client
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Imap/Client/Fetch/Query.php

Methods summary
`public`	# `fullText( array $opts = array() )` Get the full text of the message. Get the full text of the message. Parameters `$opts` <p>The following options are available: - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `headerText( array $opts = array() )` Return header text. Return header text. Header text is defined only for the base RFC 2822 message or message/rfc822 parts. Parameters `$opts` <p>The following options are available: - id: (string) The MIME ID to obtain the header text for. DEFAULT: The header text for the base message will be returned. - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `bodyText( array $opts = array() )` Return body text. Return body text. Body text is defined only for the base RFC 2822 message or message/rfc822 parts. Parameters `$opts` <p>The following options are available: - id: (string) The MIME ID to obtain the body text for. DEFAULT: The body text for the entire message will be returned. - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `mimeHeader( string $id, array $opts = array() )` Return MIME header text. Return MIME header text. MIME header text is defined only for non-RFC 2822 messages and non-message/rfc822 parts. Parameters `$id` The MIME ID to obtain the MIME header text for. `$opts` <p>The following options are available: - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `bodyPart( string $id, array $opts = array() )` Return the body part data for a MIME ID. Return the body part data for a MIME ID. Parameters `$id` The MIME ID to obtain the body part text for. `$opts` <p>The following options are available: - decode: (boolean) Attempt to server-side decode the bodypart data if it is MIME transfer encoded. DEFAULT: false - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `bodyPartSize( string $id )` Returns the decoded body part size for a MIME ID. Returns the decoded body part size for a MIME ID. Parameters `$id` <p>The MIME ID to obtain the decoded body part size for.</p>
`public`	# `headers( string $label, array $search, array $opts = array() )` Returns RFC 2822 header text that matches a search string. 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. Parameters `$label` <p>A unique label associated with this particular search. This is how the results are stored.</p> `$search` The search string(s) (case-insensitive). `$opts` <p>The following options are available: - cache: (boolean) If true, and 'peek' is also true, will cache the result of this call. DEFAULT: false - id: (string) The MIME ID to search. DEFAULT: The base message part - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - notsearch: (boolean) Do a 'NOT' search on the headers. DEFAULT: false - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned.</p>
`public`	# `structure( )` Return MIME structure information. Return MIME structure information.
`public`	# `envelope( )` Return envelope header data. Return envelope header data.
`public`	# `flags( )` Return flags set for the message. Return flags set for the message.
`public`	# `imapDate( )` Return the internal (IMAP) date of the message. Return the internal (IMAP) date of the message.
`public`	# `size( )` Return the size (in bytes) of the message. Return the size (in bytes) of the message.
`public`	# `uid( )` Return the unique ID of the message. Return the unique ID of the message.
`public`	# `seq( )` Return the sequence number of the message. Return the sequence number of the message.
`public`	# `modseq( )` Return the mod-sequence value for the message. Return the mod-sequence value for the message. The server must support the CONDSTORE IMAP extension, and the mailbox must support mod-sequences.
`public boolean`	# `contains( integer $criteria )` Does the query contain the given criteria? Does the query contain the given criteria? Parameters `$criteria` The criteria to remove. Returns `boolean` True if the query contains the given criteria.
`public`	# `remove( integer $criteria, string $key )` Remove an entry under a given criteria. Remove an entry under a given criteria. Parameters `$criteria` Criteria ID. `$key` The key to remove.
`public string`	# `hash( )` Returns a MD5 hash of the current query object. Returns a MD5 hash of the current query object. Returns `string` MD5 hash.
`public`	# `offsetExists( mixed $offset )` Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetGet( mixed $offset )` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $offset, mixed $value )` Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $offset )` Implementation of `ArrayAccess::offsetUnset()`
`public`	# `count( )` Implementation of `Countable::count()`
`public`	# `current( )` Implementation of `Iterator::current()`
`public`	# `key( )` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `valid( )` Implementation of `Iterator::valid()`

Packages

Classes

Class Horde_Imap_Client_Fetch_Query

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of