ilMailbox Class Reference

Collaboration diagram for ilMailbox:

Public Member Functions
	__construct (protected int $usr_id)
	getRootFolder ()
	getInboxFolder ()
	getDraftsFolder ()
	getOutboxFolder ()
	getTrashFolder ()
	getSentFolder ()
	createDefaultFolder ()
	Creates all default folders for a user. More...
	addFolder (int $parent_folder_id, string $name)
	renameFolder (int $folder_id, string $name)
	deleteFolder (int $folder_id)
	getFolderData (int $folder_id)
	getParentFolderId (int $folder_id)
	getSubFolders ()
	setUsrId (int $usr_id)
	getUsrId ()
	delete ()
	updateMailsOfDeletedUser (string $name_to_show)
	Update existing mails. More...
	isOwnedFolder (int $folder_id)

Protected Member Functions
	folderNameExists (string $name)

Private Member Functions
	microMigrateOutboxFolder ()
	getFolderDataFromRow (array $row)

Private Attributes
readonly ilLanguage	$lng
readonly ilDBInterface	$db
readonly ilTree	$mtree
array	$default_folders
readonly string	$table_mail_obj_data
readonly string	$table_tree

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailbox::__construct

(

protected int

$usr_id

)

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

    {
        global $DIC;
 
        if ($usr_id < 1) {
            throw new InvalidArgumentException('Cannot create mailbox without user id');
        }
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->table_mail_obj_data = 'mail_obj_data';
        $this->table_tree = 'mail_tree';
 
        $this->mtree = new ilTree($this->usr_id);
        $this->mtree->setTableNames($this->table_tree, $this->table_mail_obj_data);
 
        $this->lng->loadLanguageModule('mail');
    }

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

addFolder()

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

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

                                                                  : int
    {
        if ($this->folderNameExists($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)',
            ['integer', 'integer', 'text', 'text'],
            [$next_id, $this->usr_id, $name, 'user_folder']
        );
        $this->mtree->insertNode($next_id, $parent_folder_id);
 
        return $next_id;
    }

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

                                         : void
    {
        $root_folder_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'],
            [$root_folder_id, $this->usr_id, 'a_root', 'root']
        );
        $this->mtree->addTree($this->usr_id, $root_folder_id);
 
        foreach ($this->default_folders 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->usr_id, $key, $folder]
            );
            $this->mtree->insertNode($last_id, $root_folder_id);
        }
    }

Referenced by microMigrateOutboxFolder().

Here is the caller graph for this function:

delete()

ilMailbox::delete

(

)

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

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

deleteFolder()

ilMailbox::deleteFolder

(

int

$folder_id

)

Exceptions

ilInvalidTreeStructureException

Definition at line 253 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'],
            [$folder_id, $this->usr_id]
        );
        $row = $this->db->fetchAssoc($query);
 
        if (!is_array($row) || array_key_exists($row['title'], $this->default_folders)) {
            return false;
        }
 
        $mailer = new ilMail($this->usr_id);
 
        $subtree = $this->mtree->getSubTree($this->mtree->getNodeData($folder_id));
        $this->mtree->deleteTree($this->mtree->getNodeData($folder_id));
 
        foreach ($subtree as $node) {
            $node_id = (int) $node['obj_id'];
 
            $mails = $mailer->getMailsOfFolder($node_id);
 
            $mail_ids = [];
            foreach ($mails as $mail) {
                $mail_ids[] = (int) $mail['mail_id'];
            }
 
            $mailer->deleteMails($mail_ids);
 
            $this->db->manipulateF(
                'DELETE FROM ' . $this->table_mail_obj_data . ' WHERE obj_id = %s AND user_id = %s',
                ['integer', 'integer'],
                [$node_id, $this->usr_id]
            );
        }
 
        return true;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

folderNameExists()

ilMailbox::folderNameExists ( string  $name )

protected

Definition at line 238 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->usr_id, $name]
        );
        $row = $this->db->fetchAssoc($res);
 
        return is_array($row) && $row['obj_id'] > 0;
    }

References $res.

Referenced by addFolder(), and renameFolder().

Here is the caller graph for this function:

getDraftsFolder()

ilMailbox::getDraftsFolder

(

)

Definition at line 95 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->usr_id, 'drafts']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

Referenced by microMigrateOutboxFolder().

Here is the caller graph for this function:

getFolderData()

ilMailbox::getFolderData

(

int

$folder_id

)

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

                                                 : ?MailFolderData
    {
        $res = $this->db->queryF(
            'SELECT * FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND obj_id = %s',
            ['integer', 'integer'],
            [$this->usr_id, $folder_id]
        );
        $row = $this->db->fetchAssoc($res);
 
        if (is_array($row)) {
            return $this->getFolderDataFromRow($row);
        }
 
        return null;
    }

References $res, and getFolderDataFromRow().

Referenced by isOwnedFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

getFolderDataFromRow()

ilMailbox::getFolderDataFromRow ( array  $row )

