ilMailFolderGUI Class Reference

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 ()
	printMail ()
	deliverFile ()
	deliverAttachments ()
	getMailFolderTable ()
	applyFilter ()
	resetFilter ()

Protected Attributes
readonly Factory	$ui_factory
readonly Renderer	$ui_renderer

Private Attributes
bool	$confirmTrashDeletion = false
bool	$errorDelete = false
readonly ilGlobalTemplateInterface	$tpl
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng
readonly ilToolbarGUI	$toolbar
readonly ilTabsGUI	$tabs
readonly ilObjUser	$user
readonly GlobalHttpState	$http
readonly Refinery	$refinery
int	$currentFolderId = 0
readonly ilErrorHandling	$error

Detailed Description

Author

Jens Conze

Version

$Id$

ilMailFolderGUI: ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

__construct()

ilMailFolderGUI::__construct

(

)

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

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

    {
        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->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();

        $this->umail = new ilMail($this->user->getId());
        $this->mbox = new ilMailbox($this->user->getId());

        $this->initFolder();
    }

Here is the call graph for this function:

Member Function Documentation

addSubFolder()

ilMailFolderGUI::addSubFolder ( ilPropertyFormGUI  $form = null )

protected

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

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

Referenced by performAddSubFolder().

                                                                   : void
    {
        if (null === $form) {
            $form = $this->getSubFolderForm();
        }

        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

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 210 of file class.ilMailFolderGUI.php.

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

Referenced by showFolder().

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

Here is the call graph for this function:

Here is the caller graph for this function:

applyFilter()

ilMailFolderGUI::applyFilter ( )

protected

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

References getMailFolderTable(), and showFolder().

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

        $this->showFolder();
    }

Here is the call graph for this function:

confirmDeleteMails()

ilMailFolderGUI::confirmDeleteMails ( )

protected

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

References $currentFolderId, $id, $message, ilMail\_getIliasMailerName(), ilObjUser\_lookupPref(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilObjectFactory\getInstanceByObjId(), getMailIdsFromRequest(), ilUtil\htmlencodePlainString(), ILIAS\FileDelivery\http(), IL_CAL_DATETIME, ilUtil\img(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_FORWARD, ilMailFormGUI\MAIL_FORM_TYPE_REPLY, ILIAS\Repository\refinery(), ilCustomInputGUI\setHtml(), showFolder(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

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

Here is the call graph for this function:

confirmEmptyTrash()

ilMailFolderGUI::confirmEmptyTrash ( )

protected

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

References showFolder().

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

        $this->showFolder();
    }

Here is the call graph for this function:

deleteMails()

ilMailFolderGUI::deleteMails ( )

protected

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

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

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

Here is the call graph for this function:

deleteSubFolder()

ilMailFolderGUI::deleteSubFolder ( bool  $a_show_confirm = true )

protected

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

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

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

Here is the call graph for this function:

deliverAttachments()

ilMailFolderGUI::deliverAttachments ( )

protected

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

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

                                           : 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 || [] === (array) $mailData['attachments']) {
                throw new ilMailException('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 ilMailException('mail_error_reading_attachment', $e->getCode(), $e);
                }
            } 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);
        }
    }

Here is the call graph for this function:

deliverFile()

ilMailFolderGUI::deliverFile ( )

protected

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

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

                                    : 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 (str_contains((string) $filename, '..')) {
                    $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 ilMailException('mail_error_reading_attachment', $e->getCode(), $e);
                }
            } 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);
        }
    }

Here is the call graph for this function:

executeCommand()

ilMailFolderGUI::executeCommand

(

)

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

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

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

Here is the call graph for this function:

getMailFolderTable()

ilMailFolderGUI::getMailFolderTable ( )

protected

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

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

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

        return $table;
    }

Here is the caller graph for this function:

getMailIdsFromRequest()

ilMailFolderGUI::getMailIdsFromRequest ( bool  $ignoreHttpGet = false )

protected

Returns

int[]

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

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

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

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

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 338 of file class.ilMailFolderGUI.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

initFolder()

ilMailFolderGUI::initFolder ( )

protected

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

markMailsRead()

ilMailFolderGUI::markMailsRead ( )

protected

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

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

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

Here is the call graph for this function:

markMailsUnread()

ilMailFolderGUI::markMailsUnread ( )

protected

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

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

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

Here is the call graph for this function:

moveMails()

ilMailFolderGUI::moveMails ( )

protected

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

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

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

Here is the call graph for this function:

moveSingleMail()

ilMailFolderGUI::moveSingleMail ( )

protected

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

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

                                       : 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()->query()->has('folder_id')) {
            $newFolderId = $this->http->wrapper()->query()->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();
        }
    }

Here is the call graph for this function:

parseCommand()

ilMailFolderGUI::parseCommand ( string  $originalCommand )

protected

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

Referenced by executeCommand(), and showFolder().

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

        return $originalCommand;
    }

Here is the caller graph for this function:

parseFolderIdFromCommand()

ilMailFolderGUI::parseFolderIdFromCommand ( string  $command )

protected

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

Referenced by moveMails().

                                                                : 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!");
    }

Here is the caller graph for this function:

performAddSubFolder()

ilMailFolderGUI::performAddSubFolder ( )

protected

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

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

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

Here is the call graph for this function:

performDeleteSubFolder()

ilMailFolderGUI::performDeleteSubFolder ( )

protected

Exceptions

ilInvalidTreeStructureException

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

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

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

Here is the call graph for this function:

performEmptyTrash()

