Collaboration diagram for ilMailFolderGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Data Fields
ilMail	$umail

ilMailbox	$mbox

Protected Member Functions
	initFolder ()

	parseCommand (string $originalCommand)

	parseFolderIdFromCommand (string $command)

	performEmptyTrash ()

	confirmEmptyTrash ()

	showUser ()

	addSubFolderCommands (bool $isUserSubFolder=false)

	showFolder (bool $oneConfirmationDialogueRendered=false)

	deleteSubFolder (bool $a_show_confirm=true)

	performDeleteSubFolder ()

	getSubFolderForm (string $mode='create')

	performAddSubFolder ()

	addSubFolder (ilPropertyFormGUI $form=null)

	performRenameSubFolder ()

	renameSubFolder (ilPropertyFormGUI $form=null)

	getMailIdsFromRequest (bool $ignoreHttpGet=false)

	markMailsRead ()

	markMailsUnread ()

	moveSingleMail ()

	moveMails ()

	deleteMails ()

	confirmDeleteMails ()

	deliverFile ()

	deliverAttachments ()

	getMailFolderTable ()

	applyFilter ()

	resetFilter ()

Private Attributes
bool	$confirmTrashDeletion = false

bool	$errorDelete = false

ilGlobalTemplateInterface	$tpl

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

ilTabsGUI	$tabs

ilObjUser	$user

GlobalHttpState	$http

Refinery	$refinery

int	$currentFolderId = 0

ilErrorHandling	$error

Detailed Description

Author: Jens Conze

Version: $Id$

@ilCtrl_Calls ilMailFolderGUI: ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilMailFolderGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->error = $DIC['ilErr'];
 
        $this->umail = new ilMail($this->user->getId());
        $this->mbox = new ilMailbox($this->user->getId());
 
        $this->initFolder();
    }

References $DIC, ILIAS\Repository\ctrl(), error(), ILIAS\FileDelivery\http(), initFolder(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addSubFolder()

ilMailFolderGUI::addSubFolder ( ilPropertyFormGUI $form = null )

protected

Definition at line 374 of file class.ilMailFolderGUI.php.

                                                                   : void
    {
        if (null === $form) {
            $form = $this->getSubFolderForm();
        }
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

References getSubFolderForm(), and ILIAS\Repository\lng().

Referenced by performAddSubFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSubFolderCommands()

ilMailFolderGUI::addSubFolderCommands ( bool $isUserSubFolder = false )

protected

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

                                                                          : void
    {
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $this->toolbar->addButton(
            $this->lng->txt('mail_add_subfolder'),
            $this->ctrl->getLinkTarget($this, 'addSubFolder')
        );
 
        if ($isUserSubFolder) {
            $this->toolbar->addButton(
                $this->lng->txt('rename'),
                $this->ctrl->getLinkTarget($this, 'renameSubFolder')
            );
            $this->toolbar->addButton(
                $this->lng->txt('delete'),
                $this->ctrl->getLinkTarget($this, 'deleteSubFolder')
            );
        }
        $this->ctrl->clearParameters($this);
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by showFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyFilter()

ilMailFolderGUI::applyFilter ( )

protected

Definition at line 1029 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $table = $this->getMailFolderTable();
        $table->resetOffset();
        $table->writeFilterToSession();
 
        $this->showFolder();
    }

References getMailFolderTable(), and showFolder().

Here is the call graph for this function:

◆ confirmDeleteMails()

ilMailFolderGUI::confirmDeleteMails ( )

protected

Definition at line 565 of file class.ilMailFolderGUI.php.

                                           : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if ($mailIds === []) {
            $this->showFolder();
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
            return;
        }
 
        if ($this->mbox->getTrashFolder() === $this->currentFolderId) {
            $this->umail->deleteMails($mailIds);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_deleted'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        }
 
        $this->showFolder();
    }

References ILIAS\Repository\ctrl(), getMailIdsFromRequest(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ confirmEmptyTrash()

ilMailFolderGUI::confirmEmptyTrash ( )

protected

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

                                          : void
    {
        if ($this->umail->countMailsOfFolder($this->currentFolderId)) {
            $this->confirmTrashDeletion = true;
        }
 
        $this->showFolder();
    }

References showFolder().

Here is the call graph for this function:

◆ deleteMails()

ilMailFolderGUI::deleteMails ( )

protected

Definition at line 542 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $trashFolderId = $this->mbox->getTrashFolder();
        $mailIds = $this->getMailIdsFromRequest();
 
        if ($trashFolderId === $this->currentFolderId) {
            if ($mailIds === []) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
                $this->errorDelete = true;
            }
        } elseif ($mailIds === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
        } elseif ($this->umail->moveMailsToFolder($mailIds, $trashFolderId)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_moved_to_trash'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_move_error'));
        }
 
        $this->showFolder();
    }

