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

Collaboration diagram for ilMailbox:

Public Member Functions
	__construct (int $a_user_id)

	getRooFolder ()

	getInboxFolder ()

	getDraftsFolder ()

	getTrashFolder ()

	getSentFolder ()

	getActions (int $folderId)

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

	addFolder (int $parentFolderId, string $name)

	renameFolder (int $folderId, string $name)

	deleteFolder (int $folderId)

	getFolderData (int $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
ilLanguage	$lng

ilDBInterface	$db

ilTree	$mtree

int	$usrId

array	$actions

array	$defaultFolders

array string	$table_mail_obj_data

string	$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 29 of file class.ilMailbox.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailbox::__construct ( int $a_user_id )

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

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

     {
         global $DIC;
 
         if ($a_user_id < 1) {
             throw new InvalidArgumentException("Cannot create mailbox without user id");
         }
 
         $this->lng = $DIC->language();
         $this->db = $DIC->database();
 
         $this->usrId = $a_user_id;
         $this->table_mail_obj_data = 'mail_obj_data';
         $this->table_tree = 'mail_tree';
 
         $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'),
             ];
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addFolder()

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

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

References folderNameExists().

                                                                 : int
     {
         if ($this->folderNameExists($name)) {
             return 0;
         }
 
         $nextId = $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;
     }

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

References ILIAS\LTI\ToolProvider\$key.

                                          : void
     {
         $rootFolderId = $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 361 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 ( int $folderId )

Exceptions

ilInvalidTreeStructureException

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

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

                                                : 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[] = (int) $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;
     }

Here is the call graph for this function:

◆ folderNameExists()

ilMailbox::folderNameExists ( string $name )

protected

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

References $res.

Referenced by addFolder(), and renameFolder().

                                                      : 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;
     }

Here is the caller graph for this function:

◆ getActions()

ilMailbox::getActions ( int $folderId )

Parameters

int $folderId

Returns: array{moveMails: string, markMailsRead: string, markMailsUnread: string, deleteMails: string}

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

References $actions.

                                              : array
     {
         return $this->actions;
     }

◆ getDraftsFolder()

ilMailbox::getDraftsFolder ( )

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

References $res.

                                      : 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'];
     }

◆ getFolderData()

ilMailbox::getFolderData ( int $folderId )

Returns: array{obj_id: int, title: string, type: string}|null

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

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

Referenced by isOwnedFolder().

                                                 : ?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);
 
         if (is_array($row)) {
             return [
                 'obj_id' => (int) $row['obj_id'],
                 'title' => (string) $row['title'],
                 'type' => (string) $row['m_type'],
             ];
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInboxFolder()

ilMailbox::getInboxFolder ( )

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

References $res.

                                     : 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'];
     }

◆ getParentFolderId()

ilMailbox::getParentFolderId ( int $folderId )

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

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

                                                     : 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;
     }

Here is the call graph for this function:

◆ getRooFolder()

ilMailbox::getRooFolder ( )

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

References $res.

                                   : 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, 'root']
         );
 
         $row = $this->db->fetchAssoc($res);
 
         return (int) $row['obj_id'];
     }

◆ getSentFolder()

ilMailbox::getSentFolder ( )

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

References $res.

                                    : 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'];
     }

◆ getSubFolders()

ilMailbox::getSubFolders ( )

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

References ILIAS\LTI\ToolProvider\$key, $query, $res, and ILIAS\Repository\int().

                                    : 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' => $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;
     }

Here is the call graph for this function:

◆ getTrashFolder()

ilMailbox::getTrashFolder ( )

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

References $res.

                                     : 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'];
     }

◆ getUsrId()

ilMailbox::getUsrId ( )

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

References $usrId.

                               : int
     {
         return $this->usrId;
     }

◆ isOwnedFolder()

ilMailbox::isOwnedFolder ( int $folderId )

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

References getFolderData(), and ILIAS\Repository\int().

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

Here is the call graph for this function:

◆ renameFolder()

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

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

References folderNameExists().

                                                              : 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;
     }

Here is the call graph for this function:

◆ setUsrId()

ilMailbox::setUsrId ( int $usrId )

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

References $usrId.

Referenced by ilMail\sendChanneledMails().

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

Here is the caller graph for this function:

◆ 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.

Definition at line 404 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

array ilMailbox::$actions

protected

Initial value:

= [

'moveMails' => ''

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

Referenced by getActions().

◆ $db

ilDBInterface ilMailbox::$db

protected

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

◆ $defaultFolders

array ilMailbox::$defaultFolders

protected

Initial value:

= [

'b_inbox' => 'inbox'

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

◆ $lng

ilLanguage ilMailbox::$lng

protected

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

◆ $mtree

ilTree ilMailbox::$mtree

protected

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

◆ $table_mail_obj_data

array string ilMailbox::$table_mail_obj_data

protected

Initial value:

=> 'trash',
        'd_drafts' => 'drafts',
        'e_sent' => 'sent',
        'z_local' => 'local',
    ]

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

◆ $table_tree

string ilMailbox::$table_tree

protected

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

◆ $usrId

int ilMailbox::$usrId

protected

Definition at line 34 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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFolder()

◆ createDefaultFolder()

◆ delete()

◆ deleteFolder()

◆ folderNameExists()

◆ getActions()

◆ getDraftsFolder()

◆ getFolderData()

◆ getInboxFolder()

◆ getParentFolderId()

◆ getRooFolder()

◆ getSentFolder()

◆ getSubFolders()

◆ getTrashFolder()

◆ getUsrId()

◆ isOwnedFolder()

◆ renameFolder()

◆ setUsrId()

◆ updateMailsOfDeletedUser()

Field Documentation

◆ $actions

◆ $db

◆ $defaultFolders

◆ $lng

◆ $mtree

◆ $table_mail_obj_data

◆ $table_tree

◆ $usrId