Properties

$id

$id : int

Message sequence number

Type

int —

$uid

$uid : int

Message unique identifier

Type

int —

$subject

$subject : string

Message subject

Type

string —

$from

$from : string

Message sender (From)

Type

string —

$to

$to : string

Message recipient (To)

Type

string —

$cc

$cc : string

Message additional recipients (Cc)

Type

string —

$bcc

$bcc : string

Message hidden recipients (Bcc)

Type

string —

$replyto

$replyto : string

Message Reply-To header

Type

string —

$in_reply_to

$in_reply_to : string

Message In-Reply-To header

Type

string —

$date

$date : string

Message date (Date)

Type

string —

$messageID

$messageID : string

Message identifier (Message-ID)

Type

string —

$size

$size : int

Message size

Type

int —

$encoding

$encoding : string

Message encoding

Type

string —

$charset

$charset : string

Message charset

Type

string —

$ctype

$ctype : string

Message Content-type

Type

string —

$timestamp

$timestamp : int

Message timestamp (based on message date)

Type

int —

$bodystructure

$bodystructure : string

IMAP bodystructure string

Type

string —

$body

$body : string

IMAP body (RFC822.TEXT)

Type

string —

$bodypart

$bodypart : array

IMAP part bodies

Type

array —

$internaldate

$internaldate : string

IMAP internal date

Type

string —

$references

$references : string

Message References header

Type

string —

$priority

$priority : int

Message priority (X-Priority)

Type

int —

$mdn_to

$mdn_to : string

Message receipt recipient

Type

string —

$folder

$folder : string

IMAP folder this message is stored in

Type

string —

$others

$others : array

Other message headers

Type

array —

$flags

$flags : array

Message flags

Type

array —

$list_flags

$list_flags : array

Extra flags (for the messages list)

Type

array —

$list_cols

$list_cols : array

Extra columns content (for the messages list)

Type

array —

$structure

$structure : \rcube_message_part

Message structure

Type

rcube_message_part —

$depth

$depth : int

Message thread depth

Type

int —

$has_children

$has_children : bool

Whether the message has references in the thread

Type

bool —

$flagged_children

$flagged_children : int

Number of flagged children (in a thread)

Type

int —

$unread_children

$unread_children : int

Number of unread children (in a thread)

Type

int —

$parent_uid

$parent_uid : int

UID of the message parent (in a thread)

Type

int —

$modseq

$modseq : int

IMAP MODSEQ value

Type

int —

$envelope

$envelope : string

IMAP ENVELOPE

Type

string —

$obj_headers

$obj_headers : array

Header name to rcube_message_header object property map

Type

array —

Methods

get()

get(string  $name, bool  $decode = true) : string|null

Returns header value

Parameters

string $name

Header name

bool $decode

Decode the header content

Returns

string|null —

Header content

set()

set(string  $name, string  $value) : mixed

Sets header value

Parameters

string $name

Header name

string $value

Header content

Returns

mixed —

from_array()

from_array(array  $arr) : \rcube_message_header

Factory method to instantiate headers from a data array

Parameters

array $arr

Hash array with header values

Returns

\rcube_message_header —

instance filled with headers values