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 /lib/Roundcube/rcube_message.php (line 28)

Variable Summary

mixed $attachments

mixed $folder

mixed $headers

mixed $inline_parts

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 $folder = null])

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], [int $max_bytes = 0])

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

bool has_html_part ([bool $enriched = false])

bool has_text_part ()

bool is_attachment (rcube_message_part $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 59)

access: public

mixed $folder (line 54)

access: public

mixed $headers (line 55)

access: public

mixed $inline_parts = array() (line 58)

access: public

mixed $is_safe = false (line 62)

access: public

mixed $mime_parts = array() (line 57)

access: public

mixed $parts = array() (line 56)

access: public

mixed $sender = null (line 61)

access: public

mixed $subject = '' (line 60)

access: public

mixed $uid (line 53)

access: public

Methods

static format_flowed (line 813)

access: public

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

$text
$length

static unfold_flowed (line 808)

Deprecated methods (to be removed)

access: public

void unfold_flowed ( $text)

$text

Constructor __construct (line 75)

__construct

Provide a uid, and parse message structure.

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

rcube_message __construct (string $uid, [string $folder = null])

string $uid: The message UID.
string $folder: Folder name

first_html_part (line 282)

Return the first HTML part of this message

return: HTML message part content

string first_html_part ()

first_text_part (line 299)

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

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

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], [int $max_bytes = 0])

string $mime_id: Part MIME-ID
resource $fp: File pointer to save the message part
boolean $skip_charset_conv: Disables charset conversion
int $max_bytes: Only read this number of bytes

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, [mixed $embed = false])

string $mime_id: Part MIME-ID
mixed $embed: Mimetype class for parts to be embedded

has_html_part (line 203)

Determine if the message contains a HTML part. This must to be

a real part not an attachment (or its part) This must to be a real part not an attachment (or its part)

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

bool has_html_part ([bool $enriched = false])

bool $enriched: Enables checking for text/enriched parts too

has_text_part (line 243)

Determine if the message contains a text/plain part. This must to be a real part not an attachment (or its part)

return: True if a plain text part is available, False if not

bool has_text_part ()

is_attachment (line 331)

Checks if part of the message is an attachment (or part of it)

return: True if the part is an attachment part
access: public

bool is_attachment (rcube_message_part $part)

rcube_message_part $part: Message part

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

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

Parse message body for UUencoded attachments bodies

array uu_decode ( &$part, rcube_message_part $part)

rcube_message_part $part: Message part to decode
&$part