ilMailFolderGUI::performEmptyTrash ( )

protected

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

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

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

Here is the call graph for this function:

performRenameSubFolder()

ilMailFolderGUI::performRenameSubFolder ( )

protected

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

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

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

Here is the call graph for this function:

printMail()

ilMailFolderGUI::printMail ( )

protected

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

References ilMail\_getIliasMailerName(), ilDatePresentation\formatDate(), ilObjectFactory\getInstanceByObjId(), ILIAS\FileDelivery\http(), IL_CAL_DATETIME, ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                  : void
    {
        $tplprint = new ilTemplate('tpl.mail_print.html', true, true, 'Services/Mail');

        $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($mailId);

        $sender = ilObjectFactory::getInstanceByObjId($mailData['sender_id'], false);

        $tplprint->setVariable('TXT_FROM', $this->lng->txt('from'));
        if ($sender instanceof ilObjUser && $sender->getId() !== 0 && !$sender->isAnonymous()) {
            $tplprint->setVariable('FROM', $sender->getPublicName());
        } elseif (!$sender instanceof ilObjUser || 0 === $sender->getId()) {
            $tplprint->setVariable(
                'FROM',
                trim(($mailData['import_name'] ?? '') . ' (' . $this->lng->txt('user_deleted') . ')')
            );
        } else {
            $tplprint->setVariable('FROM', ilMail::_getIliasMailerName());
        }

        $tplprint->setVariable('TXT_TO', $this->lng->txt('mail_to'));
        $tplprint->setVariable('TO', $mailData['rcp_to']);

        if ($mailData['rcp_cc']) {
            $tplprint->setCurrentBlock('cc');
            $tplprint->setVariable('TXT_CC', $this->lng->txt('mail_cc'));
            $tplprint->setVariable('CC', $mailData['rcp_cc']);
            $tplprint->parseCurrentBlock();
        }

        if ($mailData['rcp_bcc']) {
            $tplprint->setCurrentBlock('bcc');
            $tplprint->setVariable('TXT_BCC', $this->lng->txt('mail_bcc'));
            $tplprint->setVariable('BCC', $mailData['rcp_bcc']);
            $tplprint->parseCurrentBlock();
        }

        $tplprint->setVariable('TXT_SUBJECT', $this->lng->txt('subject'));
        $tplprint->setVariable('SUBJECT', htmlspecialchars($mailData['m_subject']));

        $tplprint->setVariable('TXT_DATE', $this->lng->txt('date'));
        $tplprint->setVariable(
            'DATE',
            ilDatePresentation::formatDate(new ilDateTime($mailData['send_time'], IL_CAL_DATETIME))
        );

        $tplprint->setVariable('TXT_MESSAGE', $this->lng->txt('message'));
        $tplprint->setVariable('MAIL_MESSAGE', nl2br(htmlspecialchars($mailData['m_message'])));

        $tplprint->show();
    }

Here is the call graph for this function:

renameSubFolder()

ilMailFolderGUI::renameSubFolder ( ilPropertyFormGUI  $form = null )

protected

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

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

Referenced by performRenameSubFolder().

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

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilter()

ilMailFolderGUI::resetFilter ( )

protected

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

References getMailFolderTable(), and showFolder().

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

        $this->showFolder();
    }

Here is the call graph for this function:

showFolder()

ilMailFolderGUI::showFolder ( bool  $oneConfirmationDialogueRendered = false )

protected

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

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

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

        $selected_mail_ids = $this->getMailIdsFromRequest(true);
        if (!$this->errorDelete && $isTrashFolder && 'deleteMails' === $this->parseCommand($this->ctrl->getCmd())) {
            $confirmationGui = new ilConfirmationGUI();
            $confirmationGui->setHeaderText($this->lng->txt('mail_sure_delete'));
            $selected_mail_ids = $this->getMailIdsFromRequest();
            foreach ($selected_mail_ids 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;
        }

        $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($selected_mail_ids);

        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 && !$this->confirmTrashDeletion) {
            $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();
    }

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 176 of file class.ilMailFolderGUI.php.

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

                                 : 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('standard/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();
    }

Here is the call graph for this function:

Field Documentation

$confirmTrashDeletion

bool ilMailFolderGUI::$confirmTrashDeletion = false

private

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

$ctrl

readonly ilCtrlInterface ilMailFolderGUI::$ctrl

private

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

$currentFolderId

int ilMailFolderGUI::$currentFolderId = 0

private

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

Referenced by confirmDeleteMails().

$error

readonly ilErrorHandling ilMailFolderGUI::$error

private

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

$errorDelete

bool ilMailFolderGUI::$errorDelete = false

private

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

$http

readonly GlobalHttpState ilMailFolderGUI::$http

private

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

$lng

readonly ilLanguage ilMailFolderGUI::$lng

private

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

$mbox

ilMailbox ilMailFolderGUI::$mbox

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

$refinery

readonly Refinery ilMailFolderGUI::$refinery

private

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

$tabs

readonly ilTabsGUI ilMailFolderGUI::$tabs

private

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

$toolbar

readonly ilToolbarGUI ilMailFolderGUI::$toolbar

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailFolderGUI::$tpl

private

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

$ui_factory

readonly Factory ilMailFolderGUI::$ui_factory

protected

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

$ui_renderer

readonly Renderer ilMailFolderGUI::$ui_renderer

protected

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

$umail

ilMail ilMailFolderGUI::$umail

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

$user

readonly ilObjUser ilMailFolderGUI::$user

private

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

---

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

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