Docs For Class rcube

Description

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

author: Thomas Bruederli <roundcube@gmail.com>

Located in /rcube_message.php (line 30)

Variable Summary

mixed $attachments

mixed $headers

mixed $is_safe

mixed $mime_parts

mixed $parts

mixed $sender

mixed $structure

mixed $subject

mixed $uid

Method Summary

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

static string unfold_flowed (string $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])

string get_part_url (string $mime_id)

bool has_html_part ()

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 54)

access: public

mixed $headers (line 50)

access: public

mixed $is_safe = false (line 57)

access: public

mixed $mime_parts = array() (line 53)

access: public

mixed $parts = array() (line 52)

access: public

mixed $sender = null (line 56)

access: public

mixed $structure (line 51)

access: public

mixed $subject = '' (line 55)

access: public

mixed $uid = null (line 49)

access: public

Methods

static format_flowed (line 724)

Wrap the given text to comply with RFC 2646

return: Wrapped text
access: public

string format_flowed (string $text, [int $length = 72])

string $text: Text to wrap
int $length: Length

static unfold_flowed (line 666)

Interpret a format=flowed message body according to RFC 2646

return: Interpreted text with unwrapped lines and stuffed space removed
access: public

string unfold_flowed (string $text)

string $text: Raw body formatted as flowed text

Constructor __construct (line 73)

__construct

Provide a uid, and parse message structure.

see: self::$app, self::$imap, self::$opt, self::$structure
uses: self::set_safe()
uses: rcube_imap::decode_mime_string()
uses: rcmail::get_instance()

rcube_message __construct (string $uid)

string $uid: The message UID.

first_html_part (line 202)

Return the first HTML part of this message

return: HTML message part content

string first_html_part ()

first_text_part (line 220)

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 117)

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 162)

Get content of a specific part of this message

return: Part content
access: public

string get_part_content (string $mime_id, [resource $fp = NULL])

string $mime_id: Part MIME-ID
resource $fp: File pointer to save the message part

get_part_url (line 146)

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)

string $mime_id: Part MIME-ID

has_html_part (line 184)

Determine if the message contains a HTML part

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

bool has_html_part ()

set_safe (line 133)

Set is_safe var and session data

access: public

void set_safe ([bool $safe = true])

bool $safe: enable/disable

tnef_decode (line 583)

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 619)

Parse message body for UUencoded attachments bodies

array uu_decode ( &$part, rcube_message_part $part)

rcube_message_part $part: Message part to decode
&$part