ilMailFolderGUI Class Reference

ilMailFolderGUI: More...

Collaboration diagram for ilMailFolderGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Protected Member Functions
	initRequest ()
	Init class variables that can be determined in an actual request. More...
	executeTableAction ()
	emptyTrash ()
	showUser ()
	showFolder ()
	redirectToFolder ()
	deleteSubFolder ()
	addSubFolder ()
	renameSubFolder ()
	getFilterUI ()
	getFilteredSearch ()
	Searcher for mails in the folder, initialized with the current filter values needed for table display and actions for the whole table. More...
	getMailIdsFromRequest ()
	moveSingleMail ()
	Move a single mail to a folder Called from showMail page. More...
	deleteMails ()
	confirmDeleteMails (array $mail_ids)
	Confirm the deletion of selected mails in async modal. More...
	printMail ()
	deliverFile ()
	deliverAttachments ()

Private Attributes
const string	URL_BUILDER_PREFIX = 'ilMailFolderGUI'
const string	PARAM_ACTION = 'action'
const string	PARAM_FOLDER_ID = 'mobj_id'
const string	PARAM_MAIL_ID = 'mail_id'
const string	PARAM_USER_ID = 'user_id'
const string	PARAM_TARGET_FOLDER = 'target_folder'
const string	PARAM_INTERRUPTIVE_ITEMS = 'interruptive_items'
const string	CMD_ADD_SUB_FOLDER = 'addSubFolder'
const string	CMD_DELETE_MAILS = 'deleteMails'
const string	CMD_DELETE_SUB_FOLDER = 'deleteSubFolder'
const string	CMD_DELIVER_FILE = 'deliverFile'
const string	CMD_EMPTY_TRASH = 'emptyTrash'
const string	CMD_MOVE_SINGLE_MAIL = 'moveSingleMail'
const string	CMD_PRINT_MAIL = 'printMail'
const string	CMD_RENAME_SUB_FOLDER = 'renameSubFolder'
const string	CMD_SHOW_MAIL = 'showMail'
const string	CMD_SHOW_FOLDER = 'showFolder'
const string	CMD_SHOW_USER = 'showUser'
const string	CMD_TABLE_ACTION = 'executeTableAction'
readonly ilGlobalTemplateInterface	$tpl
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng
readonly ilToolbarGUI	$toolbar
readonly ilTabsGUI	$tabs
readonly ilObjUser	$user
readonly GlobalHttpState	$http
readonly Refinery	$refinery
readonly ilErrorHandling	$error
readonly Factory	$ui_factory
readonly Renderer	$ui_renderer
readonly ilUIService	$ui_service
readonly DataFactory	$data_factory
ilMail	$umail
ilMailbox	$mbox
MailFolderData	$folder

Detailed Description

ilMailFolderGUI:

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

Constructor & Destructor Documentation

__construct()

ilMailFolderGUI::__construct

(

)

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

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), 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->ui_service = $DIC->uiService();
        $this->data_factory = new ILIAS\Data\Factory();
    }

Here is the call graph for this function:

Member Function Documentation

addSubFolder()

ilMailFolderGUI::addSubFolder ( )

protected

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

References $data, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, and ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS.

                                     : void
    {
        $form = $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, self::CMD_ADD_SUB_FOLDER),
            [
                'folder' => $this->ui_factory->input()->field()->section([
                    'title' => $this->ui_factory->input()->field()->text($this->lng->txt('title'))->withRequired(true)
                ], $this->lng->txt('mail_add_folder'))
            ]
        );

        $request = $this->http->request();
        if ($request->getMethod() === 'POST') {
            $form = $form->withRequest($request);
            $data = $form->getData();
            if (!empty($data['folder']['title'])) {
                $new_folder_id = $this->mbox->addFolder(
                    $this->folder->getFolderId(),
                    (string) $data['folder']['title']
                );
                if ($new_folder_id > 0) {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                        $this->lng->txt('mail_folder_created'),
                        true
                    );
                    $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, $new_folder_id);
                    $this->ctrl->redirect($this, self::CMD_SHOW_FOLDER);
                } else {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                        $this->lng->txt('mail_folder_exists')
                    );
                }
            }
        }
        $this->tpl->setContent($this->ui_renderer->render($form));
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

