PHP Class Horde_Imap_Client_Fetch_Query, horde

Author: Michael Slusarz ([email protected])

Inheritance: implements ArrayAccess, implements Countable, implements Iterator

Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство	Type	Description
$_data	array	Internal data array.

Méthodes publiques

Méthode	Description
bodyPart ( string $id, array $opts = [] )	Return the body part data for a MIME ID.
bodyPartSize ( string $id )	Returns the decoded body part size for a MIME ID.
bodyText ( array $opts = [] )	Return body text.
contains ( integer $criteria ) : boolean	Does the query contain the given criteria?
count ( )
current ( )
envelope ( )	Return envelope header data.
flags ( )	Return flags set for the message.
fullText ( array $opts = [] )	Get the full text of the message.
hash ( ) : string	Returns a hash of the current query object.
headerText ( array $opts = [] )	Return header text.
headers ( string $label, array $search, array $opts = [] )	Returns RFC 2822 header text that matches a search string.
imapDate ( )	Return the internal (IMAP) date of the message.
key ( )
mimeHeader ( string $id, array $opts = [] )	Return MIME header text.
modseq ( )	Return the mod-sequence value for the message.
next ( )
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
remove ( integer $criteria, string $key )	Remove an entry under a given criteria.
rewind ( )
seq ( )	Return the sequence number of the message.
size ( )	Return the size (in bytes) of the message.
structure ( )	Return MIME structure information.
uid ( )	Return the unique ID of the message.
valid ( )

Method Details

bodyPart() public méthode

Return the body part data for a MIME ID.

public bodyPart ( string $id, array $opts = [] )
$id	string	The MIME ID to obtain the body part text for.
$opts	array	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.

bodyPartSize() public méthode

Returns the decoded body part size for a MIME ID.

public bodyPartSize ( string $id )
$id	string	The MIME ID to obtain the decoded body part size for.

bodyText() public méthode

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

public bodyText ( array $opts = [] )
$opts	array	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.

contains() public méthode

Does the query contain the given criteria?

public contains ( integer $criteria ) : boolean
$criteria	integer	The criteria to remove.
Résultat	boolean	True if the query contains the given criteria.

count() public méthode

public count ( )

current() public méthode

public current ( )

envelope() public méthode

Return envelope header data.

public envelope ( )

flags() public méthode

Return flags set for the message.

public flags ( )

fullText() public méthode

Get the full text of the message.

public fullText ( array $opts = [] )
$opts	array	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.

hash() public méthode

Returns a hash of the current query object.

public hash ( ) : string
Résultat	string	Hash.

headerText() public méthode

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

public headerText ( array $opts = [] )
$opts	array	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.

headers() public méthode

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

public headers ( string $label, array $search, array $opts = [] )
$label	string	A unique label associated with this particular search. This is how the results are stored.
$search	array	The search string(s) (case-insensitive).
$opts	array	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.

imapDate() public méthode

Return the internal (IMAP) date of the message.

public imapDate ( )

key() public méthode

public key ( )

mimeHeader() public méthode

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

public mimeHeader ( string $id, array $opts = [] )
$id	string	The MIME ID to obtain the MIME header text for.
$opts	array	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.

modseq() public méthode

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

public modseq ( )

next() public méthode

public next ( )

offsetExists() public méthode

public offsetExists ( $offset )

offsetGet() public méthode

public offsetGet ( $offset )

offsetSet() public méthode

public offsetSet ( $offset, $value )

offsetUnset() public méthode

public offsetUnset ( $offset )

remove() public méthode

Remove an entry under a given criteria.

public remove ( integer $criteria, string $key )
$criteria	integer	Criteria ID.
$key	string	The key to remove.

rewind() public méthode

public rewind ( )

seq() public méthode

Return the sequence number of the message.

public seq ( )

size() public méthode

Return the size (in bytes) of the message.

public size ( )

structure() public méthode

Return MIME structure information.

public structure ( )

uid() public méthode

Return the unique ID of the message.

public uid ( )

valid() public méthode

public valid ( )

Property Details

$_data protected_oe property

Internal data array.

protected array $_data
Résultat	array