PHPXRef 0.7.1 : Unnamed Project : Detail view of Fetch.php

Class: Horde_Imap_Client_Data_Fetch - X-Ref

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

Set the full message property.

param: mixed $msg The full message text, as either a string or stream

Returns the full message.

param: boolean $stream Return as a stream?
return: mixed The full text of the entire message.

setStructure(Horde_Mime_Part $structure) X-Ref

Set the message structure.

param: Horde_Mime_Part $structure The base MIME part of the message.

getStructure() X-Ref

Get the message structure.

return: Horde_Mime_Part $structure The base MIME part of the message.

setHeaders($label, $data) X-Ref

Set a header entry.

param: string $label The search label.
param: mixed $data Either a Horde_Mime_Headers object or the raw

getHeaders($label, $format = 0) X-Ref

Get a header entry.

param: string $label    The search label.
param: integer $format  The return format. If self::HEADER_PARSE,
return: mixed  See $format.

setHeaderText($id, $text) X-Ref

Set a header text entry.

param: string $id The MIME ID.
param: string $text The header text.

getHeaderText($id = 0, $format = 0) X-Ref

Get a header text entry.

param: string $id       The MIME ID.
param: integer $format  The return format. If self::HEADER_PARSE,
return: mixed  See $format.

setMimeHeader($id, $text) X-Ref

Set a MIME header entry.

param: string $id The MIME ID.
param: string $text The header text.

getMimeHeader($id, $format = 0) X-Ref

Get a MIME header entry.

param: string $id       The MIME ID.
param: integer $format  The return format. If self::HEADER_PARSE,
return: mixed  See $format.

setBodyPart($id, $text, $decode = null) X-Ref

Set a body part entry.

param: string $id      The MIME ID.
param: mixed $text     The body part text, as either a string or stream
param: string $decode  Either '8bit', 'binary', or null.

setBodyPartSize($id, $size) X-Ref

Set the body part size for a body part.

param: string $id The MIME ID.
param: integer $size The size (in bytes).

getBodyPart($id, $stream = false) X-Ref

Get a body part entry.

param: string $id       The MIME ID.
param: boolean $stream  Return as a stream?
return: mixed  The full text of the body part.

getBodyPartDecode($id) X-Ref

Determines if/how a body part was MIME decoded on the server.

param: string $id The MIME ID.
return: string Either '8bit', 'binary', or null.

getBodyPartSize($id) X-Ref

Returns the body part size, if returned by the server.

param: string $id The MIME ID.
return: integer The body part size, in bytes.

setBodyText($id, $text) X-Ref

Set a body text entry.

param: string $id The MIME ID.
param: mixed $text The body part text, as either a string or stream

getBodyText($id = 0, $stream = false) X-Ref

Get a body text entry.

param: string $id       The MIME ID.
param: boolean $stream  Return as a stream?
return: mixed  The full text of the body text.

setEnvelope($data) X-Ref

Set envelope data.

param: array $data The envelope data to pass to the Envelope object

getEnvelope() X-Ref

Get envelope data.

return: Horde_Imap_Client_Data_Envelope An envelope object.

setFlags(array $flags) X-Ref

Set IMAP flags.

param: array $flags An array of IMAP flags.

getFlags() X-Ref

Get IMAP flags.

return: array An array of IMAP flags (all flags in lowercase).

setImapDate($date) X-Ref

Set IMAP internal date.

param: mixed $date Either a Horde_Imap_Client_DateTime object or a

getImapDate() X-Ref

Get internal IMAP date.

return: Horde_Imap_Client_DateTime A date object.

setSize($size) X-Ref

Set message size.

param: integer $size The size of the message, in bytes.

getSize() X-Ref

Get message size.

return: integer The size of the message, in bytes.

setUid($uid) X-Ref

Set UID.

param: integer $uid The message UID.

getUid() X-Ref

Get UID.

return: integer The message UID.

setSeq($seq) X-Ref

Set message sequence number.

param: integer $seq The message sequence number.

getSeq() X-Ref

Get message sequence number.

return: integer The message sequence number.

setModSeq($modseq) X-Ref

Set the modified sequence value for the message.

param: integer $modseq The modseq value.

getModSeq() X-Ref

Get the modified sequence value for the message.

return: integer The modseq value.

setDowngraded($downgraded) X-Ref

Set the internationalized downgraded status for the message.

param: boolean $downgraded True if at least one message component has

isDowngraded() X-Ref

Does the message contain internationalized downgraded data (i.e. it
is a "surrogate" message)?

return: boolean True if at least one message components has been

getRawData() X-Ref

Return the internal representation of the data.

return: array The data array.

merge(Horde_Imap_Client_Data_Fetch $data) X-Ref

Merge a fetch object into this one.

param: Horde_Imap_Client_Data_Fetch $data A fetch object.

exists($type) X-Ref

Does this object containing cacheable data of the given type?

param: integer $type The type to query.
return: boolean True if the type is cacheable.

isDefault() X-Ref

Does this object contain only default values for all fields?

return: boolean True if object contains default data.

_msgText($stream, $data) X-Ref

Return text representation of a field.

param: boolean $stream  Return as a stream?
param: mixed $data      The field data (string or resource) or null if
return: mixed  Requested text representation.

_getHeaders($id, $format, $key) X-Ref

Return representation of a header field.

param: string $id       The header id.
param: integer $format  The return format. If self::HEADER_PARSE,
param: integer $key     The array key where the data is stored in the
return: mixed  The data in the format specified by $format.

Copyright:	2011-2014 Horde LLC
License:	http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size:	567 lines (16 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Unnamed Project

/lib/horde/framework/Horde/Imap/Client/Data/ -> Fetch.php (summary)

Defines 1 class