confirmDeleteMails()

ilMailFolderGUI::confirmDeleteMails ( array  $mail_ids )

protected

Confirm the deletion of selected mails in async modal.

Parameters

int[]

$mail_ids

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

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

Referenced by executeTableAction().

                                                          : void
    {
        $user_timezone = new DateTimeZone($this->user->getTimeZone());
        $records = $this->getFilteredSearch()->forMailIds($mail_ids)->getPagedRecords(10, 0, null, null);
        $items = [];
        foreach ($records as $record) {
            $prefix = '';
            if (!empty($record->getSendTime())) {
                $time = $record->getSendTime()->setTimezone($user_timezone);
                $prefix = $time->format($this->user->getDateFormat()->toString()) . ' ';
            }
            $items[] = $this->ui_factory->modal()->interruptiveItem()->standard(
                (string) $record->getMailId(),
                $prefix . $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($record->getSubject())
            );
        }

        $modal = $this->ui_factory->modal()->interruptive(
            $this->lng->txt('delete'),
            $this->lng->txt('mail_sure_delete_' . (count($items) === 1 ? 's' : 'p')),
            $this->ctrl->getFormAction($this, self::CMD_DELETE_MAILS)
        )->withAffectedItems($items);

        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString($this->ui_renderer->renderAsync($modal))
            )
        );
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteMails()

ilMailFolderGUI::deleteMails ( )

protected

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

References getMailIdsFromRequest(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_INFO, and redirectToFolder().

                                    : void
    {
        if (!$this->folder->isTrash()) {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('mail_operation_on_invalid_folder'),
                true
            );
            $this->redirectToFolder();
        }

        $this->umail->deleteMails($this->getMailIdsFromRequest());
        $this->tpl->setOnScreenMessage(
            ilGlobalTemplateInterface::MESSAGE_TYPE_INFO,
            $this->lng->txt('mail_deleted'),
            true
        );
        $this->redirectToFolder();
    }

Here is the call graph for this function:

deleteSubFolder()

ilMailFolderGUI::deleteSubFolder ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS, and redirectToFolder().

                                        : void
    {
        $parent_folder_id = $this->mbox->getParentFolderId($this->folder->getFolderId());
        if ($parent_folder_id > 0 && $this->mbox->deleteFolder($this->folder->getFolderId())) {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                $this->lng->txt('mail_folder_deleted'),
                true
            );
            $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, $parent_folder_id);
            $this->ctrl->redirect($this, self::CMD_SHOW_FOLDER);
        } else {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('mail_error_delete'),
                true
            );
            $this->redirectToFolder();
        }
    }

Here is the call graph for this function:

deliverAttachments()

ilMailFolderGUI::deliverAttachments ( )

protected

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

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

