Docs For Class Mail

Description

Mail implements a mail within the chat

version: $Id: class.Mail.inc,v 1.10 2003/08/06 12:19:36 letreo Exp $
access: public
author: Michael Oertel <michael@ortelius.de>

Located in /include/class.Mail.inc (line 41)

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

Mail 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_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 69)

Body of mail

integer $first_touch_recipient = 0 (line 104)

Time of first touch by recipient

integer $last_touch_recipient = 0 (line 97)

Time of last touch by recipient

integer $last_touch_sender = 0 (line 90)

Time of last touch by sender

string $recipient = '' (line 62)

Recipient of mail

array $recipients = array() (line 55)

Recipients of mail

boolean $red_by_recipient = false (line 118)

Status flag of mail

boolean $red_by_sender = false (line 111)

Status flag of mail

object $sender = null (line 48)

Sender of mail

integer $send_time = 0 (line 83)

Send time of mail

string $subject = '' (line 76)

Subject of mail

Methods

Constructor Mail (line 122)

Mail Mail ()

add_recipient (line 133)

Adds a chatter to the list of recipients

access: public

void add_recipient (string $recipient)

string $recipient

get_body (line 200)

Gets the body of current mail

access: public

void get_body (string 0)

string 0

get_first_touch_recipient (line 362)

Gets the time of first touch by recipient

void get_first_touch_recipient ()

get_last_touch_recipient (line 344)

Gets the time of last touch by recipient

void get_last_touch_recipient ()

get_last_touch_sender (line 326)

Gets the time of last touch by sender

void get_last_touch_sender ()

get_recipient (line 232)

void get_recipient ()

get_recipients (line 222)

Gets the sender

access: public

array get_recipients ()

get_red_by_recipient (line 270)

Returns true if mail is red by recipient, otherwise false

boolean get_red_by_recipient ()

get_red_by_sender (line 289)

Returns true if mail is red, otherwise false

boolean get_red_by_sender ()

get_sender (line 211)

Gets the sender

access: public

string get_sender ()

get_send_time (line 178)

Gets the send time

access: public

integer get_send_time ()

get_subject (line 156)

Provides the subject of mail

access: public

string get_subject ()

is_forwarded (line 237)

void is_forwarded ()

is_in_recipients (line 308)

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

boolean is_in_recipients (string $chatter)

string $chatter

is_replied (line 242)

void is_replied ()

set_body (line 189)

Sets the subject

access: public

void set_body (string $body)

string $body

set_first_touch_recipient (line 353)

Sets the time of first touch by recipient

void set_first_touch_recipient ()

set_last_touch_recipient (line 335)

Sets the time of last touch by recipient

void set_last_touch_recipient ()

set_last_touch_sender (line 317)

Sets the time of last touch by sender

void set_last_touch_sender ()

set_recipient (line 227)

void set_recipient (mixed $recipient)

set_red_by_recipient (line 251)

Sets red_by_recipient flag

void set_red_by_recipient ()

set_red_by_sender (line 260)

Sets red flag

void set_red_by_sender ()

set_send_time (line 167)

Sets the send time

access: public

void set_send_time (integer $unix_timestamp)

integer $unix_timestamp

set_subject (line 145)

Sets the subject

access: public

void set_subject (string $subject)

string $subject