Docs For Class rcube

rcube_mime

Description

Class for parsing MIME messages

author: Thomas Bruederli <[email protected]>
author: Aleksander Machniak <[email protected]>

Located in /rcube_mime.php (line 35)

Method Summary

static string decode (string $input, [string $encoding = '7bit'])

static array decode_address_list (string $input, [int $max = null], [boolean $decode = true], [string $fallback = null])

static string decode_header (string $input, [string $fallback = null])

static string decode_mime_string (string $input, [string $fallback = null])

static array explode_header_string (string $separator, string $str, [bool $remove_comments = false])

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

static void parse_headers ( $headers)

static object rcube_message_part parse_message (string $raw_body)

static string unfold_flowed (string $text)

rcube_mime __construct ([ $default_charset = null])

Methods

static decode (line 283)

Decode a mime part

return: Decoded string
access: public

string decode (string $input, [string $encoding = '7bit'])

string $input: Input string
string $encoding: Part encoding

static decode_address_list (line 125)

Split an address list into a structured array list

return: Indexed list of addresses

array decode_address_list (string $input, [int $max = null], [boolean $decode = true], [string $fallback = null])

string $input: Input string
int $max: List only this number of addresses
boolean $decode: Decode address strings
string $fallback: Fallback charset if none specified

static decode_header (line 171)

Decode a message header value

return: Decoded string
access: public

string decode_header (string $input, [string $fallback = null])

string $input: Header value
string $fallback: Fallback charset if none specified

static decode_mime_string (line 187)

Decode a mime-encoded string to internal charset

return: Decoded string
access: public

string decode_mime_string (string $input, [string $fallback = null])

string $input: Header value
string $fallback: Fallback charset if none specified

static explode_header_string (line 393)

Explodes header (e.g. address-list) string into array of strings using specified separator characters with proper handling of quoted-strings and comments (RFC2822)

return: Header items
access: public

array explode_header_string (string $separator, string $str, [bool $remove_comments = false])

string $separator: String containing separator characters
string $str: Header string
bool $remove_comments: Enable to remove comments

static format_flowed (line 523)

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 parse_headers (line 306)

Split RFC822 header string into an associative array

access: public

void parse_headers ( $headers)

$headers

static parse_message (line 63)

Parse the given raw message source and return a structure of rcube_message_part objects.

It makes use of the PEAR:Mail_mimeDecode library

return: The message structure
access: public

object rcube_message_part parse_message (string $raw_body)

string $raw_body: The message source

static unfold_flowed (line 464)

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

Object constructor.

rcube_mime __construct ([ $default_charset = null])

$default_charset

Documentation generated on Wed, 23 May 2012 16:40:52 +0200 by phpDocumentor 1.4.4