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 ()

	getDraftsFolder ()

	getTrashFolder ()

	getSentFolder ()

	getActions ($folderId)

	createDefaultFolder ()
	Creates all default folders for a user. More...

	addFolder (int $parentFolderId, string $name)

	renameFolder (int $folderId, string $name)

	deleteFolder ($folderId)

	getFolderData ($folderId)

	getParentFolderId (int $folderId)

	getSubFolders ()

	setUsrId (int $usrId)

	getUsrId ()

	delete ()

	updateMailsOfDeletedUser (string $nameToShow)
	Update existing mails. More...

	isOwnedFolder (int $folderId)

Protected Member Functions
	folderNameExists (string $name)

Protected Attributes
	$lng

	$db

	$mtree

	$usrId

	$actions = []

	$defaultFolders = []

	$table_mail_obj_data

	$table_tree

Private Member Functions
	getRootFolderId ()

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 12 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 42 of file class.ilMailbox.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
 
        $this->usrId = (int) $a_user_id;
        $this->table_mail_obj_data = 'mail_obj_data';
        $this->table_tree = 'mail_tree';
 
        if ($this->usrId) {
            $this->mtree = new ilTree($this->usrId);
            $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 = [
                '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->defaultFolders = [
            'b_inbox' => 'inbox',
            'c_trash' => 'trash',
            'd_drafts' => 'drafts',
            'e_sent' => 'sent',
            'z_local' => 'local'
        ];
    }

References $DIC.

Member Function Documentation

◆ addFolder()

ilMailbox::addFolder	(	int	$parentFolderId,
		string	$name
	)

Parameters

int	$parentFolderId
string	$name

Returns: int

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

                                                                 : int
    {
        if ($this->folderNameExists($name)) {
            return 0;
        }
 
        $nextId = (int) $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)',
            ['integer', 'integer', 'text', 'text'],
            [$nextId, $this->usrId, $name, 'user_folder']
        );
        $this->mtree->insertNode($nextId, $parentFolderId);
 
        return $nextId;
    }

References $name, and folderNameExists().

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 173 of file class.ilMailbox.php.

                                          : void
    {
        $rootFolderId = (int) $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)',
            ['integer', 'integer', 'text', 'text'],
            [$rootFolderId, $this->usrId, 'a_root', 'root']
        );
        $this->mtree->addTree($this->usrId, $rootFolderId);
 
        foreach ($this->defaultFolders 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)',
                ['integer', 'integer', 'text', 'text'],
                [$last_id, $this->usrId, $key, $folder]
            );
            $this->mtree->insertNode($last_id, $rootFolderId);
        }
    }

◆ delete()

ilMailbox::delete ( )

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

                             : void
    {
        $this->db->manipulateF(
            'DELETE FROM mail_obj_data WHERE user_id = %s',
            ['integer'],
            [$this->usrId]
        );
 
        $this->db->manipulateF(
            'DELETE FROM mail_options WHERE user_id = %s',
            ['integer'],
            [$this->usrId]
        );
 
        $this->db->manipulateF(
            'DELETE FROM mail_saved WHERE user_id = %s',
            ['integer'],
            [$this->usrId]
        );
 
        $this->db->manipulateF(
            'DELETE FROM mail_tree WHERE tree = %s',
            ['integer'],
            [$this->usrId]
        );
 
        // Delete the user's files from filesystem: This has to be done before deleting the database entries in table 'mail'
        $fdm = new ilFileDataMail($this->usrId);
        $fdm->onUserDelete();
 
        // Delete mails of deleted user
        $this->db->manipulateF(
            'DELETE FROM mail WHERE user_id = %s',
            ['integer'],
            [$this->usrId]
        );
    }

◆ deleteFolder()

ilMailbox::deleteFolder ( $folderId )

Parameters

int $folderId

Returns: bool

Exceptions

