ilMailbox Class Reference

Mail Box class Base class for creating and handling mail boxes. More...

Collaboration diagram for ilMailbox:

Public Member Functions
	__construct ($a_user_id=0)
	ilMailbox constructor. More...
	getInboxFolder ()
	get Id of the inbox folder of an user More...
	getDraftsFolder ()
	get Id of the inbox folder of an user More...
	getTrashFolder ()
	get Id of the trash folder of an user More...
	getSentFolder ()
	get Id of the sent folder of an user More...
	getRootFolderId ()
	get Id of the root folder of an user More...
	getActions ($a_mobj_id)
	get all possible actions if no mobj_id is given or folder specific actions if mobj_id is given More...
	createDefaultFolder ()
	Creates all default folders for a user. More...
	addFolder ($a_parent_id, $a_folder_name)
	Adds a new mail folder with the passed name under the given parent folder. More...
	renameFolder ($a_obj_id, $a_new_folder_name)
	Rename a folder and check if the name already exists. More...
	deleteFolder ($a_folder_id)
	getFolderData ($a_obj_id)
	Fetches the data of a specific folder. More...
	getParentFolderId ($a_obj_id)
	Get id of parent folder. More...
	getSubFolders ($a_folder=0, $a_folder_parent=0)
	Get all folders under a given folder/node id. More...
	setUserId ($a_user_id)
	delete ()
	deletes user's mailbox and all db entries related to mailbox TODO: stefan, bitte nochmal kontrollieren, ob auch wirklich alles gel�scht wird. More...
	updateMailsOfDeletedUser ($nameToShow)
	Update existing mails. More...

Protected Member Functions
	folderNameExists ($a_folder_name)
	Checks whether or not the passed folder name exists in the context of the folder owner. More...

Protected Attributes
	$ilias
	$lng
	$db
	$mtree
	$user_id
	$actions = array()
	$default_folder = array()
	$table_mail_obj_data
	$table_tree

Detailed Description

Mail Box class Base class for creating and handling mail boxes.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 14 of file class.ilMailbox.php.

Constructor & Destructor Documentation

__construct()

ilMailbox::__construct

(

$a_user_id = 0

)

ilMailbox constructor.

Parameters

int

$a_user_id

Definition at line 70 of file class.ilMailbox.php.

References $DIC, and array.

    {
        global $DIC;

        $this->ilias = $DIC['ilias'];
        $this->lng   = $DIC->language();
        $this->db    = $DIC->database();

        $this->user_id = $a_user_id;

        $this->table_mail_obj_data = 'mail_obj_data';
        $this->table_tree = 'mail_tree';

        if ($a_user_id) {
            $this->mtree = new ilTree($this->user_id);
            $this->mtree->setTableNames($this->table_tree, $this->table_mail_obj_data);
        }

        // i added this, becaus if i create a new user automatically during
        // CAS authentication, we have no $lng variable (alex, 16.6.2006)
        // (alternative: make createDefaultFolder call static in ilObjUser->saveAsNew())
        if (is_object($this->lng)) {
            $this->lng->loadLanguageModule("mail");

            $this->actions = array(
                "moveMails"        => $this->lng->txt("mail_move_to"),
                "markMailsRead"   => $this->lng->txt("mail_mark_read"),
                "markMailsUnread" => $this->lng->txt("mail_mark_unread"),
                "deleteMails"      => $this->lng->txt("delete"));
        }
        
        // array contains basic folders and there lng translation for every new user
        $this->default_folder = array(
            "b_inbox"     => "inbox",
            "c_trash"     => "trash",
            "d_drafts"    => "drafts",
            "e_sent"      => "sent",
            "z_local"     => "local");
    }

Member Function Documentation

addFolder()

ilMailbox::addFolder	(		$a_parent_id,
			$a_folder_name
	)

Adds a new mail folder with the passed name under the given parent folder.

Parameters

integer	$a_parent_id	Id of parent folder
string	$a_folder_name	Name of tje folder to be created

Returns

integer The new id of the created folder

Definition at line 259 of file class.ilMailbox.php.

