ilMailGUI Class Reference

Collaboration diagram for ilMailGUI:

Public Member Functions
	__construct ()
	ilMailGUI constructor. More...
	executeCommand ()

Data Fields
	$umail
	$mbox

Protected Member Functions
	initFolder ()
	toggleExplorerNodeState ()
	Toggle explorer tree node. More...

Private Member Functions
	setViewMode ()
	showHeader ()

Private Attributes
	$tpl
	$ctrl
	$lng
	$forwardClass = ''
	$httpRequest
	$currentFolderId = 0
	$user

Detailed Description

Definition at line 13 of file class.ilMailGUI.php.

Constructor & Destructor Documentation

__construct()

ilMailGUI::__construct

(

)

ilMailGUI constructor.

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

References $DIC, initFolder(), MailGlobalScreenToolProvider\SHOW_MAIL_FOLDERS_TOOL, and user().

    {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->httpRequest = $DIC->http()->request();

        $this->lng->loadLanguageModule('mail');

        $this->mbox = new ilMailbox($this->user->getId());
        $this->umail = new ilMail($this->user->getId());
        if (!$DIC->rbac()->system()->checkAccess('internal_mail', $this->umail->getMailObjectReferenceId())) {
            $DIC['ilErr']->raiseError($this->lng->txt('permission_denied'), $DIC['ilErr']->WARNING);
        }

        $this->initFolder();


        $toolContext = $DIC->globalScreen()
                           ->tool()
                           ->context()
                           ->current();

        $additionalDataExists = $toolContext->getAdditionalData()->exists(MailGlobalScreenToolProvider::SHOW_MAIL_FOLDERS_TOOL);
        if (false === $additionalDataExists) {
            $toolContext->addAdditionalData(MailGlobalScreenToolProvider::SHOW_MAIL_FOLDERS_TOOL, true);
        }
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailGUI::executeCommand

(

)

Definition at line 95 of file class.ilMailGUI.php.

References $type, ilSession\get(), ilMailFormCall\getRecipients(), ilSession\set(), ilMailFormCall\setRecipients(), showHeader(), ilMailFormCall\storeReferer(), and ilUtil\stripSlashes().

                                     : void
    {
        $type = $this->httpRequest->getQueryParams()['type'] ?? '';
        $mailId = (int) ($this->httpRequest->getQueryParams()['mail_id'] ?? 0);

        $this->ctrl->setParameterByClass('ilmailformgui', 'mobj_id', $this->currentFolderId);
        $this->ctrl->setParameterByClass('ilmailfoldergui', 'mobj_id', $this->currentFolderId);

        if ('search_res' === $type) {
            ilMailFormCall::storeReferer($this->httpRequest->getQueryParams());
            $this->ctrl->redirectByClass('ilmailformgui', 'searchResults');
        } elseif ('attach' === $type) {
            ilMailFormCall::storeReferer($this->httpRequest->getQueryParams());
            $this->ctrl->redirectByClass('ilmailformgui', 'mailAttachment');
        } elseif ('new' === $type) {
            $to = $this->httpRequest->getQueryParams()['rcp_to'] ?? '';
            ilSession::set('rcp_to', ilUtil::stripSlashes($to));
            if (!strlen(ilSession::get('rcp_to')) && ($recipients = ilMailFormCall::getRecipients())) {
                ilSession::set('rcp_to', implode(',', $recipients));
                ilMailFormCall::setRecipients([]);
            }

            $cc = $this->httpRequest->getQueryParams()['rcp_cc'] ?? '';
            $bcc = $this->httpRequest->getQueryParams()['rcp_bcc'] ?? '';
            ilSession::set('rcp_cc', ilUtil::stripSlashes($cc));
            ilSession::set('rcp_bcc', ilUtil::stripSlashes($bcc));

            ilMailFormCall::storeReferer($this->httpRequest->getQueryParams());
            $this->ctrl->redirectByClass('ilmailformgui', 'mailUser');
        } elseif ('reply' === $type) {
            ilSession::set('mail_id', $mailId);
            $this->ctrl->redirectByClass('ilmailformgui', 'replyMail');
        } elseif ('read' === $type) {
            ilSession::set('mail_id', $mailId);
            $this->ctrl->redirectByClass('ilmailfoldergui', 'showMail');
        } elseif ('deliverFile' === $type) {
            ilSession::set('mail_id', $mailId);

            $fileName = '';
            if (isset($this->httpRequest->getParsedBody()['filename'])) {
                $fileName = $this->httpRequest->getParsedBody()['filename'];
            } elseif (isset($this->httpRequest->getQueryParams()['filename'])) {
                $fileName = $this->httpRequest->getQueryParams()['filename'];
            }
            ilSession::set('filename', ilUtil::stripSlashes($fileName));
            $this->ctrl->redirectByClass('ilmailfoldergui', 'deliverFile');
        } elseif ('message_sent' === $type) {
            ilUtil::sendSuccess($this->lng->txt('mail_message_send'), true);
            $this->ctrl->redirectByClass('ilmailfoldergui');
        } elseif ('role' === $type) {
            $roles = $this->httpRequest->getParsedBody()['roles'] ?? [];
            if (is_array($roles) && count($roles) > 0) {
                ilSession::set('mail_roles', $roles);
            } elseif (isset($this->httpRequest->getQueryParams()['role'])) {
                ilSession::set('mail_roles', [$this->httpRequest->getQueryParams()['role']]);
            }

            ilMailFormCall::storeReferer($this->httpRequest->getQueryParams());
            $this->ctrl->redirectByClass('ilmailformgui', 'mailRole');
        }

        if ('my_courses' === $this->httpRequest->getQueryParams()['view']) {
            ilSession::set('search_crs', ilUtil::stripSlashes($this->httpRequest->getQueryParams()['search_crs']));
            $this->ctrl->redirectByClass('ilmailformgui', 'searchCoursesTo');
        }

        if (isset($this->httpRequest->getQueryParams()['viewmode'])) {
            $this->ctrl->setCmd('setViewMode');
        }

        $this->forwardClass = (string) $this->ctrl->getNextClass($this);
        $this->showHeader();

        switch (strtolower($this->forwardClass)) {
            case 'ilmailformgui':
                $this->ctrl->forwardCommand(new ilMailFormGUI());
                break;

            case 'ilcontactgui':
                $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;

            case 'ilmailoptionsgui':
                $this->tpl->setTitle($this->lng->txt('mail'));
                $this->ctrl->forwardCommand(new ilMailOptionsGUI());
                break;

            case 'ilmailfoldergui':
                $this->ctrl->forwardCommand(new ilMailFolderGUI());
                break;

            default:
                if (!($cmd = $this->ctrl->getCmd()) || !method_exists($this, $cmd)) {
                    $cmd = 'setViewMode';
                }

                $this->{$cmd}();
                break;
        }
    }

Here is the call graph for this function:

initFolder()

ilMailGUI::initFolder ( )

protected

Definition at line 80 of file class.ilMailGUI.php.

Referenced by __construct().

                                    : void
    {
        $folderId = (int) ($this->httpRequest->getParsedBody()['mobj_id'] ?? 0);
        if (0 === $folderId) {
            $folderId = (int) ($this->httpRequest->getQueryParams()['mobj_id'] ?? 0);
        }
        if (0 === $folderId || !$this->mbox->isOwnedFolder($folderId)) {
            $folderId = $this->mbox->getInboxFolder();
        }
        $this->currentFolderId = (int) $folderId;
    }

Here is the caller graph for this function:

setViewMode()

ilMailGUI::setViewMode ( )

private

Definition at line 200 of file class.ilMailGUI.php.

References $type.

                                   : void
    {
        $targetClass = $this->httpRequest->getQueryParams()['target'] ?? 'ilmailfoldergui';
        $type = $this->httpRequest->getQueryParams()['type'] ?? '';
        $mailId = (int) ($this->httpRequest->getQueryParams()['mail_id'] ?? 0);

        $this->ctrl->setParameterByClass($targetClass, 'mobj_id', $this->currentFolderId);

        if ('redirect_to_read' === $type) {
            $this->ctrl->setParameterByClass(
                'ilMailFolderGUI',
                'mail_id',
                $mailId
            );
            $this->ctrl->setParameterByClass('ilmailfoldergui', 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirectByClass('ilMailFolderGUI', 'showMail');
        } elseif ('add_subfolder' === $type) {
            $this->ctrl->redirectByClass($targetClass, 'addSubFolder');
        } elseif ('enter_folderdata' === $type) {
            $this->ctrl->redirectByClass($targetClass, 'enterFolderData');
        } elseif ('confirmdelete_folderdata' === $type) {
            $this->ctrl->redirectByClass($targetClass, 'confirmDeleteFolder');
        } else {
            $this->ctrl->redirectByClass($targetClass);
        }
    }

showHeader()

ilMailGUI::showHeader ( )

private

Definition at line 230 of file class.ilMailGUI.php.

References $DIC, ilUtil\getImagePath(), and ilUtil\infoPanel().

Referenced by executeCommand().

                                  : void
    {
        global $DIC;

        $DIC['ilHelp']->setScreenIdComponent("mail");
        $DIC['ilMainMenu']->setActive("mail");

        $this->tpl->loadStandardTemplate();
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_mail.svg"));

        ilUtil::infoPanel();

        $this->ctrl->setParameterByClass('ilmailfoldergui', 'mobj_id', $this->currentFolderId);
        $DIC->tabs()->addTarget('fold', $this->ctrl->getLinkTargetByClass('ilmailfoldergui'));
        $this->ctrl->clearParametersByClass('ilmailformgui');

        $this->ctrl->setParameterByClass('ilmailformgui', 'type', 'new');
        $this->ctrl->setParameterByClass('ilmailformgui', 'mobj_id', $this->currentFolderId);
        $DIC->tabs()->addTarget('compose', $this->ctrl->getLinkTargetByClass('ilmailformgui'));
        $this->ctrl->clearParametersByClass('ilmailformgui');

        $this->ctrl->setParameterByClass('ilcontactgui', 'mobj_id', $this->currentFolderId);
        $DIC->tabs()->addTarget('mail_addressbook', $this->ctrl->getLinkTargetByClass('ilcontactgui'));
        $this->ctrl->clearParametersByClass('ilcontactgui');

        if ($DIC->settings()->get('show_mail_settings')) {
            $this->ctrl->setParameterByClass('ilmailoptionsgui', 'mobj_id', $this->currentFolderId);
            $DIC->tabs()->addTarget('options', $this->ctrl->getLinkTargetByClass('ilmailoptionsgui'));
            $this->ctrl->clearParametersByClass('ilmailoptionsgui');
        }

        switch ($this->forwardClass) {
            case 'ilmailformgui':
                $DIC->tabs()->setTabActive('compose');
                break;

            case 'ilcontactgui':
                $DIC->tabs()->setTabActive('mail_addressbook');
                break;

            case 'ilmailoptionsgui':
                $DIC->tabs()->setTabActive('options');
                break;

            case 'ilmailfoldergui':
            default:
                $DIC->tabs()->setTabActive('fold');
                break;
        }

        if (isset($this->httpRequest->getQueryParams()['message_sent'])) {
            $DIC->tabs()->setTabActive('fold');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toggleExplorerNodeState()

ilMailGUI::toggleExplorerNodeState ( )

protected

Toggle explorer tree node.

Definition at line 288 of file class.ilMailGUI.php.

References ilTreeExplorerGUI\toggleExplorerNodeState(), and user().

                                                 : void
    {
        $exp = new ilMailExplorer($this, $this->user->getId());
        $exp->toggleExplorerNodeState();
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilMailGUI::$ctrl

private

Definition at line 19 of file class.ilMailGUI.php.

$currentFolderId

ilMailGUI::$currentFolderId = 0

private

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

$forwardClass

ilMailGUI::$forwardClass = ''

private

Definition at line 25 of file class.ilMailGUI.php.

$httpRequest

ilMailGUI::$httpRequest

private

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

$lng

ilMailGUI::$lng

private

Definition at line 22 of file class.ilMailGUI.php.

$mbox

ilMailGUI::$mbox

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

$tpl

ilMailGUI::$tpl

private

Definition at line 16 of file class.ilMailGUI.php.

$umail

ilMailGUI::$umail

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

$user

ilMailGUI::$user

private

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

---

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

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