Class Horde_Imap_Client_Data_Fetch

Object containing data returned by the Horde_Imap_Client_Base#fetch() command.

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

Direct known subclasses

Horde_Imap_Client_Data_Fetch_Pop3

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

Methods summary
`public`	# `setFullMsg( mixed $msg )` Set the full message property. Set the full message property. Parameters `$msg` <p>The full message text, as either a string or stream resource.</p>
`public mixed`	# `getFullMsg( boolean $stream = false )` Returns the full message. Returns the full message. Parameters `$stream` Return as a stream? Returns `mixed` The full text of the entire message.
`public`	# `setStructure( Horde_Mime_Part $structure )` Set the message structure. Set the message structure. Parameters `$structure` The base MIME part of the message.
`public Horde_Mime_Part`	# `getStructure( )` Get the message structure. Get the message structure. Returns `Horde_Mime_Part` $structure The base MIME part of the message.
`public`	# `setHeaders( string $label, mixed $data )` Set a header entry. Set a header entry. Parameters `$label` The search label. `$data` <p>Either a Horde_Mime_Headers object or the raw header text.</p>
`public mixed`	# `getHeaders( string $label, integer $format = 0 )` Get a header entry. Get a header entry. Parameters `$label` The search label. `$format` <p>The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.</p> Returns `mixed` See $format.
`public`	# `setHeaderText( string $id, string $text )` Set a header text entry. Set a header text entry. Parameters `$id` The MIME ID. `$text` The header text.
`public mixed`	# `getHeaderText( string $id = 0, integer $format = 0 )` Get a header text entry. Get a header text entry. Parameters `$id` The MIME ID. `$format` <p>The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.</p> Returns `mixed` See $format.
`public`	# `setMimeHeader( string $id, string $text )` Set a MIME header entry. Set a MIME header entry. Parameters `$id` The MIME ID. `$text` The header text.
`public mixed`	# `getMimeHeader( string $id, integer $format = 0 )` Get a MIME header entry. Get a MIME header entry. Parameters `$id` The MIME ID. `$format` <p>The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.</p> Returns `mixed` See $format.
`public`	# `setBodyPart( string $id, mixed $text, string $decode = null )` Set a body part entry. Set a body part entry. Parameters `$id` The MIME ID. `$text` <p>The body part text, as either a string or stream resource.</p> `$decode` Either '8bit', 'binary', or null.
`public`	# `setBodyPartSize( string $id, integer $size )` Set the body part size for a body part. Set the body part size for a body part. Parameters `$id` The MIME ID. `$size` The size (in bytes).
`public mixed`	# `getBodyPart( string $id, boolean $stream = false )` Get a body part entry. Get a body part entry. Parameters `$id` The MIME ID. `$stream` Return as a stream? Returns `mixed` The full text of the body part.
`public string`	# `getBodyPartDecode( string $id )` Determines if/how a body part was MIME decoded on the server. Determines if/how a body part was MIME decoded on the server. Parameters `$id` The MIME ID. Returns `string` Either '8bit', 'binary', or null.
`public integer`	# `getBodyPartSize( string $id )` Returns the body part size, if returned by the server. Returns the body part size, if returned by the server. Parameters `$id` The MIME ID. Returns `integer` The body part size, in bytes.
`public`	# `setBodyText( string $id, mixed $text )` Set a body text entry. Set a body text entry. Parameters `$id` The MIME ID. `$text` <p>The body part text, as either a string or stream resource.</p>
`public mixed`	# `getBodyText( string $id = 0, boolean $stream = false )` Get a body text entry. Get a body text entry. Parameters `$id` The MIME ID. `$stream` Return as a stream? Returns `mixed` The full text of the body text.
`public`	# `setEnvelope( array $data )` Set envelope data. Set envelope data. Parameters `$data` <p>The envelope data to pass to the Envelope object constructor, or an Envelope object.</p>
`public Horde_Imap_Client_Data_Envelope`	# `getEnvelope( )` Get envelope data. Get envelope data. Returns `Horde_Imap_Client_Data_Envelope` An envelope object.
`public`	# `setFlags( array $flags )` Set IMAP flags. Set IMAP flags. Parameters `$flags` An array of IMAP flags.
`public array`	# `getFlags( )` Get IMAP flags. Get IMAP flags. Returns `array` An array of IMAP flags (all flags in lowercase).
`public`	# `setImapDate( mixed $date )` Set IMAP internal date. Set IMAP internal date. Parameters `$date` <p>Either a Horde_Imap_Client_DateTime object or a date string.</p>
`public Horde_Imap_Client_DateTime`	# `getImapDate( )` Get internal IMAP date. Get internal IMAP date. Returns `Horde_Imap_Client_DateTime` A date object.
`public`	# `setSize( integer $size )` Set message size. Set message size. Parameters `$size` The size of the message, in bytes.
`public integer`	# `getSize( )` Get message size. Get message size. Returns `integer` The size of the message, in bytes.
`public`	# `setUid( integer $uid )` Set UID. Set UID. Parameters `$uid` The message UID.
`public integer`	# `getUid( )` Get UID. Get UID. Returns `integer` The message UID.
`public`	# `setSeq( integer $seq )` Set message sequence number. Set message sequence number. Parameters `$seq` The message sequence number.
`public integer`	# `getSeq( )` Get message sequence number. Get message sequence number. Returns `integer` The message sequence number.
`public`	# `setModSeq( integer $modseq )` Set the modified sequence value for the message. Set the modified sequence value for the message. Parameters `$modseq` The modseq value.
`public integer`	# `getModSeq( )` Get the modified sequence value for the message. Get the modified sequence value for the message. Returns `integer` The modseq value.
`public array`	# `getRawData( )` Return the internal representation of the data. Return the internal representation of the data. Returns `array` The data array.
`public`	# `merge( Horde_Imap_Client_Data_Fetch $data )` Merge a fetch object into this one. Merge a fetch object into this one. Parameters `$data` A fetch object.
`public boolean`	# `exists( integer $type )` Does this object containing cacheable data of the given type? Does this object containing cacheable data of the given type? Parameters `$type` The type to query. Returns `boolean` True if the type is cacheable.
`public boolean`	# `isDefault( )` Does this object contain only default values for all fields? Does this object contain only default values for all fields? Returns `boolean` True if object contains default data. Since 1.2.0

Constants summary
`integer`	`HEADER_PARSE`	# `1`
`integer`	`HEADER_STREAM`	# `2`

Packages

Classes

Class Horde_Imap_Client_Data_Fetch

Direct known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Since