References array, and folderNameExists().

    {
        if ($this->folderNameExists($a_folder_name)) {
            return 0;
        }

        $next_id = $this->db->nextId($this->table_mail_obj_data);
        $this->db->manipulateF(
            '
                        INSERT INTO ' . $this->table_mail_obj_data . '
                        (       obj_id,
                                user_id,
                                title,
                                m_type 
                         )
                         VALUES(%s,%s,%s,%s)',
            array('integer','integer', 'text', 'text'),
            array($next_id, $this->user_id, $a_folder_name, 'user_folder')
        );
        $this->mtree->insertNode($next_id, $a_parent_id);

        return $next_id;
    }

Here is the call graph for this function:

createDefaultFolder()

ilMailbox::createDefaultFolder

(

)

Creates all default folders for a user.

This method should only be called when a user object is created.

Definition at line 218 of file class.ilMailbox.php.

References $key, and array.

    {
        $root_id = $this->db->nextId($this->table_mail_obj_data);
        $this->db->manipulateF(
            '
                        INSERT INTO ' . $this->table_mail_obj_data . ' 
                        (       obj_id,
                                user_id,
                                title,
                                m_type
                        )
                        VALUES(%s, %s, %s, %s)',
            array('integer','integer', 'text', 'text'),
            array($root_id, $this->user_id, 'a_root', 'root')
        );
        $this->mtree->addTree($this->user_id, $root_id);

        foreach ($this->default_folder as $key => $folder) {
            $last_id = $this->db->nextId($this->table_mail_obj_data);
            $this->db->manipulateF(
                '
                                INSERT INTO ' . $this->table_mail_obj_data . ' 
                                (       obj_id,
                                        user_id,
                                        title,
                                        m_type
                                )
                                VALUES(%s, %s, %s, %s)',
                array('integer','integer', 'text', 'text'),
                array($last_id, $this->user_id, $key, $folder)
            );
            $this->mtree->insertNode($last_id, $root_id);
        }
    }

delete()

ilMailbox::delete

(

)

deletes user's mailbox and all db entries related to mailbox TODO: stefan, bitte nochmal kontrollieren, ob auch wirklich alles gel�scht wird.

Vielleicht hab ich was �bersehen. - shofmann, 15.7.03

Returns

boolean true on successful deletion

Definition at line 485 of file class.ilMailbox.php.

References array.

    {
        $this->db->manipulateF(
            '
                        DELETE FROM mail_obj_data WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_options WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_saved WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_tree WHERE tree = %s',
            array('integer'),
            array($this->user_id)
        );

        // Delete the user's files from filesystem: This has to be done before deleting the database entries in table 'mail'
        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
        $fdm = new ilFileDataMail($this->user_id);
        $fdm->onUserDelete();
        
        // Delete mails of deleted user
        $this->db->manipulateF(
            'DELETE FROM mail WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        return true;
    }

deleteFolder()

ilMailbox::deleteFolder

(

$a_folder_id

)

Parameters

int

$a_folder_id

Returns

bool

Exceptions

ilInvalidTreeStructureException

Definition at line 332 of file class.ilMailbox.php.

References $query, $row, and array.

    {
        $query = $this->db->queryf(
            '
                        SELECT obj_id, title FROM mail_obj_data
                        WHERE obj_id = %s AND user_id = %s',
            array('integer', 'integer'),
            array($a_folder_id, $this->user_id)
        );
        $row = $this->db->fetchAssoc($query);

        if (!is_array($row) || array_key_exists($row['title'], $this->default_folder)) {
            return false;
        }

        require_once 'Services/Mail/classes/class.ilMail.php';
        $umail = new ilMail($this->user_id);

        $subtree = $this->mtree->getSubtree($this->mtree->getNodeData($a_folder_id));
        $this->mtree->deleteTree($this->mtree->getNodeData($a_folder_id));

        foreach ($subtree as $node) {
            $mails    = $umail->getMailsOfFolder($node["obj_id"]);
            $mail_ids = array();
            foreach ($mails as $mail) {
                $mail_ids[] = $mail["mail_id"];
            }

            $umail->deleteMails($mail_ids);

            $this->db->manipulateF(
                '
                                DELETE FROM ' . $this->table_mail_obj_data . ' 
                                WHERE obj_id = %s AND user_id = %s',
                array('integer', 'integer'),
                array($node['obj_id'], $this->user_id)
            );
        }

        return true;
    }

folderNameExists()

ilMailbox::folderNameExists (   $a_folder_name )

protected

Checks whether or not the passed folder name exists in the context of the folder owner.

Parameters

string

$a_folder_name

The new name of folder

Returns

boolean

Definition at line 312 of file class.ilMailbox.php.

References $res, $row, and array.

Referenced by addFolder(), and renameFolder().

    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND title = %s',
            array('integer', 'text'),
            array($this->user_id, $a_folder_name)
        );
        $row = $this->db->fetchAssoc($res);

        return is_array($row) && $row['obj_id'] > 0 ? true : false;
    }