Referenced by executeTableAction().

                                           : void
    {
        try {
            $mail_id = $this->getMailIdsFromRequest()[0] ?? 0;
            $mail_data = $this->umail->getMail($mail_id);
            if ($mail_data === null || [] === (array) $mail_data['attachments']) {
                throw new ilMailException('mail_error_reading_attachment');
            }

            $type = $this->http->wrapper()->query()->retrieve(
                'type',
                $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
            );

            $mail_file_data = new ilFileDataMail($this->user->getId());
            if (count($mail_data['attachments']) === 1) {
                $attachment = current($mail_data['attachments']);

                try {
                    if ($type === 'draft') {
                        if (!$mail_file_data->checkFilesExist([$attachment])) {
                            throw new OutOfBoundsException('');
                        }
                        $path_to_file = $mail_file_data->getAbsoluteAttachmentPoolPathByFilename($attachment);
                        $filename = $attachment;
                    } else {
                        $file = $mail_file_data->getAttachmentPathAndFilenameByMd5Hash(
                            md5((string) $attachment),
                            $mail_id
                        );
                        $path_to_file = $file['path'];
                        $filename = $file['filename'];
                    }
                    ilFileDelivery::deliverFileLegacy($path_to_file, $filename);
                } catch (OutOfBoundsException $e) {
                    throw new ilMailException('mail_error_reading_attachment', $e->getCode(), $e);
                }
            } else {
                $mail_file_data->deliverAttachmentsAsZip(
                    $mail_data['m_subject'],
                    $mail_id,
                    $mail_data['attachments'],
                    $type === 'draft'
                );
            }
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($e->getMessage()), true);
            $this->redirectToFolder();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFile()

ilMailFolderGUI::deliverFile ( )

protected

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

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

                                    : void
    {
        $mail_id = $this->http->wrapper()->query()->retrieve(
            self::PARAM_MAIL_ID,
            $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $this->refinery->always(0)])
        );
        if ($mail_id <= 0) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $filename = $this->http->wrapper()->post()->retrieve(
            'filename',
            $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
        );

        if (is_string(ilSession::get('filename')) && ilSession::get('filename') !== '') {
            $filename = ilSession::get('filename');
            ilSession::set('filename', null);
        }

        try {
            if ($mail_id > 0 && $filename !== '') {
                while (str_contains((string) $filename, '..')) {
                    $filename = str_replace('..', '', $filename);
                }

                $mail_file_data = new ilFileDataMail($this->user->getId());
                try {
                    $file = $mail_file_data->getAttachmentPathAndFilenameByMd5Hash($filename, (int) $mail_id);
                    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->redirectToFolder();
        }
    }

Here is the call graph for this function:

emptyTrash()

ilMailFolderGUI::emptyTrash ( )

protected

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

References ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS, and redirectToFolder().

                                   : void
    {
        $this->umail->deleteMailsOfFolder($this->mbox->getTrashFolder());
        $this->tpl->setOnScreenMessage(
            ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('mail_deleted'),
            true
        );
        $this->redirectToFolder();
    }

Here is the call graph for this function:

executeCommand()

ilMailFolderGUI::executeCommand

(

)

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

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

                                    : void
    {
        $this->initRequest();

        $next_class = $this->ctrl->getNextClass($this) ?? '';
        switch (strtolower($next_class)) {
            case strtolower(ilContactGUI::class):
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;

            default:
                $cmd = $this->ctrl->getCmd() ?? '';
                match ($cmd) {
                    self::CMD_ADD_SUB_FOLDER, self::CMD_DELETE_MAILS, self::CMD_DELETE_SUB_FOLDER, self::CMD_DELIVER_FILE, self::CMD_EMPTY_TRASH, self::CMD_MOVE_SINGLE_MAIL, self::CMD_PRINT_MAIL, self::CMD_RENAME_SUB_FOLDER, self::CMD_SHOW_MAIL, self::CMD_SHOW_FOLDER, self::CMD_SHOW_USER, self::CMD_TABLE_ACTION => $this->{$cmd}(
                    ),
                    default => $this->showFolder(),
                };
        }
    }

Here is the call graph for this function:

executeTableAction()

ilMailFolderGUI::executeTableAction ( )

protected

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

References confirmDeleteMails(), ILIAS\Repository\ctrl(), deliverAttachments(), getFilteredSearch(), getMailIdsFromRequest(), ilMailUserCache\getUserObjectById(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_DRAFT, ilMailFormGUI\MAIL_FORM_TYPE_FORWARD, ilMailFormGUI\MAIL_FORM_TYPE_REPLY, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_INFO, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS, printMail(), redirectToFolder(), and ILIAS\Repository\refinery().

                                           : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            self::URL_BUILDER_PREFIX . URLBuilder::SEPARATOR . self::PARAM_ACTION,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );

        // Magic value of data table in ui framework, no public constant found
        $for_all_entries = implode(
            '',
            $this->http->wrapper()->query()->retrieve(
                self::URL_BUILDER_PREFIX . URLBuilder::SEPARATOR . self::PARAM_MAIL_ID,
                $this->refinery->byTrying([
                        $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                        $this->refinery->always([])
                    ])
            )
        ) === 'ALL_OBJECTS';

        if ($for_all_entries) {
            // we must apply the filter because the shown table is filtered, too
            $mail_ids = $this->getFilteredSearch()->getMaiIds();
        } else {
            $mail_ids = $this->getMailIdsFromRequest();
        }

        if (empty($mail_ids)) {
            // no redirect possible from async call
            if ($action === MailFolderTableUI::ACTION_DELETE) {
                $modal = $this->ui_factory->modal()->lightbox(
                    $this->ui_factory->modal()->lightboxTextPage(
                        $this->ui_renderer->render(
                            $this->ui_factory->messageBox()->failure($this->lng->txt('mail_select_one'))
                        ),
                        $this->lng->txt('delete'),
                    )
                );
                $this->http->saveResponse(
                    $this->http->response()->withBody(
                        Streams::ofString($this->ui_renderer->renderAsync($modal))
                    )
                );
                $this->http->sendResponse();
                $this->http->close();
            } else {
                $this->tpl->setOnScreenMessage(
                    ilGlobalTemplateInterface::MESSAGE_TYPE_INFO,
                    $this->lng->txt('mail_select_one'),
                    true
                );
                $this->redirectToFolder();
            }
        }

        switch ($action) {
            case MailFolderTableUI::ACTION_SHOW:
                $this->showMail();
                return;

            case MailFolderTableUI::ACTION_EDIT:
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    self::PARAM_FOLDER_ID,
                    (string) $this->folder->getFolderId()
                );
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, self::PARAM_MAIL_ID, (string) $mail_ids[0]);
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_DRAFT);
                $this->ctrl->redirectByClass(ilMailFormGUI::class);

                // no break
            case MailFolderTableUI::ACTION_REPLY:
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    self::PARAM_FOLDER_ID,
                    (string) $this->folder->getFolderId()
                );
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, self::PARAM_MAIL_ID, (string) $mail_ids[0]);
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_REPLY);
                $this->ctrl->redirectByClass(ilMailFormGUI::class);

                // no break
            case MailFolderTableUI::ACTION_FORWARD:
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    self::PARAM_FOLDER_ID,
                    (string) $this->folder->getFolderId()
                );
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, self::PARAM_MAIL_ID, (string) $mail_ids[0]);
                $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_FORWARD);
                $this->ctrl->redirectByClass(ilMailFormGUI::class);

                // no break
            case MailFolderTableUI::ACTION_DOWNLOAD_ATTACHMENT:
                $this->deliverAttachments();
                return;

            case MailFolderTableUI::ACTION_PRINT:
                $this->printMail();
                return;

            case MailFolderTableUI::ACTION_PROFILE:
                $mail_data = $this->umail->getMail($mail_ids[0] ?? 0);
                if (!empty($user = ilMailUserCache::getUserObjectById($mail_data['sender_id'] ?? 0)) &&
                    $user->hasPublicProfile()) {
                    $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, (string) $this->folder->getFolderId());
                    $this->ctrl->setParameter($this, self::PARAM_USER_ID, (string) $user->getId());
                    $this->ctrl->redirect($this, self::CMD_SHOW_USER);
                } else {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                        $this->lng->txt('permission_denied'),
                        true
                    );
                }
                break;

            case MailFolderTableUI::ACTION_MARK_READ:
                $this->umail->markRead($mail_ids);
                $this->tpl->setOnScreenMessage(
                    ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                    $this->lng->txt('saved_successfully'),
                    true
                );
                break;

            case MailFolderTableUI::ACTION_MARK_UNREAD:
                $this->umail->markUnread($mail_ids);
                $this->tpl->setOnScreenMessage(
                    ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                    $this->lng->txt('saved_successfully'),
                    true
                );
                break;

            case MailFolderTableUI::ACTION_MOVE_TO:
                $folder_id = $this->http->wrapper()->query()->retrieve(
                    self::URL_BUILDER_PREFIX . URLBuilder::SEPARATOR . self::PARAM_TARGET_FOLDER,
                    $this->refinery->kindlyTo()->int()
                );
                if (empty($folder_id)) {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                        $this->lng->txt('mail_move_error')
                    );
                } elseif ($this->umail->moveMailsToFolder($mail_ids, $folder_id)) {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                        $this->lng->txt('mail_moved'),
                        true
                    );
                } else {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                        $this->lng->txt('mail_move_error')
                    );
                }
                break;

            case MailFolderTableUI::ACTION_DELETE: // async call
                $this->confirmDeleteMails($mail_ids);
                break;

            default:
                $this->tpl->setOnScreenMessage(
                    ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                    $this->lng->txt('permission_denied')
                );
                break;
        }

        $this->redirectToFolder();
    }