private

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

                                                     : MailFolderData
    {
        return new MailFolderData(
            (int) $row['obj_id'],
            (int) $row['user_id'],
            MailFolderType::from($row['m_type']),
            (string) ($row['m_type'] === MailFolderType::USER->value
                ? $row['title']
                : $this->lng->txt('mail_' . $row['title']))
        );
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Repository\lng(), and ILIAS\Test\Results\Toplist\USER.

Referenced by getFolderData(), and getSubFolders().

Here is the call graph for this function:

Here is the caller graph for this function:

getInboxFolder()

ilMailbox::getInboxFolder

(

)

Definition at line 82 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->usr_id, 'inbox']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

getOutboxFolder()

ilMailbox::getOutboxFolder

(

)

Definition at line 108 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',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
            [$this->usr_id, 'outbox']
        );
 
        $row = $this->db->fetchAssoc($res);
        if ($row === null) {
            return $this->microMigrateOutboxFolder();
        }
 
        return (int) $row['obj_id'];
    }

References $res, microMigrateOutboxFolder(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Here is the call graph for this function:

getParentFolderId()

ilMailbox::getParentFolderId

(

int

$folder_id

)

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'],
            [$folder_id, $this->usr_id]
        );
        $row = $this->db->fetchAssoc($res);
 
        return is_array($row) ? (int) $row['parent'] : 0;
    }

References $res, and ILIAS\Repository\int().

Here is the call graph for this function:

getRootFolder()

ilMailbox::getRootFolder

(

)

Definition at line 69 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->usr_id, 'root']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return isset($row['obj_id']) ? (int) $row['obj_id'] : null;
    }

References $res, and ILIAS\Repository\int().

Referenced by microMigrateOutboxFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

getSentFolder()

ilMailbox::getSentFolder

(

)

Definition at line 166 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->usr_id, 'sent']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

getSubFolders()

ilMailbox::getSubFolders

(

)

Returns

list<MailFolderData>

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

                                   : array
    {
        $user_folders = [];
 
        foreach (array_keys($this->default_folders) as $key) {
            $res = $this->db->queryF(
                'SELECT * FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND title = %s',
                ['integer', 'text'],
                [$this->usr_id, $key]
            );
            $row = $this->db->fetchAssoc($res);
            if (is_array($row)) {
                $user_folders[] = $this->getFolderDataFromRow($row);
            }
        }
 
        $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->usr_id]
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $user_folders[] = $this->getFolderDataFromRow($row);
        }
 
        return $user_folders;
    }

References $res, and getFolderDataFromRow().

Here is the call graph for this function:

getTrashFolder()

ilMailbox::getTrashFolder

(

)

Definition at line 153 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->usr_id, 'trash']
        );
 
        $row = $this->db->fetchAssoc($res);
 
        return (int) $row['obj_id'];
    }

References $res.

getUsrId()

ilMailbox::getUsrId

(

)

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

                              : int
    {
        return $this->usr_id;
    }

isOwnedFolder()

ilMailbox::isOwnedFolder

(

int

$folder_id

)

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

                                                 : bool
    {
        $folder_data = $this->getFolderData($folder_id);
 
        return $folder_data?->getFolderId() === $folder_id;
    }

References getFolderData().

Here is the call graph for this function:

microMigrateOutboxFolder()

ilMailbox::microMigrateOutboxFolder ( )

private

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

                                               : int
    {
        $root_folder_id = $this->getRootFolder();
        if ($root_folder_id === null) {
            $this->createDefaultFolder();
 
            $res = $this->db->queryF(
                'SELECT obj_id FROM ' . $this->table_mail_obj_data . ' WHERE user_id = %s AND m_type = %s',
                [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
                [$this->usr_id, 'outbox']
            );
            $row = $this->db->fetchAssoc($res);
 
            return (int) ($row['obj_id'] ?? 0);
        }
 
        $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)',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            [$last_id, $this->usr_id, 'e_outbox', 'outbox']
        );
 
        $this->mtree->insertNode($last_id, $root_folder_id, $this->getDraftsFolder());
 
        return $last_id;
    }

References $res, createDefaultFolder(), getDraftsFolder(), getRootFolder(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by getOutboxFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

renameFolder()

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

Definition at line 223 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, $folder_id, $this->usr_id]
        );
 
        return true;
    }

References folderNameExists().

Here is the call graph for this function:

setUsrId()

ilMailbox::setUsrId

(

int

$usr_id

)

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

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

updateMailsOfDeletedUser()

ilMailbox::updateMailsOfDeletedUser

(

string

$name_to_show

)

Update existing mails.

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

Definition at line 430 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, $name_to_show, $this->usr_id]
        );
    }

Field Documentation

$db

readonly ilDBInterface ilMailbox::$db

private

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

$default_folders

array ilMailbox::$default_folders

private

Initial value:

= [
        'b_inbox' => 'inbox',
        'c_trash' => 'trash',
        'd_drafts' => 'drafts',
        'e_outbox' => 'outbox',
        'f_sent' => 'sent',
        'z_local' => 'local',
    ]

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

$lng

readonly ilLanguage ilMailbox::$lng

private

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

$mtree

readonly ilTree ilMailbox::$mtree

private

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

$table_mail_obj_data

readonly string ilMailbox::$table_mail_obj_data

private

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

$table_tree

readonly string ilMailbox::$table_tree

private

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

---

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

• components/ILIAS/Mail/classes/class.ilMailbox.php