Docs For Class Mailbox

Description

Implements a Mailbox within the chat

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

Located in /include/class.Mailbox.inc (line 42)

Variable Summary

array $bodies

integer $connection_count

object $db

array $mailbox

array $mails

array $recipients

array $subjects

array $times

string $type

integer $unread_mail_count

Method Summary

Mailbox Mailbox ($box $box_type)

void connect ()

boolean delete_mail (mixed $key)

void disconnect ()

string get_chatter (object $mail, mixed $chatter)

array get_current_mail (mixed $key)

integer get_mail_count ()

string get_type ()

integer get_unread_mail_count ()

boolean is_empty ()

boolean _load_mails ()

Variables

array $bodies = array() (line 76)

integer $connection_count = 0 (line 56)

see: Mailbox::disconnect()
see: Mailbox::connect()

object $db (line 49)

see: Mailbox::connect()
access: private

array $mailbox = array() (line 61)

array $mails = array() (line 66)

array $recipients = array() (line 86)

array $subjects = array() (line 71)

array $times = array() (line 81)

string $type = '' (line 91)

integer $unread_mail_count = 0 (line 96)

Methods

Constructor Mailbox (line 104)

Implements a mailbox

Constructor

Mailbox Mailbox ($box $box_type)

$box $box_type: string

connect (line 145)

Connect to the database

Connect to the database Establish a database connection

access: public

void connect ()

delete_mail (line 277)

Deletes an mail-object in current mailbox

access: public

boolean delete_mail (mixed $key)

disconnect (line 166)

Disconnect the database

see: Mailbox::connect()
access: public

void disconnect ()

get_chatter (line 292)

Provides the name of sender or recipient of given mail

access: public

string get_chatter (object $mail, mixed $chatter)

object $mail

get_current_mail (line 263)

Provides an mail-object of current mailbox

access: public

array get_current_mail (mixed $key)

get_mail_count (line 230)

Provides the count of mails in the current mailbox

access: public

integer get_mail_count ()

get_type (line 252)

Provides the type of mailbox

access: public

string get_type ()

get_unread_mail_count (line 241)

Provides the count of *new* mails in the current mailbox

access: public

integer get_unread_mail_count ()

is_empty (line 219)

Provides the fill level of mailbox

access: public

boolean is_empty ()

_load_mails (line 192)

Loads all mail objects into an arrays

access: private

boolean _load_mails ()