Here is the call graph for this function:

getFilteredSearch()

ilMailFolderGUI::getFilteredSearch ( )

protected

Searcher for mails in the folder, initialized with the current filter values needed for table display and actions for the whole table.

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

References getFilterUI(), and ilSearchSettings\getInstance().

Referenced by confirmDeleteMails(), executeTableAction(), and showFolder().

                                          : MailFolderSearch
    {
        return new MailFolderSearch(
            $this->folder,
            $this->getFilterUI()->getData(),
            ilSearchSettings::getInstance()->enabledLucene(),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilterUI()

ilMailFolderGUI::getFilterUI ( )

protected

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

References $folder, $lng, $ui_factory, ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), and ILIAS\Repository\user().

Referenced by getFilteredSearch(), and showFolder().

                                    : MailFilterUI
    {
        return new MailFilterUI(
            $this->ctrl->getFormAction($this, self::CMD_SHOW_FOLDER),
            ilSearchSettings::getInstance()->enabledLucene(),
            $this->folder,
            $this->ui_factory,
            $this->ui_service->filter(),
            $this->lng,
            new DateTimeZone($this->user->getTimeZone()),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailIdsFromRequest()

ilMailFolderGUI::getMailIdsFromRequest ( )

protected

Returns

int[]

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

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

Referenced by confirmDeleteMails(), deleteMails(), deliverAttachments(), executeTableAction(), moveSingleMail(), and printMail().

                                              : array
    {
        // table actions have a prefix, controller commands and modal items have none
        foreach (
            [
                self::URL_BUILDER_PREFIX . URLBuilder::SEPARATOR . self::PARAM_MAIL_ID,
                self::PARAM_MAIL_ID,
                self::PARAM_INTERRUPTIVE_ITEMS
            ] as $param
        ) {
            foreach (
                [
                    $this->http->wrapper()->post(),
                    $this->http->wrapper()->query()
                ] as $wrapper
            ) {
                if ($wrapper->has($param)) {
                    return $wrapper->retrieve(
                        $param,
                        $this->refinery->byTrying([
                            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                            $this->refinery->always([])
                        ])
                    );
                }
            }
        }

        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRequest()

ilMailFolderGUI::initRequest ( )

protected

Init class variables that can be determined in an actual request.

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

References $folder, ilSession\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, null, ILIAS\Repository\refinery(), ILIAS\Refinery\transform(), and ILIAS\Repository\user().

Referenced by executeCommand().

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

        if ($this->http->wrapper()->post()->has(self::PARAM_FOLDER_ID)) {
            $folder_id = $this->http->wrapper()->post()->retrieve(
                self::PARAM_FOLDER_ID,
                $this->refinery->kindlyTo()->int()
            );
        } elseif ($this->http->wrapper()->query()->has(self::PARAM_FOLDER_ID)) {
            $folder_id = $this->http->wrapper()->query()->retrieve(
                self::PARAM_FOLDER_ID,
                $this->refinery->kindlyTo()->int()
            );
        } else {
            $folder_id = $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always(0),
            ])->transform(ilSession::get(self::PARAM_FOLDER_ID));
        }

        if ($folder_id === 0 || !$this->mbox->isOwnedFolder($folder_id)) {
            $folder_id = $this->mbox->getInboxFolder();
        }

        $folder = $this->mbox->getFolderData($folder_id);
        if ($folder === null) {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('mail_operation_on_invalid_folder')
            );
            $this->tpl->printToStdout();
        }
        $this->folder = $folder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveSingleMail()

ilMailFolderGUI::moveSingleMail ( )

protected

Move a single mail to a folder Called from showMail page.

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

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

                                       : void
    {
        $mail_ids = $this->getMailIdsFromRequest();
        if (count($mail_ids) !== 1) {
            $this->showMail();
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one'));
            return;
        }

        $new_folder_id = $this->http->wrapper()->query()->retrieve(
            'folder_id',
            $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $this->refinery->always(0)])
        );
        $redirect_folder_id = $new_folder_id;

        foreach ($mail_ids as $mail_id) {
            $mail_data = $this->umail->getMail($mail_id);
            if (isset($mail_data['folder_id']) &&
                is_numeric($mail_data['folder_id']) &&
                (int) $mail_data['folder_id'] > 0) {
                $redirect_folder_id = (int) $mail_data['folder_id'];
                break;
            }
        }

        if ($this->umail->moveMailsToFolder($mail_ids, $new_folder_id)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_moved'), true);
            $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, $redirect_folder_id);
            $this->ctrl->redirect($this, self::CMD_SHOW_FOLDER);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_move_error'));
            $this->showMail();
        }
    }

