• 홈
  • Horde_Imap_Client_Data_Fetch

PHP 클래스 Horde_Imap_Client_Data_Fetch, horde

저자: Michael Slusarz ([email protected])
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_data array Internal data array.

공개 메소드들

메소드 설명
__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.

보호된 메소드들

메소드 설명
_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.

메소드 상세

__clone() 공개 메소드

public __clone ( )

_getHeaders() 보호된 메소드

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.
리턴 mixed The data in the format specified by $format.

_msgText() 보호된 메소드

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.
리턴 mixed Requested text representation.

_setMixed() 보호된 메소드

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).
리턴 mixed The internal representation of that data.

exists() 공개 메소드

Does this object containing cacheable data of the given type?
public exists ( integer $type ) : boolean
$type integer The type to query.
리턴 boolean True if the type is cacheable.

getBodyPart() 공개 메소드

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

getBodyPartDecode() 공개 메소드

Determines if/how a body part was MIME decoded on the server.
public getBodyPartDecode ( string $id ) : string
$id string The MIME ID.
리턴 string Either '8bit', 'binary', or null.

getBodyPartSize() 공개 메소드

Returns the body part size, if returned by the server.
public getBodyPartSize ( string $id ) : integer
$id string The MIME ID.
리턴 integer The body part size, in bytes.

getBodyText() 공개 메소드

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

getEnvelope() 공개 메소드

Get envelope data.
public getEnvelope ( ) : Horde_Imap_Client_Data_Envelope
리턴 Horde_Imap_Client_Data_Envelope An envelope object.

getFlags() 공개 메소드

Get IMAP flags.
public getFlags ( ) : array
리턴 array An array of IMAP flags (all flags in lowercase).

getFullMsg() 공개 메소드

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

getHeaderText() 공개 메소드

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.
리턴 mixed See $format.

getHeaders() 공개 메소드

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.
리턴 mixed See $format.

getImapDate() 공개 메소드

Get internal IMAP date.
public getImapDate ( ) : Horde_Imap_Client_DateTime
리턴 Horde_Imap_Client_DateTime A date object.

getMimeHeader() 공개 메소드

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.
리턴 mixed See $format.

getModSeq() 공개 메소드

Get the modified sequence value for the message.
public getModSeq ( ) : integer
리턴 integer The modseq value.

getRawData() 공개 메소드

Return the internal representation of the data.
public getRawData ( ) : array
리턴 array The data array.

getSeq() 공개 메소드

Get message sequence number.
public getSeq ( ) : integer
리턴 integer The message sequence number.

getSize() 공개 메소드

Get message size.
public getSize ( ) : integer
리턴 integer The size of the message, in bytes.

getStructure() 공개 메소드

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

getUid() 공개 메소드

Get UID.
public getUid ( ) : integer
리턴 integer The message UID.

isDefault() 공개 메소드

Does this object contain only default values for all fields?
public isDefault ( ) : boolean
리턴 boolean True if object contains default data.

isDowngraded() 공개 메소드

Does the message contain internationalized downgraded data (i.e. it is a "surrogate" message)?
부터: 2.11.0
public isDowngraded ( ) : boolean
리턴 boolean True if at least one message components has been downgraded.

merge() 공개 메소드

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() 공개 메소드

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() 공개 메소드

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() 공개 메소드

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() 공개 메소드

Set the internationalized downgraded status for the message.
부터: 2.11.0
public setDowngraded ( boolean $downgraded )
$downgraded boolean True if at least one message component has been downgraded.

setEnvelope() 공개 메소드

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

setFlags() 공개 메소드

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

setFullMsg() 공개 메소드

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

setHeaderText() 공개 메소드

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() 공개 메소드

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() 공개 메소드

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

setMimeHeader() 공개 메소드

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() 공개 메소드

Set the modified sequence value for the message.
public setModSeq ( integer $modseq )
$modseq integer The modseq value.

setSeq() 공개 메소드

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

setSize() 공개 메소드

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

setStructure() 공개 메소드

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

setUid() 공개 메소드

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

프로퍼티 상세

$_data 보호되어 있는 프로퍼티

Internal data array.
protected array $_data
리턴 array