ilInvalidTreeStructureException

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

                                            : bool
    {
        $query = $this->db->queryF(
            'SELECT obj_id, title FROM ' . $this->table_mail_obj_data . ' WHERE obj_id = %s AND user_id = %s',
            ['integer', 'integer'],
            [$folderId, $this->usrId]
        );
        $row = $this->db->fetchAssoc($query);
 
        if (!is_array($row) || array_key_exists($row['title'], $this->defaultFolders)) {
            return false;
        }
 
        $mailer = new ilMail($this->usrId);
 
        $subtree = $this->mtree->getSubtree($this->mtree->getNodeData($folderId));
        $this->mtree->deleteTree($this->mtree->getNodeData($folderId));
 
        foreach ($subtree as $node) {
            $nodeId = (int) $node['obj_id'];
 
            $mails = $mailer->getMailsOfFolder($nodeId);
 
            $mailIds = [];
            foreach ($mails as $mail) {
                $mailIds[] = $mail['mail_id'];
            }
 
            $mailer->deleteMails($mailIds);
 
            $this->db->manipulateF(
                'DELETE FROM ' . $this->table_mail_obj_data . ' WHERE obj_id = %s AND user_id = %s',
                ['integer', 'integer'],
                [$nodeId, $this->usrId]
            );
        }
 
        return true;
    }

References $query.

◆ folderNameExists()

ilMailbox::folderNameExists ( string $name )

protected

Parameters

$name

Returns: bool

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

                                                      : bool
    {
        $res = $this->db->queryF(
            'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND title = %s',
            ['integer', 'text'],
            [$this->usrId, $name]
        );
        $row = $this->db->fetchAssoc($res);
 
        return is_array($row) && $row['obj_id'] > 0 ? true : false;
    }

References $name, $res, and true.

Referenced by addFolder(), and renameFolder().

Here is the caller graph for this function:

◆ getActions()

ilMailbox::getActions ( $folderId )

Parameters

int $folderId

Returns: array

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

                                          : array
    {
        if ($folderId) {
            $folder_data = $this->getFolderData($folderId);
            if ($folder_data['type'] === 'user_folder' || $folder_data['type'] === 'local') {
                return $this->actions;
            }
        }
 
        return $this->actions;
    }

References $actions, and getFolderData().

Here is the call graph for this function:

◆ getDraftsFolder()

ilMailbox::getDraftsFolder ( )