Here is the call graph for this function:

printMail()

ilMailFolderGUI::printMail ( )

protected

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

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

Referenced by executeTableAction().

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

        $mail_id = $this->getMailIdsFromRequest()[0] ?? 0;
        $mail_data = $this->umail->getMail($mail_id);

        $sender = ilObjectFactory::getInstanceByObjId($mail_data['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 || $sender->getId() === 0) {
            $tplprint->setVariable(
                'FROM',
                trim(($mail_data['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', $mail_data['rcp_to']);

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

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

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

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

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

        $tplprint->show();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToFolder()

ilMailFolderGUI::redirectToFolder ( )

protected

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

References ILIAS\Repository\ctrl().

Referenced by deleteMails(), deleteSubFolder(), deliverAttachments(), deliverFile(), emptyTrash(), executeTableAction(), and renameSubFolder().

                                         : never
    {
        $this->ctrl->clearParameters($this);
        $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, $this->folder->getFolderId());
        $this->ctrl->redirect($this, self::CMD_SHOW_FOLDER);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renameSubFolder()

ilMailFolderGUI::renameSubFolder ( )

protected

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

References $data, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS, and redirectToFolder().

                                        : void
    {
        $form = $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, self::CMD_RENAME_SUB_FOLDER),
            [
                'folder' => $this->ui_factory->input()->field()->section([
                    'title' => $this->ui_factory->input()->field()->text($this->lng->txt('title'))->withRequired(true)
                ], $this->lng->txt('mail_rename_folder'))
            ]
        );

        $request = $this->http->request();
        if ($request->getMethod() === 'POST') {
            $form = $form->withRequest($request);
            $data = $form->getData();
            if (!empty($data['folder']['title'])) {
                if ($this->mbox->renameFolder($this->folder->getFolderId(), (string) $data['folder']['title'])) {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
                        $this->lng->txt('mail_folder_name_changed'),
                        true
                    );
                    $this->redirectToFolder();
                } else {
                    $this->tpl->setOnScreenMessage(
                        ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                        $this->lng->txt('mail_folder_exists')
                    );
                }
            }
        }
        $this->tpl->setContent($this->ui_renderer->render($form));
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

showFolder()

ilMailFolderGUI::showFolder ( )

protected

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

References $components, $data_factory, $folder, $lng, $refinery, $ui_factory, $ui_renderer, $umail, ilUtil\_getHttpPath(), ILIAS\Repository\ctrl(), getFilteredSearch(), getFilterUI(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                   : void
    {
        $components = [];
        $this->ctrl->setParameter($this, self::PARAM_FOLDER_ID, $this->folder->getFolderId());

        if ($this->folder->isUserLocalFolder()) {
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt('mail_add_subfolder'),
                    $this->ctrl->getLinkTarget($this, self::CMD_ADD_SUB_FOLDER)
                )
            );
        }

        if ($this->folder->isUserFolder()) {
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt('rename'),
                    $this->ctrl->getLinkTarget($this, self::CMD_RENAME_SUB_FOLDER)
                )
            );

            $components[] = $modal = $this->ui_factory->modal()->interruptive(
                $this->lng->txt('delete'),
                $this->lng->txt('mail_sure_delete_folder'),
                $this->ctrl->getLinkTarget($this, self::CMD_DELETE_SUB_FOLDER)
            );
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt('delete'),
                    '#'
                )
                                 ->withOnClick($modal->getShowSignal())
            );
        }

        if ($this->folder->isTrash()) {
            $components[] = $modal = $this->ui_factory->modal()->interruptive(
                $this->lng->txt('mail_empty_trash'),
                $this->lng->txt('mail_empty_trash_confirmation'),
                $this->ctrl->getLinkTarget($this, self::CMD_EMPTY_TRASH)
            );
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt('mail_empty_trash'),
                    '#'
                )->withOnClick($modal->getShowSignal())
            );
        }

        [
            $url_builder,
            $action_token,
            $row_id_token,
            $target_token,
        ] = (new URLBuilder(
            $this->data_factory->uri(
                ilUtil::_getHttpPath() . '/' .
                $this->ctrl->getLinkTarget($this, self::CMD_TABLE_ACTION)
            )
        )
        )->acquireParameters(
            [self::URL_BUILDER_PREFIX],
            self::PARAM_ACTION,
            self::PARAM_MAIL_ID,
            self::PARAM_TARGET_FOLDER
        );

        $table = new MailFolderTableUI(
            $url_builder,
            $action_token,
            $row_id_token,
            $target_token,
            $this->mbox->getSubFolders(),
            $this->folder,
            $this->getFilteredSearch(),
            $this->umail,
            $this->ui_factory,
            $this->ui_renderer,
            $this->lng,
            $this->http->request(),
            $this->data_factory,
            $this->refinery,
            $this->user->getDateFormat(),
            $this->user->getTimeFormat(),
            new DateTimeZone($this->user->getTimeZone())
        );

        $components[] = $this->getFilterUI()->getComponent();
        $components[] = $table->getComponent();

        $this->tpl->setTitle($this->folder->getTitle());
        $this->tpl->setContent($this->ui_renderer->render($components));
        $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 350 of file class.ilMailFolderGUI.php.

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

                                 : void
    {
        $usr_id = $this->http->wrapper()->query()->retrieve(
            self::PARAM_USER_ID,
            $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $this->refinery->always(0)])
        );

        $this->tpl->setVariable('TBL_TITLE', implode(' ', [
            $this->lng->txt('profile_of'),
            ilObjUser::_lookupLogin($usr_id),
        ]));
        $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($usr_id);

        $mail_id = $this->http->wrapper()->query()->retrieve(
            self::PARAM_MAIL_ID,
            $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $this->refinery->always(0)])
        );

        if ($mail_id > 0) {
            $this->ctrl->setParameter($this, self::PARAM_MAIL_ID, $mail_id);
            $this->tabs->clearTargets();
            $this->tabs->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this, self::CMD_SHOW_MAIL));
        } else {
            $this->tabs->clearTargets();
            $this->tabs->setBackTarget(
                $this->lng->txt('back_to_folder'),
                $this->ctrl->getLinkTarget($this, self::CMD_SHOW_FOLDER)
            );
        }

        $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