References ILIAS\Repository\ctrl(), getMailIdsFromRequest(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ deleteSubFolder()

ilMailFolderGUI::deleteSubFolder ( bool $a_show_confirm = true )

protected

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

                                                                   : void
    {
        if ($a_show_confirm) {
            $confirmationGui = new ilConfirmationGUI();
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setHeaderText($this->lng->txt('mail_sure_delete_folder'));
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'performDeleteSubFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
 
            $this->showFolder(true);
        } else {
            $this->showFolder();
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ deliverAttachments()

ilMailFolderGUI::deliverAttachments ( )

protected

Definition at line 958 of file class.ilMailFolderGUI.php.

                                           : void
    {
        try {
            $mailId = 0;
            if ($this->http->wrapper()->query()->has('mail_id')) {
                $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
            }
 
            $mailData = $this->umail->getMail((int) $mailId);
            if (null === $mailData || 0 === count((array) $mailData['attachments'])) {
                throw new ilException('mail_error_reading_attachment');
            }
 
            $type = '';
            if ($this->http->wrapper()->query()->has('type')) {
                $type = $this->http->wrapper()->query()->retrieve('type', $this->refinery->kindlyTo()->string());
            }
 
            $mailFileData = new ilFileDataMail($this->user->getId());
            if (count($mailData['attachments']) === 1) {
                $attachment = current($mailData['attachments']);
 
                try {
                    if ('draft' === $type) {
                        if (!$mailFileData->checkFilesExist([$attachment])) {
                            throw new OutOfBoundsException('');
                        }
                        $pathToFile = $mailFileData->getAbsoluteAttachmentPoolPathByFilename($attachment);
                        $fileName = $attachment;
                    } else {
                        $file = $mailFileData->getAttachmentPathAndFilenameByMd5Hash(
                            md5($attachment),
                            (int) $mailId
                        );
                        $pathToFile = $file['path'];
                        $fileName = $file['filename'];
                    }
                    ilFileDelivery::deliverFileLegacy($pathToFile, $fileName);
                } catch (OutOfBoundsException $e) {
                    throw new ilException('mail_error_reading_attachment');
                }
            } else {
                $mailFileData->deliverAttachmentsAsZip(
                    $mailData['m_subject'],
                    (int) $mailId,
                    $mailData['attachments'],
                    'draft' === $type
                );
            }
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($e->getMessage()), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this);
        }
    }

References Vendor\Package\$e, $type, ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileLegacy(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ deliverFile()

ilMailFolderGUI::deliverFile ( )

protected

Definition at line 913 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
 
        if ($mailId <= 0) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $filename = '';
        if ($this->http->wrapper()->post()->has('filename')) {
            $filename = $this->http->wrapper()->post()->retrieve('filename', $this->refinery->kindlyTo()->string());
        }
 
        if (is_string(ilSession::get('filename')) && ilSession::get('filename') !== '') {
            $filename = ilSession::get('filename');
            ilSession::set('filename', null);
        }
 
        try {
            if ($mailId > 0 && $filename !== '') {
                while (strpos($filename, '..') !== false) {
                    $filename = str_replace('..', '', $filename);
                }
 
                $mailFileData = new ilFileDataMail($this->user->getId());
                try {
                    $file = $mailFileData->getAttachmentPathAndFilenameByMd5Hash($filename, (int) $mailId);
                    ilFileDelivery::deliverFileLegacy($file['path'], $file['filename']);
                } catch (OutOfBoundsException $e) {
                    throw new ilException('mail_error_reading_attachment');
                }
            } else {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_attachment'));
                $this->showMail();
            }
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($e->getMessage()), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this);
        }
    }

References Vendor\Package\$e, $filename, ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileLegacy(), error(), ilSession\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSession\set(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ executeCommand()

ilMailFolderGUI::executeCommand ( )

Definition at line 109 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $cmd = $this->parseCommand(
            $this->ctrl->getCmd()
        );
 
        $nextClass = $this->ctrl->getNextClass($this);
        switch (strtolower($nextClass)) {
            case strtolower(ilContactGUI::class):
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;
 
            case strtolower(ilPublicUserProfileGUI::class):
                $this->tpl->setTitle($this->lng->txt('mail'));
                $userId = 0;
                if ($this->http->wrapper()->query()->has('user')) {
                    $userId = $this->http->wrapper()->query()->retrieve('user', $this->refinery->kindlyTo()->int());
                }
                $profileGui = new ilPublicUserProfileGUI($userId);
 
                $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
                $profileGui->setBackUrl($this->ctrl->getLinkTarget($this, 'showMail'));
                $this->ctrl->clearParameters($this);
 
                $ret = $this->ctrl->forwardCommand($profileGui);
                if ($ret !== '') {
                    $this->tpl->setContent($ret);
                }
                $this->tpl->printToStdout();
                break;
 
            default:
                if (!method_exists($this, $cmd)) {
                    $cmd = 'showFolder';
                }
                $this->{$cmd}();
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), parseCommand(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getMailFolderTable()

ilMailFolderGUI::getMailFolderTable ( )

protected

Definition at line 1014 of file class.ilMailFolderGUI.php.

                                           : ilMailFolderTableGUI
    {
        $table = new ilMailFolderTableGUI(
            $this,
            $this->currentFolderId,
            'showFolder',
            $this->currentFolderId === $this->mbox->getTrashFolder(),
            $this->currentFolderId === $this->mbox->getSentFolder(),
            $this->currentFolderId === $this->mbox->getDraftsFolder()
        );
        $table->initFilter();
 
        return $table;
    }

Referenced by applyFilter(), resetFilter(), and showFolder().

Here is the caller graph for this function:

◆ getMailIdsFromRequest()

ilMailFolderGUI::getMailIdsFromRequest ( bool $ignoreHttpGet = false )

protected

Returns: int[]

Definition at line 434 of file class.ilMailFolderGUI.php.

                                                                         : array
    {
        $mailIds = [];
        if ($this->http->wrapper()->post()->has('mail_id')) {
            $mailIds = $this->http->wrapper()->post()->retrieve(
                'mail_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            );
        }
 
        if ($mailIds === [] && !$ignoreHttpGet) {
            $mailId = 0;
            if ($this->http->wrapper()->query()->has('mail_id')) {
                $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
            }
            if (is_numeric($mailId)) {
                $mailIds = [$mailId];
            }
        }
 
        return array_filter(array_map('intval', $mailIds));
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmDeleteMails(), deleteMails(), markMailsRead(), markMailsUnread(), moveMails(), moveSingleMail(), and showFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubFolderForm()

ilMailFolderGUI::getSubFolderForm ( string $mode = 'create' )

protected

Definition at line 331 of file class.ilMailFolderGUI.php.

                                                                : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $form->setFormAction($this->ctrl->getFormAction($this, 'performAddSubFolder'));
        $this->ctrl->clearParameters($this);
        if ('edit' === $mode) {
            $form->addCommandButton('performRenameSubFolder', $this->lng->txt('save'));
            $form->setTitle($this->lng->txt('mail_rename_folder'));
        } else {
            $form->addCommandButton('performAddSubFolder', $this->lng->txt('save'));
            $form->setTitle($this->lng->txt('mail_add_folder'));
        }
        $form->addCommandButton('showFolder', $this->lng->txt('cancel'));
 
        $title = new ilTextInputGUI($this->lng->txt('title'), 'subfolder_title');
        $title->setRequired(true);
        $form->addItem($title);
 
        return $form;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by addSubFolder(), performAddSubFolder(), performRenameSubFolder(), and renameSubFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFolder()

ilMailFolderGUI::initFolder ( )

protected

Definition at line 68 of file class.ilMailFolderGUI.php.

                                   : void
    {
        if ($this->http->wrapper()->post()->has('mobj_id')) {
            $folderId = $this->http->wrapper()->post()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } elseif ($this->http->wrapper()->query()->has('mobj_id')) {
            $folderId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } else {
            $folderId = $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always($this->currentFolderId),
            ])->transform(ilSession::get('mobj_id'));
        }
 
        if (0 === $folderId || !$this->mbox->isOwnedFolder($folderId)) {
            $folderId = $this->mbox->getInboxFolder();
        }
 
        $this->currentFolderId = $folderId;
    }

References ilSession\get(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markMailsRead()

ilMailFolderGUI::markMailsRead ( )

protected

Definition at line 457 of file class.ilMailFolderGUI.php.

                                      : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if ($mailIds !== []) {
            $this->umail->markRead($mailIds);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ markMailsUnread()

ilMailFolderGUI::markMailsUnread ( )

protected

Definition at line 470 of file class.ilMailFolderGUI.php.

                                        : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if ($mailIds !== []) {
            $this->umail->markUnread($mailIds);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ moveMails()

ilMailFolderGUI::moveMails ( )

protected

Definition at line 522 of file class.ilMailFolderGUI.php.

                                  : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if ($mailIds === []) {
            $this->showFolder();
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
            return;
        }
 
        $folderId = $this->parseFolderIdFromCommand($this->ctrl->getCmd());
        if ($this->umail->moveMailsToFolder($mailIds, $folderId)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_moved'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_move_error'));
            $this->showFolder();
        }
    }

References ILIAS\Repository\ctrl(), getMailIdsFromRequest(), ILIAS\Repository\lng(), parseFolderIdFromCommand(), and showFolder().

Here is the call graph for this function:

◆ moveSingleMail()

ilMailFolderGUI::moveSingleMail ( )

protected

Definition at line 483 of file class.ilMailFolderGUI.php.

                                       : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (1 !== count($mailIds)) {
            $this->showMail();
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
            return;
        }
 
        $newFolderId = 0;
        if ($this->http->wrapper()->post()->has('folder_id')) {
            $newFolderId = $this->http->wrapper()->post()->retrieve(
                'folder_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $redirectFolderId = $newFolderId;
 
        foreach ($mailIds as $mailId) {
            $mailData = $this->umail->getMail($mailId);
            if (isset($mailData['folder_id']) &&
                is_numeric($mailData['folder_id']) &&
                (int) $mailData['folder_id'] > 0
            ) {
                $redirectFolderId = (int) $mailData['folder_id'];
                break;
            }
        }
 
        if ($this->umail->moveMailsToFolder($mailIds, $newFolderId)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_moved'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $redirectFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_move_error'));
            $this->showMail();
        }
    }

References ILIAS\Repository\ctrl(), getMailIdsFromRequest(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ parseCommand()

ilMailFolderGUI::parseCommand ( string $originalCommand )

protected

Definition at line 88 of file class.ilMailFolderGUI.php.

                                                            : string
    {
        if (preg_match('/^([a-zA-Z0-9]+?)_(\d+?)$/', $originalCommand, $matches) && 3 === count($matches)) {
            $originalCommand = $matches[1];
        }
 
        return $originalCommand;
    }

Referenced by executeCommand(), and showFolder().

Here is the caller graph for this function:

◆ parseFolderIdFromCommand()

ilMailFolderGUI::parseFolderIdFromCommand ( string $command )

protected

Definition at line 97 of file class.ilMailFolderGUI.php.

                                                                : int
    {
        if (
            preg_match('/^([a-zA-Z0-9]+?)_(\d+?)$/', $command, $matches) &&
            3 === count($matches) && is_numeric($matches[2])
        ) {
            return (int) $matches[2];
        }
 
        throw new InvalidArgumentException("Cannot parse a numeric folder id from command string!");
    }

Referenced by moveMails().

Here is the caller graph for this function:

◆ performAddSubFolder()

ilMailFolderGUI::performAddSubFolder ( )

protected

Definition at line 353 of file class.ilMailFolderGUI.php.

                                            : void
    {
        $form = $this->getSubFolderForm();
        $isFormValid = $form->checkInput();
        $form->setValuesByPost();
        if (!$isFormValid) {
            $this->addSubFolder($form);
            return;
        }
 
        $newFolderId = $this->mbox->addFolder($this->currentFolderId, $form->getInput('subfolder_title'));
        if ($newFolderId > 0) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_folder_created'), true);
            $this->ctrl->setParameterByClass(ilMailGUI::class, 'mobj_id', $newFolderId);
            $this->ctrl->redirectByClass(ilMailGUI::class);
        }
 
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_folder_exists'));
        $this->addSubFolder($form);
    }

References addSubFolder(), ILIAS\Repository\ctrl(), getSubFolderForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ performDeleteSubFolder()

ilMailFolderGUI::performDeleteSubFolder ( )

protected

Exceptions

ilInvalidTreeStructureException

Definition at line 318 of file class.ilMailFolderGUI.php.

                                               : void
    {
        $parentFolderId = $this->mbox->getParentFolderId($this->currentFolderId);
        if ($parentFolderId > 0 && $this->mbox->deleteFolder($this->currentFolderId)) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_folder_deleted'), true);
            $this->ctrl->setParameterByClass(ilMailGUI::class, 'mobj_id', $parentFolderId);
            $this->ctrl->redirectByClass(ilMailGUI::class);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_error_delete'));
            $this->showFolder();
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and showFolder().

Here is the call graph for this function:

◆ performEmptyTrash()

ilMailFolderGUI::performEmptyTrash ( )

protected

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

                                          : void
    {
        $this->umail->deleteMailsOfFolder($this->currentFolderId);
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_deleted'), true);
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $this->ctrl->redirect($this, 'showFolder');
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ performRenameSubFolder()

ilMailFolderGUI::performRenameSubFolder ( )

protected

Definition at line 385 of file class.ilMailFolderGUI.php.

                                               : void
    {
        $form = $this->getSubFolderForm('edit');
        $isFormValid = $form->checkInput();
        $form->setValuesByPost();
        if (!$isFormValid) {
            $this->renameSubFolder($form);
            return;
        }
 
        $folderData = $this->mbox->getFolderData($this->currentFolderId);
        if ($folderData === null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_operation_on_invalid_folder'), true);
            $this->ctrl->setParameterByClass(ilMailGUI::class, 'mobj_id', $this->mbox->getInboxFolder());
            $this->ctrl->redirectByClass(ilMailGUI::class);
        }
 
        if ($folderData['title'] === $form->getInput('subfolder_title')) {
            $this->showFolder();
            return;
        }
 
        if ($this->mbox->renameFolder($this->currentFolderId, $form->getInput('subfolder_title'))) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_folder_name_changed'), true);
            $this->ctrl->setParameterByClass(ilMailGUI::class, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirectByClass(ilMailGUI::class);
        }
 
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_folder_exists'));
        $this->renameSubFolder($form);
    }

References ILIAS\Repository\ctrl(), getSubFolderForm(), ILIAS\Repository\lng(), renameSubFolder(), and showFolder().

Here is the call graph for this function:

◆ renameSubFolder()

ilMailFolderGUI::renameSubFolder ( ilPropertyFormGUI $form = null )

protected

Definition at line 417 of file class.ilMailFolderGUI.php.

                                                                      : void
    {
        if (null === $form) {
            $form = $this->getSubFolderForm('edit');
            $form->setValuesByArray(
                ['subfolder_title' => $this->mbox->getFolderData($this->currentFolderId)['title'] ?? '']
            );
        }
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

References getSubFolderForm(), and ILIAS\Repository\lng().

Referenced by performRenameSubFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilMailFolderGUI::resetFilter ( )

protected

Definition at line 1038 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $table = $this->getMailFolderTable();
        $table->resetOffset();
        $table->resetFilter();
 
        $this->showFolder();
    }

References getMailFolderTable(), and showFolder().

Here is the call graph for this function:

◆ showFolder()

ilMailFolderGUI::showFolder ( bool $oneConfirmationDialogueRendered = false )

protected

Definition at line 225 of file class.ilMailFolderGUI.php.

                                                                                : void
    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail.html', 'Services/Mail');
        $this->tpl->setTitle($this->lng->txt('mail'));
 
        $isTrashFolder = $this->currentFolderId === $this->mbox->getTrashFolder();
 
        if (!$this->errorDelete && $isTrashFolder && 'deleteMails' === $this->parseCommand($this->ctrl->getCmd())) {
            $confirmationGui = new ilConfirmationGUI();
            $confirmationGui->setHeaderText($this->lng->txt('mail_sure_delete'));
            foreach ($this->getMailIdsFromRequest() as $mailId) {
                $confirmationGui->addHiddenItem('mail_id[]', (string) $mailId);
            }
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'confirmDeleteMails');
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
            $oneConfirmationDialogueRendered = true;
        }
 
        $folders = $this->mbox->getSubFolders();
        $mtree = new ilTree($this->user->getId());
        $mtree->setTableNames('mail_tree', 'mail_obj_data');
 
        $isUserSubFolder = false;
        $isUserRootFolder = false;
 
        $folder_d = $mtree->getNodeData($this->currentFolderId);
        if ($folder_d['m_type'] === 'user_folder') {
            $isUserSubFolder = true;
        } elseif ($folder_d['m_type'] === 'local') {
            $isUserRootFolder = true;
        }
 
        $mailtable = $this->getMailFolderTable();
        $mailtable->setSelectedItems($this->getMailIdsFromRequest(true));
 
        try {
            $mailtable->prepareHTML();
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($e->getMessage()) !== '-' . $e->getMessage() . '-' ?
                $this->lng->txt($e->getMessage()) :
                $e->getMessage());
        }
 
        $table_html = $mailtable->getHTML();
 
        if ($oneConfirmationDialogueRendered === false && $this->confirmTrashDeletion === false) {
            $this->toolbar->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
 
            if ($isUserRootFolder || $isUserSubFolder) {
                $this->addSubFolderCommands($isUserSubFolder);
            }
        }
 
        if ($this->confirmTrashDeletion && $mailtable->isTrashFolder() && $mailtable->getNumberOfMails() > 0) {
            $confirmationGui = new ilConfirmationGUI();
            $confirmationGui->setHeaderText($this->lng->txt('mail_empty_trash_confirmation'));
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'performEmptyTrash'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'performEmptyTrash');
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
        }
 
        $this->tpl->setVariable('MAIL_TABLE', $table_html);
        $this->tpl->printToStdout();
    }

