PHP Class Horde_Imap_Client_Data_Fetch, horde

Author: Michael Slusarz ([email protected])

Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_data	array	Internal data array.

Public Methods

Method	Description
__clone ( )
exists ( integer $type ) : boolean	Does this object containing cacheable data of the given type?
getBodyPart ( string $id, boolean $stream = false ) : mixed	Get a body part entry.
getBodyPartDecode ( string $id ) : string	Determines if/how a body part was MIME decoded on the server.
getBodyPartSize ( string $id ) : integer	Returns the body part size, if returned by the server.
getBodyText ( string $id, boolean $stream = false ) : mixed	Get a body text entry.
getEnvelope ( ) : Horde_Imap_Client_Data_Envelope	Get envelope data.
getFlags ( ) : array	Get IMAP flags.
getFullMsg ( boolean $stream = false ) : mixed	Returns the full message.
getHeaderText ( string $id, integer $format ) : mixed	Get a header text entry.
getHeaders ( string $label, integer $format ) : mixed	Get a header entry.
getImapDate ( ) : Horde_Imap_Client_DateTime	Get internal IMAP date.
getMimeHeader ( string $id, integer $format ) : mixed	Get a MIME header entry.
getModSeq ( ) : integer	Get the modified sequence value for the message.
getRawData ( ) : array	Return the internal representation of the data.
getSeq ( ) : integer	Get message sequence number.
getSize ( ) : integer	Get message size.
getStructure ( ) : Horde_Mime_Part	Get the message structure.
getUid ( ) : integer	Get UID.
isDefault ( ) : boolean	Does this object contain only default values for all fields?
isDowngraded ( ) : boolean	Does the message contain internationalized downgraded data (i.e. it is a "surrogate" message)?
merge ( Horde_Imap_Client_Data_Fetch $data )	Merge a fetch object into this one.
setBodyPart ( string $id, mixed $text, string $decode = null )	Set a body part entry.
setBodyPartSize ( string $id, integer $size )	Set the body part size for a body part.
setBodyText ( string $id, mixed $text )	Set a body text entry.
setDowngraded ( boolean $downgraded )	Set the internationalized downgraded status for the message.
setEnvelope ( array $data )	Set envelope data.
setFlags ( array $flags )	Set IMAP flags.
setFullMsg ( mixed $msg )	Set the full message property.
setHeaderText ( string $id, mixed $text )	Set a header text entry.
setHeaders ( string $label, mixed $data )	Set a header entry.
setImapDate ( mixed $date )	Set IMAP internal date.
setMimeHeader ( string $id, mixed $text )	Set a MIME header entry.
setModSeq ( integer $modseq )	Set the modified sequence value for the message.
setSeq ( integer $seq )	Set message sequence number.
setSize ( integer $size )	Set message size.
setStructure ( Horde_Mime_Part $structure )	Set the message structure.
setUid ( integer $uid )	Set UID.

Protected Methods

Method	Description
_getHeaders ( string $id, integer $format, integer $key ) : mixed	Return representation of a header field.
_msgText ( boolean $stream, mixed $data ) : mixed	Return text representation of a field.
_setMixed ( mixed $data ) : mixed	Converts mixed input (string or resource) to the correct internal representation.

Method Details

__clone() public method

public __clone ( )

_getHeaders() protected method

Return representation of a header field.

protected _getHeaders ( string $id, integer $format, integer $key ) : mixed
$id	string	The header id.
$format	integer	The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.
$key	integer	The array key where the data is stored in the internal array.
return	mixed	The data in the format specified by $format.

_msgText() protected method

Return text representation of a field.

protected _msgText ( boolean $stream, mixed $data ) : mixed
$stream	boolean	Return as a stream?
$data	mixed	The field data (string or resource) or null if field does not exist.
return	mixed	Requested text representation.

_setMixed() protected method

Converts mixed input (string or resource) to the correct internal representation.

protected _setMixed ( mixed $data ) : mixed
$data	mixed	Mixed data (string, resource, Horde_Stream object).
return	mixed	The internal representation of that data.

exists() public method

Does this object containing cacheable data of the given type?

public exists ( integer $type ) : boolean
$type	integer	The type to query.
return	boolean	True if the type is cacheable.

getBodyPart() public method

Get a body part entry.

public getBodyPart ( string $id, boolean $stream = false ) : mixed
$id	string	The MIME ID.
$stream	boolean	Return as a stream?
return	mixed	The full text of the body part.

getBodyPartDecode() public method

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

public getBodyPartDecode ( string $id ) : string
$id	string	The MIME ID.
return	string	Either '8bit', 'binary', or null.

getBodyPartSize() public method

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

public getBodyPartSize ( string $id ) : integer
$id	string	The MIME ID.
return	integer	The body part size, in bytes.

getBodyText() public method

Get a body text entry.

public getBodyText ( string $id, boolean $stream = false ) : mixed
$id	string	The MIME ID.
$stream	boolean	Return as a stream?
return	mixed	The full text of the body text.

getEnvelope() public method

Get envelope data.

