PHP 클래스 Horde_ActiveSync_Imap_MessageBodyData, horde

저자: Michael J Rubinsky ([email protected])
파일 보기 프로젝트 열기: horde/horde

보호된 프로퍼티들

프로퍼티 타입 설명
$_basePart Horde_ActiveSync_Mime
$_bodyPart array
$_html array
$_imap Horde_ActiveSync_Imap_Adapter
$_mbox Horde_Imap_Client_Mailbox
$_options array
$_plain arary
$_uid integer
$_validatedHtml boolean Flag to indicate self::$_html is validated.
$_validatedPlain boolean Flag to indicate self::$_Plain is validated.
$_version float

공개 메소드들

메소드 설명
__construct ( array $params, array $options ) Const'r
__destruct ( )
__get ( $property )
__set ( $property, $value )
bodyPartBody ( ) : array Return the validated BODYPART data.
getBodyTypePreference ( $save_bandwidth = false ) : integer Return the BODYTYPE to return to the client. Takes BODYPREF and available parts into account.
htmlBody ( ) : array Return the validated text/html body data.
plainBody ( ) : array Return the validated text/plain body data.
toArray ( ) : array Return the body data in array format. Needed for BC.

보호된 메소드들

메소드 설명
_fetchData ( array $params ) : Horde_Imap_Client_Data_Fetch Fetch data from the IMAP client.
_getBodyPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $mime, boolean $to_html ) : array Build the data needed for the BodyPart part.
_getHtmlPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $html_mime, boolean $convert_to_plain ) : array Build the data needed for the html part.
_getParts ( ) Determine which parts we need, and fetches them from the IMAP client.
_getPlainPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $text_mime ) : array Build the data needed for the plain part.
_validateBodyData ( array &$data ) : array Validate the body data to ensure consistent EOL and UTF8 data. Returns body data in a stream object.
_wantHtml ( ) : boolean Return if we want HTML data.
_wantPlainText ( string $html_id, boolean $want_html ) : boolean Return if we want plain text data.

메소드 상세

__construct() 공개 메소드

Const'r
public __construct ( array $params, array $options )
$params array Parameters: - imap: (Horde_Imap_Client_Base) The IMAP client. - mbox: (Horde_Imap_Client_Mailbox) The mailbox. - uid: (integer) The message UID. - mime: (Horde_ActiveSync_Mime) The MIME object.
$options array The options array.

__destruct() 공개 메소드

public __destruct ( )

__get() 공개 메소드

public __get ( $property )

__set() 공개 메소드

public __set ( $property, $value )

_fetchData() 보호된 메소드

Fetch data from the IMAP client.
protected _fetchData ( array $params ) : Horde_Imap_Client_Data_Fetch
$params array Parameter array. - html_id (string) The MIME id of the HTML part, if any. - text_id (string) The MIME id of the plain part, if any.
리턴 Horde_Imap_Client_Data_Fetch The results.

_getBodyPart() 보호된 메소드

Build the data needed for the BodyPart part.
protected _getBodyPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $mime, boolean $to_html ) : array
$data Horde_Imap_Client_Data_Fetch The FETCH results.
$mime Horde_Mime_Part The plaintext MIME part.
$to_html boolean If true, $id is assumed to be a text/plain part and is converted to html.
리턴 array The BodyPart data. - charset: (string) The charset of the text. - body: (string) The body text. - truncated: (boolean) True if text was truncated. - size: (integer) The original part size, in bytes.

_getHtmlPart() 보호된 메소드

Build the data needed for the html part.
protected _getHtmlPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $html_mime, boolean $convert_to_plain ) : array
$data Horde_Imap_Client_Data_Fetch FETCH results.
$html_mime Horde_Mime_Part The text/html MIME part.
$convert_to_plain boolean Convert text to plain text also? If true, will also return a 'plain' array.
리턴 array An array containing 'html' and if $convert_to_true is set, a 'plain' part as well. @see self::_getPlainPart for structure of each entry.

_getParts() 보호된 메소드

Takes into account the available parts and the BODYPREF/BODYPARTPREF options.
protected _getParts ( )

_getPlainPart() 보호된 메소드

Build the data needed for the plain part.
protected _getPlainPart ( Horde_Imap_Client_Data_Fetch $data, Horde_Mime_Part $text_mime ) : array
$data Horde_Imap_Client_Data_Fetch The FETCH results.
$text_mime Horde_Mime_Part The plaintext MIME part.
리턴 array The plain part data. - charset: (string) The charset of the text. - body: (string) The body text. - truncated: (boolean) True if text was truncated. - size: (integer) The original part size, in bytes.

_validateBodyData() 보호된 메소드

Validate the body data to ensure consistent EOL and UTF8 data. Returns body data in a stream object.
protected _validateBodyData ( array &$data ) : array
$data array The body data. @see self::_bodyPartText() for structure.
리턴 array The validated body data array. @see self::_bodyPartText()

_wantHtml() 보호된 메소드

Return if we want HTML data.
protected _wantHtml ( ) : boolean
리턴 boolean True if HTML data is needed.

_wantPlainText() 보호된 메소드

Return if we want plain text data.
protected _wantPlainText ( string $html_id, boolean $want_html ) : boolean
$html_id string The MIME id of any HTML part, if available. Used to detect if we need to fetch the plain part if we are requesting HTML, but only have plain.
$want_html boolean True if the client wants HTML.
리턴 boolean True if plain data is needed.

bodyPartBody() 공개 메소드

Return the validated BODYPART data.
public bodyPartBody ( ) : array
리턴 array The validated body data array: - charset: (string) The charset of the text. - body: (Horde_Stream) The body text in a stream. - truncated: (boolean) True if text was truncated. - size: (integer) The original part size, in bytes.

getBodyTypePreference() 공개 메소드

Return the BODYTYPE to return to the client. Takes BODYPREF and available parts into account.
public getBodyTypePreference ( $save_bandwidth = false ) : integer
리턴 integer A Horde_ActiveSync::BODYPREF_TYPE_* constant.

htmlBody() 공개 메소드

Return the validated text/html body data.
public htmlBody ( ) : array
리턴 array The validated body data array: - charset: (string) The charset of the text. - body: (Horde_Stream) The body text in a stream. - truncated: (boolean) True if text was truncated. - size: (integer) The original part size, in bytes.

plainBody() 공개 메소드

Return the validated text/plain body data.
public plainBody ( ) : array
리턴 array The validated body data array: - charset: (string) The charset of the text. - body: (Horde_Stream) The body text in a stream. - truncated: (boolean) True if text was truncated. - size: (integer) The original part size, in bytes.

toArray() 공개 메소드

Return the body data in array format. Needed for BC.
public toArray ( ) : array
리턴 array

프로퍼티 상세

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

protected Horde_ActiveSync_Mime $_basePart
리턴 Horde_ActiveSync_Mime

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

protected array $_bodyPart
리턴 array

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

protected array $_html
리턴 array

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

protected Horde_ActiveSync_Imap_Adapter $_imap
리턴 Horde_ActiveSync_Imap_Adapter

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

protected Horde_Imap_Client_Mailbox $_mbox
리턴 Horde_Imap_Client_Mailbox

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

protected array $_options
리턴 array

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

protected arary $_plain
리턴 arary

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

protected int $_uid
리턴 integer

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

Flag to indicate self::$_html is validated.
protected bool $_validatedHtml
리턴 boolean

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

Flag to indicate self::$_Plain is validated.
protected bool $_validatedPlain
리턴 boolean

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

protected float $_version
리턴 float