Returns: int

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

                                      : int
    {
        $res = $this->db->queryF(
            'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND m_type = %s',
            ['integer', 'text'],
            [$this->usrId, 'drafts']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

◆ getFolderData()

ilMailbox::getFolderData ( $folderId )

Parameters

$folderId

Returns: array

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

                                             : array
    {
        $res = $this->db->queryF(
            'SELECT * FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND obj_id = %s',
            ['integer', 'integer'],
            [$this->usrId, $folderId]
        );
        $row = $this->db->fetchAssoc($res);
 
        return [
            'obj_id' => (int) $row['obj_id'],
            'title' => (string) $row['title'],
            'type' => (string) $row['m_type'],
        ];
    }

References $res.

Referenced by getActions(), and isOwnedFolder().

Here is the caller graph for this function:

◆ getInboxFolder()

ilMailbox::getInboxFolder ( )

Returns: int

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

                                     : int
    {
        $res = $this->db->queryF(
            'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND m_type = %s',
            ['integer', 'text'],
            [$this->usrId, 'inbox']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

◆ getParentFolderId()

ilMailbox::getParentFolderId ( int $folderId )

Parameters

int $folderId

Returns: int

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

                                                     : int
    {
        $res = $this->db->queryF(
            'SELECT * FROM  ' . $this->table_tree . ' WHERE child = %s AND tree = %s',
            ['integer', 'integer'],
            [$folderId, $this->usrId]
        );
        $row = $this->db->fetchAssoc($res);
 
        return is_array($row) ? (int) $row['parent'] : 0;
    }

References $res.

◆ getRootFolderId()

ilMailbox::getRootFolderId ( )

private

Returns: int

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

                                       : int
    {
        return (int) $this->mtree->getRootId();
    }

◆ getSentFolder()

ilMailbox::getSentFolder ( )

Returns: int

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

                                    : int
    {
        $res = $this->db->queryF(
            'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND m_type = %s',
            ['integer', 'text'],
            [$this->usrId, 'sent']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

◆ getSubFolders()

ilMailbox::getSubFolders ( )

Returns: array

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

                                    : array
    {
        $userFolders = [];
 
        foreach ($this->defaultFolders 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',
                ['integer', 'text'],
                [$this->usrId, $key]
            );
            $row = $this->db->fetchAssoc($res);
 
            $userFolders[] = [
                'title' => (string) $key,
                'type' => (string) $row['m_type'],
                'obj_id' => (int) $row['obj_id'],
            ];
        }
 
        $query = implode(' ', [
            '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'
        ]);
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [2, $this->usrId]
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $userFolders[] = [
                'title' => (string) $row['title'],
                'type' => (string) $row['m_type'],
                'obj_id' => (int) $row['child'],
            ];
        }
 
        return $userFolders;
    }

References $query, and $res.

◆ getTrashFolder()

ilMailbox::getTrashFolder ( )

Returns: int

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

                                     : int
    {
        $res = $this->db->queryF(
            'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND m_type = %s',
            ['integer', 'text'],
            [$this->usrId, 'trash']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

◆ getUsrId()

ilMailbox::getUsrId ( )

Returns: int

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

                               : int
    {
        return (int) $this->usrId;
    }

References $usrId.

◆ isOwnedFolder()

ilMailbox::isOwnedFolder ( int $folderId )

Parameters

int $folderId

Returns: bool

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

                                                 : bool
    {
        $folderData = $this->getFolderData($folderId);
 
        return (int) $folderData['obj_id'] === $folderId;
    }

References getFolderData().

Here is the call graph for this function:

◆ renameFolder()

ilMailbox::renameFolder	(	int	$folderId,
		string	$name
	)

Parameters

int	$folderId
string	$name

Returns: bool

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

                                                              : bool
    {
        if ($this->folderNameExists($name)) {
            return false;
        }
 
        $this->db->manipulateF(
            'UPDATE ' . $this->table_mail_obj_data . ' SET title = %s WHERE obj_id = %s AND user_id = %s',
            ['text', 'integer', 'integer'],
            [$name, $folderId, $this->usrId]
        );
 
        return true;
    }

References $name, and folderNameExists().

Here is the call graph for this function:

◆ setUsrId()

ilMailbox::setUsrId ( int $usrId )

Parameters

int $usrId

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

                                         : void
    {
        $this->usrId = $usrId;
    }

References $usrId.

◆ updateMailsOfDeletedUser()

ilMailbox::updateMailsOfDeletedUser ( string $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 440 of file class.ilMailbox.php.

                                                                 : void
    {
        $this->db->manipulateF(
            'UPDATE mail SET sender_id = %s, import_name = %s WHERE sender_id = %s',
            ['integer', 'text', 'integer'],
            [0, $nameToShow, $this->usrId]
        );
    }

Field Documentation

◆ $actions

ilMailbox::$actions = []

protected

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

Referenced by getActions().

◆ $db

ilMailbox::$db

protected

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

◆ $defaultFolders

ilMailbox::$defaultFolders = []

protected

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

◆ $lng

ilMailbox::$lng

protected

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

◆ $mtree

ilMailbox::$mtree

protected

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

◆ $table_mail_obj_data

ilMailbox::$table_mail_obj_data

protected

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

◆ $table_tree

ilMailbox::$table_tree

protected

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

◆ $usrId

ilMailbox::$usrId

protected

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

Referenced by getUsrId(), and setUsrId().

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

Services/Mail/classes/class.ilMailbox.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFolder()

◆ createDefaultFolder()

◆ delete()

◆ deleteFolder()

◆ folderNameExists()

◆ getActions()

◆ getDraftsFolder()

◆ getFolderData()

◆ getInboxFolder()

◆ getParentFolderId()

◆ getRootFolderId()

◆ getSentFolder()

◆ getSubFolders()

◆ getTrashFolder()

◆ getUsrId()

◆ isOwnedFolder()

◆ renameFolder()

◆ setUsrId()

◆ updateMailsOfDeletedUser()

Field Documentation

◆ $actions

◆ $db

◆ $defaultFolders

◆ $lng

◆ $mtree

◆ $table_mail_obj_data

◆ $table_tree

◆ $usrId