Here is the caller graph for this function:

getActions()

ilMailbox::getActions

(

$a_mobj_id

)

get all possible actions if no mobj_id is given or folder specific actions if mobj_id is given

Parameters

integer

mobj_id public

Returns

array possible actions

Definition at line 201 of file class.ilMailbox.php.

References $actions, and getFolderData().

    {
        if ($a_mobj_id) {
            $folder_data = $this->getFolderData($a_mobj_id);

            if ($folder_data["type"] == "user_folder" or $folder_data["type"] == "local") {
                #return array_merge($this->actions,array("add" => $this->lng->txt("mail_add_subfolder")));
                return $this->actions;
            }
        }

        return $this->actions;
    }

Here is the call graph for this function:

getDraftsFolder()

ilMailbox::getDraftsFolder

(

)

get Id of the inbox folder of an user

Definition at line 132 of file class.ilMailbox.php.

References $res, $row, and array.

    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'drafts')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

getFolderData()

ilMailbox::getFolderData

(

$a_obj_id

)

Fetches the data of a specific folder.

Parameters

integer

$a_obj_id

Returns

array

Definition at line 379 of file class.ilMailbox.php.

References $res, $row, and array.

Referenced by getActions().

    {
        $res = $this->db->queryF(
            '
                        SELECT * FROM ' . $this->table_mail_obj_data . ' 
                        WHERE user_id = %s
                        AND obj_id = %s',
            array('integer', 'integer'),
            array($this->user_id, $a_obj_id)
        );
        $row = $this->db->fetchAssoc($res);

        return array(
            'obj_id' => $row['obj_id'],
            'title'  => $row['title'],
            'type'   => $row['m_type']
        );
    }

Here is the caller graph for this function:

getInboxFolder()

ilMailbox::getInboxFolder

(

)

get Id of the inbox folder of an user

Definition at line 113 of file class.ilMailbox.php.

References $res, $row, and array.

    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'inbox')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

getParentFolderId()

ilMailbox::getParentFolderId

(

$a_obj_id

)

Get id of parent folder.

Parameters

integer

$a_obj_id

Returns

int

Definition at line 403 of file class.ilMailbox.php.

References $res, $row, and array.

    {
        $res = $this->db->queryF(
            '
                        SELECT * FROM  ' . $this->table_tree . ' 
                        WHERE child = %s AND tree = %s',
            array('integer', 'integer'),
            array($a_obj_id, $this->user_id)
        );
        $row = $this->db->fetchAssoc($res);

        return is_array($row) ? $row['parent'] : 0;
    }

getRootFolderId()

ilMailbox::getRootFolderId

(

)

get Id of the root folder of an user

Definition at line 189 of file class.ilMailbox.php.

Referenced by getSubFolders().

    {
        return $this->mtree->getRootID($this->user_id);
    }

Here is the caller graph for this function:

getSentFolder()

ilMailbox::getSentFolder

(

)

get Id of the sent folder of an user

Definition at line 170 of file class.ilMailbox.php.