$ctrl

readonly ilCtrlInterface ilMailFolderGUI::$ctrl

private

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

$data_factory

readonly DataFactory ilMailFolderGUI::$data_factory

private

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

Referenced by showFolder().

$error

readonly ilErrorHandling ilMailFolderGUI::$error

private

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

$folder

MailFolderData ilMailFolderGUI::$folder

private

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

Referenced by getFilterUI(), initRequest(), and showFolder().

$http

readonly GlobalHttpState ilMailFolderGUI::$http

private

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

$lng

readonly ilLanguage ilMailFolderGUI::$lng

private

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

Referenced by getFilterUI(), and showFolder().

$mbox

ilMailbox ilMailFolderGUI::$mbox

private

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

$refinery

readonly Refinery ilMailFolderGUI::$refinery

private

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

Referenced by showFolder().

$tabs

readonly ilTabsGUI ilMailFolderGUI::$tabs

private

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

$toolbar

readonly ilToolbarGUI ilMailFolderGUI::$toolbar

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailFolderGUI::$tpl

private

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

$ui_factory

readonly Factory ilMailFolderGUI::$ui_factory

private

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

Referenced by getFilterUI(), and showFolder().

$ui_renderer

readonly Renderer ilMailFolderGUI::$ui_renderer

private

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