public getEnvelope ( ) : Horde_Imap_Client_Data_Envelope
return	Horde_Imap_Client_Data_Envelope	An envelope object.

getFlags() public method

Get IMAP flags.

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

getFullMsg() public method

Returns the full message.

public getFullMsg ( boolean $stream = false ) : mixed
$stream	boolean	Return as a stream?
return	mixed	The full text of the entire message.

getHeaderText() public method

Get a header text entry.

public getHeaderText ( string $id, integer $format ) : mixed
$id	string	The MIME ID.
$format	integer	The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.
return	mixed	See $format.

getHeaders() public method

Get a header entry.

public getHeaders ( string $label, integer $format ) : mixed
$label	string	The search label.
$format	integer	The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.
return	mixed	See $format.

getImapDate() public method

Get internal IMAP date.

public getImapDate ( ) : Horde_Imap_Client_DateTime
return	Horde_Imap_Client_DateTime	A date object.

getMimeHeader() public method

Get a MIME header entry.

public getMimeHeader ( string $id, integer $format ) : mixed
$id	string	The MIME ID.
$format	integer	The return format. If self::HEADER_PARSE, returns a Horde_Mime_Headers object. If self::HEADER_STREAM, returns a stream. Otherwise, returns header text.
return	mixed	See $format.

getModSeq() public method

Get the modified sequence value for the message.

public getModSeq ( ) : integer
return	integer	The modseq value.

getRawData() public method

Return the internal representation of the data.

public getRawData ( ) : array
return	array	The data array.

getSeq() public method

Get message sequence number.

public getSeq ( ) : integer
return	integer	The message sequence number.

getSize() public method

Get message size.

public getSize ( ) : integer
return	integer	The size of the message, in bytes.

getStructure() public method

Get the message structure.

public getStructure ( ) : Horde_Mime_Part
return	Horde_Mime_Part	$structure The base MIME part of the message.

getUid() public method

Get UID.

public getUid ( ) : integer
return	integer	The message UID.

isDefault() public method

Does this object contain only default values for all fields?

public isDefault ( ) : boolean
return	boolean	True if object contains default data.

isDowngraded() public method

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

Since: 2.11.0

public isDowngraded ( ) : boolean
return	boolean	True if at least one message components has been downgraded.

merge() public method

Merge a fetch object into this one.

public merge ( Horde_Imap_Client_Data_Fetch $data )
$data	Horde_Imap_Client_Data_Fetch	A fetch object.

setBodyPart() public method

Set a body part entry.

public setBodyPart ( string $id, mixed $text, string $decode = null )
$id	string	The MIME ID.
$text	mixed	The body part text, as either a string or stream resource.
$decode	string	Either '8bit', 'binary', or null.

setBodyPartSize() public method

Set the body part size for a body part.

public setBodyPartSize ( string $id, integer $size )
$id	string	The MIME ID.
$size	integer	The size (in bytes).

setBodyText() public method

Set a body text entry.

public setBodyText ( string $id, mixed $text )
$id	string	The MIME ID.
$text	mixed	The body part text, as either a string or stream resource.

setDowngraded() public method

Set the internationalized downgraded status for the message.

Since: 2.11.0

public setDowngraded ( boolean $downgraded )
$downgraded	boolean	True if at least one message component has been downgraded.

setEnvelope() public method

Set envelope data.

public setEnvelope ( array $data )
$data	array	The envelope data to pass to the Envelope object constructor, or an Envelope object.

setFlags() public method

Set IMAP flags.

public setFlags ( array $flags )
$flags	array	An array of IMAP flags.

setFullMsg() public method

Set the full message property.

public setFullMsg ( mixed $msg )
$msg	mixed	The full message text, as either a string or stream resource.

setHeaderText() public method

Set a header text entry.

public setHeaderText ( string $id, mixed $text )
$id	string	The MIME ID.
$text	mixed	The header text, as either a string or stream resource.

setHeaders() public method

Set a header entry.

public setHeaders ( string $label, mixed $data )
$label	string	The search label.
$data	mixed	Either a Horde_Mime_Headers object or the raw header text.

setImapDate() public method

Set IMAP internal date.

public setImapDate ( mixed $date )
$date	mixed	Either a Horde_Imap_Client_DateTime object or a date string.

setMimeHeader() public method

Set a MIME header entry.

public setMimeHeader ( string $id, mixed $text )
$id	string	The MIME ID.
$text	mixed	The header text, as either a string or stream resource.

setModSeq() public method

Set the modified sequence value for the message.

public setModSeq ( integer $modseq )
$modseq	integer	The modseq value.

setSeq() public method

Set message sequence number.

public setSeq ( integer $seq )
$seq	integer	The message sequence number.

setSize() public method

Set message size.

public setSize ( integer $size )
$size	integer	The size of the message, in bytes.

setStructure() public method

Set the message structure.

public setStructure ( Horde_Mime_Part $structure )
$structure	Horde_Mime_Part	The base MIME part of the message.

setUid() public method

Set UID.

public setUid ( integer $uid )
$uid	integer	The message UID.

Property Details

$_data protected_oe property

Internal data array.

protected array $_data
return	array