Docs For Class rcube

Description

Logical representation of a mail message with all its data and related functions

author: Thomas Bruederli <[email protected]>

Located in /rcube_message.php (line 33)

Variable Summary

mixed $attachments

mixed $headers

mixed $is_safe

mixed $mime_parts

mixed $parts

mixed $sender

mixed $subject

mixed $uid

Method Summary

static void format_flowed ( $text, [ $length = 72])

static void unfold_flowed ( $text)

rcube_message __construct (string $uid)

string first_html_part ()

string first_text_part ([ &$part = null], rcube_message_part $part)

string get_header (string $name, [ $raw = false], bool $row)

string get_part_content (string $mime_id, [resource $fp = null], [boolean $skip_charset_conv = false])

string get_part_url (string $mime_id, [ $embed = false])

bool has_html_part ([bool $recursive = true])

void set_safe ([bool $safe = true])

array tnef_decode ( &$part, rcube_message_part $part)

array uu_decode ( &$part, rcube_message_part $part)

Variables

mixed $attachments = array() (line 63)

access: public

mixed $headers (line 60)

access: public

mixed $is_safe = false (line 66)

access: public

mixed $mime_parts = array() (line 62)

access: public

mixed $parts = array() (line 61)

access: public

mixed $sender = null (line 65)

access: public

mixed $subject = '' (line 64)

access: public

mixed $uid = null (line 59)

access: public

Methods

static format_flowed (line 707)

access: public

void format_flowed ( $text, [ $length = 72])

$text
$length

static unfold_flowed (line 702)

Deprecated methods (to be removed)

access: public

void unfold_flowed ( $text)

$text

Constructor __construct (line 78)

__construct

Provide a uid, and parse message structure.

see: self::$app, self::$storage, self::$opt, self::$parts

rcube_message __construct (string $uid)

string $uid: The message UID.

first_html_part (line 234)

Return the first HTML part of this message

return: HTML message part content

string first_html_part ()

first_text_part (line 251)

Return the first text part of this message

return: Plain text message/part content

string first_text_part ([ &$part = null], rcube_message_part $part)

rcube_message_part $part: Reference to the part if found
&$part

get_header (line 123)

Return a (decoded) message header

return: Header value
access: public

string get_header (string $name, [ $raw = false], bool $row)

string $name: Header name
bool $row: Don't mime-decode the value
$raw

get_part_content (line 173)

Get content of a specific part of this message

return: Part content
access: public

string get_part_content (string $mime_id, [resource $fp = null], [boolean $skip_charset_conv = false])

string $mime_id: Part MIME-ID
resource $fp: File pointer to save the message part
boolean $skip_charset_conv: Disables charset conversion

get_part_url (line 155)

Compose a valid URL for getting a message part

return: URL or false if part does not exist
access: public

string get_part_url (string $mime_id, [ $embed = false])

string $mime_id: Part MIME-ID
$embed

has_html_part (line 197)

Determine if the message contains a HTML part

return: True if a HTML is available, False if not

bool has_html_part ([bool $recursive = true])

bool $recursive: Enables checking in all levels of the structure

set_safe (line 142)

Set is_safe var and session data

access: public

void set_safe ([bool $safe = true])

bool $safe: enable/disable

tnef_decode (line 612)

Decode a Microsoft Outlook TNEF part (winmail.dat)

array tnef_decode ( &$part, rcube_message_part $part)

rcube_message_part $part: Message part to decode
&$part

uu_decode (line 648)

Parse message body for UUencoded attachments bodies

array uu_decode ( &$part, rcube_message_part $part)

rcube_message_part $part: Message part to decode
&$part