Referenced by showFolder().

$ui_service

readonly ilUIService ilMailFolderGUI::$ui_service

private

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

$umail

ilMail ilMailFolderGUI::$umail

private

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

Referenced by showFolder().

$user

readonly ilObjUser ilMailFolderGUI::$user

private

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

CMD_ADD_SUB_FOLDER

const string ilMailFolderGUI::CMD_ADD_SUB_FOLDER = 'addSubFolder'

private

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

CMD_DELETE_MAILS

const string ilMailFolderGUI::CMD_DELETE_MAILS = 'deleteMails'

private

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

CMD_DELETE_SUB_FOLDER

const string ilMailFolderGUI::CMD_DELETE_SUB_FOLDER = 'deleteSubFolder'

private

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

CMD_DELIVER_FILE

const string ilMailFolderGUI::CMD_DELIVER_FILE = 'deliverFile'

private

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

CMD_EMPTY_TRASH

const string ilMailFolderGUI::CMD_EMPTY_TRASH = 'emptyTrash'

private

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

CMD_MOVE_SINGLE_MAIL

const string ilMailFolderGUI::CMD_MOVE_SINGLE_MAIL = 'moveSingleMail'

private

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

CMD_PRINT_MAIL

const string ilMailFolderGUI::CMD_PRINT_MAIL = 'printMail'