References $res, $row, and array.

    {
        $res = $this->db->queryf(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'sent')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

getSubFolders()

ilMailbox::getSubFolders	(		$a_folder = 0,
			$a_folder_parent = 0
	)

Get all folders under a given folder/node id.

Parameters

int	$a_folder
int	$a_folder_parent

Returns

array

Definition at line 423 of file class.ilMailbox.php.

References $key, $res, $row, array, and getRootFolderId().

    {
        if (!$a_folder) {
            $a_folder = $this->getRootFolderId();
        }

        $user_folder = array();

        foreach ($this->default_folder as $key => $value) {
            $res = $this->db->queryF(
                '
                                SELECT obj_id, m_type
                                FROM ' . $this->table_mail_obj_data . ' 
                                WHERE user_id = %s
                                AND title = %s',
                array('integer', 'text'),
                array($this->user_id, $key)
            );
            $row = $this->db->fetchAssoc($res);

            $user_folder[] = array(
                'title'  => $key,
                'type'   => $row['m_type'],
                'obj_id' => $row['obj_id']
            );
        }

        $res = $this->db->queryF(
            '
                        SELECT * FROM ' . $this->table_tree . ', ' . $this->table_mail_obj_data . '
                        WHERE ' . $this->table_mail_obj_data . '.obj_id = ' . $this->table_tree . '.child 
                        AND ' . $this->table_tree . '.depth  > %s
                        AND ' . $this->table_tree . '.tree  = %s
                        ORDER BY ' . $this->table_tree . '.lft, ' . $this->table_mail_obj_data . '.title  ',
            array('integer', 'integer'),
            array(2, $this->user_id)
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $user_folder[] = array(
                'title'  => $row['title'],
                'type'   => $row['m_type'],
                'obj_id' => $row['child']
            );
        }

        return $user_folder;
    }

Here is the call graph for this function:

getTrashFolder()

ilMailbox::getTrashFolder

(

)

get Id of the trash folder of an user

Definition at line 151 of file class.ilMailbox.php.

References $res, $row, and array.

    {
        $res = $this->db->queryf(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'trash')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

renameFolder()

ilMailbox::renameFolder	(		$a_obj_id,
			$a_new_folder_name
	)

Rename a folder and check if the name already exists.

Parameters

integer	$a_obj_id	The id of the folder to be renamed
string	$a_new_folder_name	The new name of the folder

Returns

boolean

Definition at line 289 of file class.ilMailbox.php.

References array, and folderNameExists().

    {
        if ($this->folderNameExists($a_new_folder_name)) {
            return false;
        }

        $this->db->manipulateF(
            '
                        UPDATE ' . $this->table_mail_obj_data . '
                        SET title = %s
                        WHERE obj_id = %s AND user_id = %s',
            array('text', 'integer', 'integer'),
            array($a_new_folder_name, $a_obj_id, $this->user_id)
        );

        return true;
    }

Here is the call graph for this function:

setUserId()

ilMailbox::setUserId

(

$a_user_id

)

Parameters

integer

$a_user_id

Definition at line 474 of file class.ilMailbox.php.

    {
        $this->user_id = $a_user_id;
    }

updateMailsOfDeletedUser()

ilMailbox::updateMailsOfDeletedUser

(

$nameToShow

)

Update existing mails.

Set sender id to 0 and import name to login name. This is only necessary for deleted users.

Parameters

string

$nameToShow

Definition at line 535 of file class.ilMailbox.php.

References array.

    {
        $this->db->manipulateF(
            '
                        UPDATE mail 
                        SET sender_id = %s, import_name = %s
                        WHERE sender_id = %s',
            array('integer', 'text', 'integer'),
            array(0, $nameToShow, $this->user_id)
        );
    }

Field Documentation

$actions

ilMailbox::$actions = array()

protected

Definition at line 46 of file class.ilMailbox.php.

Referenced by getActions().

$db

ilMailbox::$db

protected

Definition at line 29 of file class.ilMailbox.php.

$default_folder

ilMailbox::$default_folder = array()

protected

Definition at line 52 of file class.ilMailbox.php.

$ilias

ilMailbox::$ilias

protected

Definition at line 19 of file class.ilMailbox.php.

$lng

ilMailbox::$lng

protected

Definition at line 24 of file class.ilMailbox.php.

$mtree

ilMailbox::$mtree

protected

Definition at line 34 of file class.ilMailbox.php.

$table_mail_obj_data

ilMailbox::$table_mail_obj_data

protected

Definition at line 58 of file class.ilMailbox.php.

$table_tree

ilMailbox::$table_tree

protected

Definition at line 64 of file class.ilMailbox.php.

$user_id

ilMailbox::$user_id

protected

Definition at line 40 of file class.ilMailbox.php.

---

The documentation for this class was generated from the following file:

• Services/Mail/classes/class.ilMailbox.php