## Class Mail

Description

Mail implements a mail within the chat

- version: $Id: class.Mail.inc,v 1.9 2003/03/04 17:49:13 letreo Exp $
- access: public
- author: Michael Oertel <michael@ortelius.de>

Located in Program_Root/include/class.Mail.inc (line 40)

Variable Summary
string $body
integer $first_touch_recipient
integer $last_touch_recipient
integer $last_touch_sender
string $recipient
array $recipients
boolean $red_by_recipient
boolean $red_by_sender
object $sender
integer $send_time
string $subject
Method Summary
void Mail ()
void add_recipient (string $recipient)
void get_body (string 0)
void get_first_touch_recipient ()
void get_last_touch_recipient ()
void get_last_touch_sender ()
void get_recipient ()
array get_recipients ()
boolean get_red_by_recipient ()
boolean get_red_by_sender ()
string get_sender ()
integer get_send_time ()
string get_subject ()
void is_forwarded ()
boolean is_in_recipients (string $chatter)
void is_red_by_recipient ()
void is_red_by_sender ()
void is_replied ()
void set_body (string $body)
void set_first_touch_recipient ()
void set_last_touch_recipient ()
void set_last_touch_sender ()
void set_recipient (mixed $recipient)
void set_red_by_recipient ()
void set_red_by_sender ()
void set_send_time (integer $unix_timestamp)
void set_subject (string $subject)
Variables
string $body (line 68)

Body of mail

integer $first_touch_recipient (line 103)

Time of first touch by recipient

integer $last_touch_recipient (line 96)

Time of last touch by recipient

integer $last_touch_sender (line 89)

Time of last touch by sender

string $recipient (line 61)

Recipient of mail

array $recipients = array() (line 54)

Recipients of mail

boolean $red_by_recipient = false (line 117)

Status flag of mail

boolean $red_by_sender = false (line 110)

Status flag of mail

object $sender = null (line 47)

Sender of mail

integer $send_time (line 82)

Send time of mail

string $subject (line 75)

Subject of mail

Methods
Constructor Mail (line 121)
void Mail ()
add_recipient (line 132)

Adds a chatter to the list of recipients

- access: public

void add_recipient (string $recipient)

- string $recipient

get_body (line 199)

Gets the body of current mail

- access: public

void get_body (string 0)

- string 0

get_first_touch_recipient (line 361)

Gets the time of first touch by recipient

void get_first_touch_recipient ()
get_last_touch_recipient (line 343)

Gets the time of last touch by recipient

void get_last_touch_recipient ()
get_last_touch_sender (line 325)

Gets the time of last touch by sender

void get_last_touch_sender ()
get_recipient (line 231)
void get_recipient ()
get_recipients (line 221)

Gets the sender

- access: public

array get_recipients ()
get_red_by_recipient (line 269)

Returns true if mail is red by recipient, otherwise false

boolean get_red_by_recipient ()
get_red_by_sender (line 288)

Returns true if mail is red, otherwise false

boolean get_red_by_sender ()
get_sender (line 210)

Gets the sender

- access: public

string get_sender ()
get_send_time (line 177)

Gets the send time

- access: public

integer get_send_time ()
get_subject (line 155)

Provides the subject of mail

- access: public

string get_subject ()
is_forwarded (line 236)
void is_forwarded ()
is_in_recipients (line 307)

Returns true if given chatter already in recipient list, otherwise false

boolean is_in_recipients (string $chatter)

- string $chatter

is_red_by_recipient (line 277)

- ignore:

void is_red_by_recipient ()
is_red_by_sender (line 296)

- ignore:

void is_red_by_sender ()
is_replied (line 241)
void is_replied ()
set_body (line 188)

Sets the subject

- access: public

void set_body (string $body)

- string $body

set_first_touch_recipient (line 352)

Sets the time of first touch by recipient

void set_first_touch_recipient ()
set_last_touch_recipient (line 334)

Sets the time of last touch by recipient

void set_last_touch_recipient ()
set_last_touch_sender (line 316)

Sets the time of last touch by sender

void set_last_touch_sender ()
set_recipient (line 226)
void set_recipient (mixed $recipient)
set_red_by_recipient (line 250)

Sets red_by_recipient flag

void set_red_by_recipient ()
set_red_by_sender (line 259)

Sets red flag

void set_red_by_sender ()
set_send_time (line 166)

Sets the send time

- access: public

void set_send_time (integer $unix_timestamp)

- integer $unix_timestamp

set_subject (line 144)

Sets the subject

- access: public

void set_subject (string $subject)

- string $subject

Documention generated on Fri, 2 May 2003 10:50:46 +0200 by phpDocumentor 1.2.0rc2