References Vendor\Package\$e, addSubFolderCommands(), ILIAS\Repository\ctrl(), getMailFolderTable(), getMailIdsFromRequest(), ILIAS\Repository\lng(), parseCommand(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by applyFilter(), confirmDeleteMails(), confirmEmptyTrash(), deleteMails(), deleteSubFolder(), markMailsRead(), markMailsUnread(), moveMails(), performDeleteSubFolder(), performRenameSubFolder(), and resetFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showUser()

ilMailFolderGUI::showUser ( )

protected

Exceptions

ilCtrlException

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

                                 : void
    {
        $userId = 0;
        if ($this->http->wrapper()->query()->has('user')) {
            $userId = $this->http->wrapper()->query()->retrieve('user', $this->refinery->kindlyTo()->int());
        }
        $this->tpl->setVariable('TBL_TITLE', implode(' ', [
            $this->lng->txt('profile_of'),
            ilObjUser::_lookupLogin($userId),
        ]));
        $this->tpl->setVariable('TBL_TITLE_IMG', ilUtil::getImagePath('icon_usr.svg'));
        $this->tpl->setVariable('TBL_TITLE_IMG_ALT', $this->lng->txt('public_profile'));
 
        $profile_gui = new ilPublicUserProfileGUI($userId);
 
        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
 
        $this->ctrl->setParameter(
            $this,
            'mail_id',
            $mailId
        );
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $profile_gui->setBackUrl($this->ctrl->getLinkTarget($this, 'showMail'));
        $this->ctrl->clearParameters($this);
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($this->ctrl->getHTML($profile_gui));
        $this->tpl->printToStdout();
    }

References ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Field Documentation

◆ $confirmTrashDeletion

bool ilMailFolderGUI::$confirmTrashDeletion = false

private

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

◆ $ctrl

ilCtrlInterface ilMailFolderGUI::$ctrl

private

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

◆ $currentFolderId

int ilMailFolderGUI::$currentFolderId = 0

private

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

◆ $error

ilErrorHandling ilMailFolderGUI::$error

private

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

◆ $errorDelete

bool ilMailFolderGUI::$errorDelete = false

private

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

◆ $http

GlobalHttpState ilMailFolderGUI::$http

private

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

◆ $lng

ilLanguage ilMailFolderGUI::$lng

private

Definition at line 37 of file class.ilMailFolderGUI.php.

◆ $mbox

ilMailbox ilMailFolderGUI::$mbox

Definition at line 42 of file class.ilMailFolderGUI.php.

◆ $refinery

Refinery ilMailFolderGUI::$refinery

private

Definition at line 44 of file class.ilMailFolderGUI.php.

◆ $tabs

ilTabsGUI ilMailFolderGUI::$tabs

private

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

◆ $toolbar

ilToolbarGUI ilMailFolderGUI::$toolbar

private

Definition at line 38 of file class.ilMailFolderGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilMailFolderGUI::$tpl

private

Definition at line 35 of file class.ilMailFolderGUI.php.

◆ $umail

ilMail ilMailFolderGUI::$umail

Definition at line 41 of file class.ilMailFolderGUI.php.

◆ $user

ilObjUser ilMailFolderGUI::$user

private

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

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

Services/Mail/classes/class.ilMailFolderGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSubFolder()

◆ addSubFolderCommands()

◆ applyFilter()

◆ confirmDeleteMails()

◆ confirmEmptyTrash()

◆ deleteMails()

◆ deleteSubFolder()

◆ deliverAttachments()

◆ deliverFile()

◆ executeCommand()

◆ getMailFolderTable()

◆ getMailIdsFromRequest()

◆ getSubFolderForm()

◆ initFolder()

◆ markMailsRead()

◆ markMailsUnread()

◆ moveMails()

◆ moveSingleMail()

◆ parseCommand()

◆ parseFolderIdFromCommand()

◆ performAddSubFolder()

◆ performDeleteSubFolder()

◆ performEmptyTrash()

◆ performRenameSubFolder()

◆ renameSubFolder()

◆ resetFilter()

◆ showFolder()

◆ showUser()

Field Documentation

◆ $confirmTrashDeletion

◆ $ctrl

◆ $currentFolderId

◆ $error

◆ $errorDelete

◆ $http

◆ $lng

◆ $mbox

◆ $refinery

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $umail

◆ $user