private

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

CMD_RENAME_SUB_FOLDER

const string ilMailFolderGUI::CMD_RENAME_SUB_FOLDER = 'renameSubFolder'

private

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

CMD_SHOW_FOLDER

const string ilMailFolderGUI::CMD_SHOW_FOLDER = 'showFolder'

private

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

CMD_SHOW_MAIL

const string ilMailFolderGUI::CMD_SHOW_MAIL = 'showMail'

private

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

CMD_SHOW_USER

const string ilMailFolderGUI::CMD_SHOW_USER = 'showUser'

private

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

CMD_TABLE_ACTION

const string ilMailFolderGUI::CMD_TABLE_ACTION = 'executeTableAction'

private

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

PARAM_ACTION

const string ilMailFolderGUI::PARAM_ACTION = 'action'

private

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

PARAM_FOLDER_ID

const string ilMailFolderGUI::PARAM_FOLDER_ID = 'mobj_id'

private

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

PARAM_INTERRUPTIVE_ITEMS

const string ilMailFolderGUI::PARAM_INTERRUPTIVE_ITEMS = 'interruptive_items'

private

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

PARAM_MAIL_ID

const string ilMailFolderGUI::PARAM_MAIL_ID = 'mail_id'

private

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

PARAM_TARGET_FOLDER

const string ilMailFolderGUI::PARAM_TARGET_FOLDER = 'target_folder'

private

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

PARAM_USER_ID

const string ilMailFolderGUI::PARAM_USER_ID = 'user_id'

private

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

URL_BUILDER_PREFIX

const string ilMailFolderGUI::URL_BUILDER_PREFIX = 'ilMailFolderGUI'

private

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

---

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

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