ilMailFormGUI Class Reference

Collaboration diagram for ilMailFormGUI:

Public Member Functions
	__construct (ilMailTemplateService $templateService=null, ilMailBodyPurifier $bodyPurifier=null)
	executeCommand ()
	sendMessage ()
	saveDraft ()
	searchUsers (bool $save=true)
	searchCoursesTo ()
	searchGroupsTo ()
	search ()
	cancelSearch ()
	editAttachments ()
	returnFromAttachments ()
	searchResults ()
	mailUser ()
	mailRole ()
	replyMail ()
	mailAttachment ()
	showForm ()
	lookupRecipientAsync ()
	cancelMail ()
	searchMailingListsTo ()

Data Fields
const	MAIL_FORM_TYPE_ATTACH = 'attach'
const	MAIL_FORM_TYPE_SEARCH_RESULT = 'search_res'
const	MAIL_FORM_TYPE_NEW = 'new'
const	MAIL_FORM_TYPE_ROLE = 'role'
const	MAIL_FORM_TYPE_REPLY = 'reply'
const	MAIL_FORM_TYPE_ADDRESS = 'address'
const	MAIL_FORM_TYPE_FORWARD = 'forward'
const	MAIL_FORM_TYPE_DRAFT = 'draft'

Protected Member Functions
	decodeAttachmentFiles (array $files)
	getTemplateDataById ()
	saveMailBeforeSearch ()
	showSubmissionErrors (array $errors)

Protected Attributes
ilMailTemplateService	$templateService

Private Member Functions
	getQueryParam (string $name, Transformation $trafo, $default=null)
	getBodyParam (string $name, Transformation $trafo, $default=null)

Private Attributes
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilObjUser	$user
ilTabsGUI	$tabs
ilToolbarGUI	$toolbar
ilFormatMail	$umail
ilMailbox	$mbox
ilFileDataMail	$mfile
GlobalHttpState	$http
Refinery	$refinery
array	$requestAttachments = null
ilMailBodyPurifier	$purifier
string	$mail_form_type = ''

Detailed Description

Author

Jens Conze

ilMailFormGUI: ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI

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

Constructor & Destructor Documentation

__construct()

ilMailFormGUI::__construct	(	ilMailTemplateService	$templateService = null,
		ilMailBodyPurifier	$bodyPurifier = null
	)

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

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

      {
        global $DIC;
        $this->templateService = $templateService ?? $DIC['mail.texttemplates.service'];
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->umail = new ilFormatMail($this->user->getId());
        $this->mfile = new ilFileDataMail($this->user->getId());
        $this->mbox = new ilMailbox($this->user->getId());
        $this->purifier = $bodyPurifier ?? new ilMailBodyPurifier();

        $requestMailObjId = $this->getBodyParam(
            'mobj_id',
            $this->refinery->kindlyTo()->int(),
            $this->getQueryParam(
                'mobj_id',
                $this->refinery->kindlyTo()->int(),
                0
            )
        );

        if (0 === $requestMailObjId) {
            $requestMailObjId = $this->mbox->getInboxFolder();
        }

        $this->ctrl->setParameter($this, 'mobj_id', $requestMailObjId);
    }

Here is the call graph for this function:

Member Function Documentation

cancelMail()

ilMailFormGUI::cancelMail

(

)

Definition at line 912 of file class.ilMailFormGUI.php.

References ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), and showForm().

                                : void
    {
        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        }

        $this->showForm();
    }

Here is the call graph for this function:

cancelSearch()

ilMailFormGUI::cancelSearch

(

)

Definition at line 391 of file class.ilMailFormGUI.php.

References ilSession\clear(), and searchResults().

                                  : void
    {
        ilSession::clear('mail_search');
        $this->searchResults();
    }

Here is the call graph for this function:

decodeAttachmentFiles()

ilMailFormGUI::decodeAttachmentFiles ( array  $files )

protected

Parameters

string[]

$files

Returns

string[]

Definition at line 162 of file class.ilMailFormGUI.php.

References ILIAS\Repository\user().

Referenced by saveDraft(), and sendMessage().

                                                          : array
    {
        $decodedFiles = [];

        foreach ($files as $value) {
            if (is_file($this->mfile->getMailPath() . '/' . $this->user->getId() . '_' . urldecode($value))) {
                $decodedFiles[] = urldecode($value);
            }
        }

        return $decodedFiles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editAttachments()

ilMailFormGUI::editAttachments

(

)

Definition at line 397 of file class.ilMailFormGUI.php.

References ILIAS\Repository\ctrl(), getBodyParam(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), and ILIAS\Repository\user().

                                     : void
    {
        $files = $this->getBodyParam(
            'attachments',
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->custom()->transformation(function ($elm): string {
                    $attachment = $this->refinery->kindlyTo()->string()->transform($elm);

                    return urldecode($attachment);
                })
            ),
            []
        );

        // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
        $this->umail->persistToStage(
            $this->user->getId(),
            $files,
            ilUtil::securePlainString($this->getBodyParam('rcp_to', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_cc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_bcc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('m_subject', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '')),
            $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );

        $this->ctrl->redirectByClass(ilMailAttachmentGUI::class);
    }

Here is the call graph for this function:

executeCommand()

ilMailFormGUI::executeCommand

(

)

Definition at line 119 of file class.ilMailFormGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $forward_class = $this->ctrl->getNextClass($this);
        switch (strtolower($forward_class)) {
            case strtolower(ilMailAttachmentGUI::class):
                $this->ctrl->setReturn($this, 'returnFromAttachments');
                $this->ctrl->forwardCommand(new ilMailAttachmentGUI());
                break;

            case strtolower(ilMailSearchGUI::class):
                $this->ctrl->setReturn($this, 'searchResults');
                $this->ctrl->forwardCommand(new ilMailSearchGUI());
                break;

            case strtolower(ilMailSearchCoursesGUI::class):
                $this->ctrl->setReturn($this, 'searchResults');
                $this->ctrl->forwardCommand(new ilMailSearchCoursesGUI());
                break;

            case strtolower(ilMailingListsGUI::class):
                $this->ctrl->setReturn($this, 'searchResults');
                $this->ctrl->forwardCommand(new ilMailingListsGUI());
                break;

            case strtolower(ilMailSearchGroupsGUI::class):
                $this->ctrl->setReturn($this, 'searchResults');
                $this->ctrl->forwardCommand(new ilMailSearchGroupsGUI());
                break;

            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = 'showForm';
                }

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

Here is the call graph for this function:

getBodyParam()

ilMailFormGUI::getBodyParam ( string  $name, Transformation  $trafo,   $default = null  )

private

Definition at line 107 of file class.ilMailFormGUI.php.

References ILIAS\FileDelivery\http().

Referenced by __construct(), editAttachments(), lookupRecipientAsync(), saveDraft(), saveMailBeforeSearch(), search(), searchUsers(), and sendMessage().

    {
        if ($this->http->wrapper()->post()->has($name)) {
            return $this->http->wrapper()->post()->retrieve(
                $name,
                $trafo
            );
        }

        return $default;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQueryParam()

ilMailFormGUI::getQueryParam ( string  $name, Transformation  $trafo,   $default = null  )

private

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

References ILIAS\FileDelivery\http().

Referenced by __construct(), lookupRecipientAsync(), and showForm().

    {
        if ($this->http->wrapper()->query()->has($name)) {
            return $this->http->wrapper()->query()->retrieve(
                $name,
                $trafo
            );
        }

        return $default;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateDataById()

ilMailFormGUI::getTemplateDataById ( )

protected

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

References $context, Vendor\Package\$e, ilMailTemplateContextService\getTemplateContextById(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                            : void
    {
        if (!$this->http->wrapper()->query()->has('template_id')) {
            $this->http->close();
        }

        try {
            $template = $this->templateService->loadTemplateForId(
                $this->http->wrapper()->query()->retrieve('template_id', $this->refinery->kindlyTo()->int())
            );
            $context = ilMailTemplateContextService::getTemplateContextById($template->getContext());

            $this->http->saveResponse(
                $this->http->response()
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                    ->withBody(Streams::ofString(json_encode([
                        'm_subject' => $template->getSubject(),
                        'm_message' => $this->umail->appendSignature($template->getMessage()),
                    ], JSON_THROW_ON_ERROR)))
            );
        } catch (Exception $e) {
        }

        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

lookupRecipientAsync()

ilMailFormGUI::lookupRecipientAsync

(

)

Definition at line 871 of file class.ilMailFormGUI.php.

References getBodyParam(), getQueryParam(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilUtil\stripSlashes(), and ilStr\strLen().

                                          : void
    {
        $search = trim($this->getBodyParam(
            'term',
            $this->refinery->kindlyTo()->string(),
            $this->getQueryParam(
                'term',
                $this->refinery->kindlyTo()->string(),
                ''
            )
        ));

        $result = [];

        if (ilStr::strLen($search) < 3) {
            $this->http->saveResponse(
                $this->http->response()
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                    ->withBody(Streams::ofString(json_encode($result, JSON_THROW_ON_ERROR)))
            );

            $this->http->sendResponse();
            $this->http->close();
        }

        // #14768
        $quoted = ilUtil::stripSlashes($search);
        $quoted = str_replace(['%', '_'], ['\%', '\_'], $quoted);

        $mailFormObj = new ilMailForm();
        $result = $mailFormObj->getRecipientAsync("%" . $quoted . "%", ilUtil::stripSlashes($search));

        $this->http->saveResponse(
            $this->http->response()
                ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                ->withBody(Streams::ofString(json_encode($result, JSON_THROW_ON_ERROR)))
        );
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

mailAttachment()

ilMailFormGUI::mailAttachment

(

)

Definition at line 458 of file class.ilMailFormGUI.php.

References showForm().

                                    : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_ATTACH;
        $this->showForm();
    }

Here is the call graph for this function:

mailRole()

ilMailFormGUI::mailRole

(

)

Definition at line 446 of file class.ilMailFormGUI.php.

References showForm().

                              : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_ROLE;
        $this->showForm();
    }

Here is the call graph for this function:

mailUser()

ilMailFormGUI::mailUser

(

)

Definition at line 440 of file class.ilMailFormGUI.php.

References showForm().

                              : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_NEW;
        $this->showForm();
    }

Here is the call graph for this function:

replyMail()

ilMailFormGUI::replyMail

(

)

Definition at line 452 of file class.ilMailFormGUI.php.

References showForm().

                               : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_REPLY;
        $this->showForm();
    }

Here is the call graph for this function:

returnFromAttachments()

ilMailFormGUI::returnFromAttachments

(

)

Definition at line 428 of file class.ilMailFormGUI.php.

References showForm().

                                           : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_ATTACH;
        $this->showForm();
    }

Here is the call graph for this function:

saveDraft()

ilMailFormGUI::saveDraft

(

)

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

References $errors, ilSession\clear(), ILIAS\Repository\ctrl(), decodeAttachmentFiles(), ilSession\get(), getBodyParam(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ILIAS\Repository\int(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ilUtil\redirect(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), showForm(), and showSubmissionErrors().

                               : void
    {
        $draftFolderId = $this->mbox->getDraftsFolder();

        $files = $this->decodeAttachmentFiles($this->getBodyParam(
            'attachments',
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->custom()->transformation($this->refinery->kindlyTo()->string())
            ),
            []
        ));

        $rcp_to = ilUtil::securePlainString($this->getBodyParam('rcp_to', $this->refinery->kindlyTo()->string(), ''));
        $rcp_cc = ilUtil::securePlainString($this->getBodyParam('rcp_cc', $this->refinery->kindlyTo()->string(), ''));
        $rcp_bcc = ilUtil::securePlainString($this->getBodyParam('rcp_bcc', $this->refinery->kindlyTo()->string(), ''));

        if ($errors = $this->umail->validateRecipients(
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
        )) {
            $this->requestAttachments = $files;
            $this->showSubmissionErrors($errors);
            $this->showForm();
            return;
        }

        if (ilSession::get('draft')) {
            $draftId = (int) ilSession::get('draft');
            ilSession::clear('draft');
        } else {
            $draftId = $this->umail->getNewDraftId($draftFolderId);
        }

        $this->umail->updateDraft(
            $draftFolderId,
            $files,
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
            ilUtil::securePlainString(
                $this->getBodyParam('m_subject', $this->refinery->kindlyTo()->string(), '')
            ) ?: 'No Subject',
            ilUtil::securePlainString($this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '')),
            $draftId,
            $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );

        $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_saved'), true);

        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        } else {
            $this->ctrl->redirectByClass([ilMailGUI::class, ilMailFolderGUI::class]);
        }

        $this->showForm();
    }

Here is the call graph for this function:

saveMailBeforeSearch()

ilMailFormGUI::saveMailBeforeSearch ( )

protected

Definition at line 921 of file class.ilMailFormGUI.php.

References getBodyParam(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), and ILIAS\Repository\user().

Referenced by searchCoursesTo(), searchGroupsTo(), and searchMailingListsTo().

                                             : void
    {
        $files = $this->getBodyParam(
            'attachments',
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->custom()->transformation(function ($elm): string {
                    $attachment = $this->refinery->kindlyTo()->string()->transform($elm);

                    return urldecode($attachment);
                })
            ),
            []
        );

        $this->umail->persistToStage(
            $this->user->getId(),
            $files,
            ilUtil::securePlainString($this->getBodyParam('rcp_to', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_cc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_bcc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('m_subject', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '')),
            $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

search()

ilMailFormGUI::search

(

)

Definition at line 367 of file class.ilMailFormGUI.php.

References ILIAS\Repository\ctrl(), ilSession\get(), getBodyParam(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), searchUsers(), ilUtil\securePlainString(), and ilSession\set().

                            : void
    {
        ilSession::set(
            'mail_search_search',
            ilUtil::securePlainString($this->getBodyParam('search', $this->refinery->kindlyTo()->string(), ''))
        );

        if (trim(ilSession::get('mail_search_search')) === '') {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("mail_insert_query"));
            $this->searchUsers(false);
        } elseif (strlen(trim(ilSession::get('mail_search_search'))) < 3) {
            $this->lng->loadLanguageModule('search');
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('search_minimum_three'));
            $this->searchUsers(false);
        } else {
            $this->ctrl->setParameterByClass(
                ilMailSearchGUI::class,
                'search',
                urlencode(ilSession::get('mail_search_search'))
            );
            $this->ctrl->redirectByClass(ilMailSearchGUI::class);
        }
    }

Here is the call graph for this function:

searchCoursesTo()

ilMailFormGUI::searchCoursesTo

(

)

Definition at line 347 of file class.ilMailFormGUI.php.

References ILIAS\Repository\ctrl(), ilSession\get(), and saveMailBeforeSearch().

                                     : void
    {
        $this->saveMailBeforeSearch();

        if (ilSession::get('search_crs')) {
            $this->ctrl->setParameterByClass('ilmailsearchcoursesgui', 'cmd', 'showMembers');
        }

        $this->ctrl->setParameterByClass(ilMailSearchCoursesGUI::class, 'ref', 'mail');
        $this->ctrl->redirectByClass(ilMailSearchCoursesGUI::class);
    }

Here is the call graph for this function:

searchGroupsTo()

ilMailFormGUI::searchGroupsTo

(

)

Definition at line 359 of file class.ilMailFormGUI.php.

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

                                    : void
    {
        $this->saveMailBeforeSearch();

        $this->ctrl->setParameterByClass(ilMailSearchGroupsGUI::class, 'ref', 'mail');
        $this->ctrl->redirectByClass(ilMailSearchGroupsGUI::class);
    }

Here is the call graph for this function:

searchMailingListsTo()

ilMailFormGUI::searchMailingListsTo

(

)

Definition at line 949 of file class.ilMailFormGUI.php.

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

                                          : void
    {
        $this->saveMailBeforeSearch();

        $this->ctrl->setParameterByClass(ilMailingListsGUI::class, 'ref', 'mail');
        $this->ctrl->redirectByClass(ilMailingListsGUI::class);
    }

Here is the call graph for this function:

searchResults()

ilMailFormGUI::searchResults

(

)

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

References showForm().

Referenced by cancelSearch().

                                   : void
    {
        $this->mail_form_type = self::MAIL_FORM_TYPE_SEARCH_RESULT;
        $this->showForm();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

searchUsers()

ilMailFormGUI::searchUsers

(

bool

$save = true

)

Definition at line 292 of file class.ilMailFormGUI.php.

References ILIAS\Repository\ctrl(), ilSession\get(), getBodyParam(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), and ILIAS\Repository\user().

Referenced by search().

                                                  : void
    {
        $this->tpl->setTitle($this->lng->txt('mail'));

        if ($save) {
            $files = $this->getBodyParam(
                'attachments',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->custom()->transformation(function ($elm): string {
                        $attachment = $this->refinery->kindlyTo()->string()->transform($elm);

                        return urldecode($attachment);
                    })
                ),
                []
            );

            // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
            $this->umail->persistToStage(
                $this->user->getId(),
                $files,
                ilUtil::securePlainString($this->getBodyParam('rcp_to', $this->refinery->kindlyTo()->string(), '')),
                ilUtil::securePlainString($this->getBodyParam('rcp_cc', $this->refinery->kindlyTo()->string(), '')),
                ilUtil::securePlainString($this->getBodyParam('rcp_bcc', $this->refinery->kindlyTo()->string(), '')),
                ilUtil::securePlainString($this->getBodyParam('m_subject', $this->refinery->kindlyTo()->string(), '')),
                ilUtil::securePlainString($this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '')),
                $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false),
                ilMailFormCall::getContextId(),
                ilMailFormCall::getContextParameters()
            );
        }

        $form = new ilPropertyFormGUI();
        $form->setId('search_rcp');
        $form->setTitle($this->lng->txt('search_recipients'));
        $form->setFormAction($this->ctrl->getFormAction($this, 'search'));

        $inp = new ilTextInputGUI($this->lng->txt('search_for'), 'search');
        $inp->setSize(30);
        $dsDataLink = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true);
        $inp->setDataSource($dsDataLink);

        $searchQuery = trim((string) ilSession::get('mail_search_search'));
        if ($searchQuery !== '') {
            $inp->setValue(ilLegacyFormElementsUtil::prepareFormOutput($searchQuery, true));
        }
        $form->addItem($inp);

        $form->addCommandButton('search', $this->lng->txt('search'));
        $form->addCommandButton('cancelSearch', $this->lng->txt('cancel'));

        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMessage()

ilMailFormGUI::sendMessage

(

)

Definition at line 175 of file class.ilMailFormGUI.php.

References $errors, $message, ILIAS\Repository\ctrl(), decodeAttachmentFiles(), getBodyParam(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), showForm(), showSubmissionErrors(), and ILIAS\Repository\user().

                                 : void
    {
        $message = $this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '');

        $mailBody = new ilMailBody($message, $this->purifier);

        $sanitizedMessage = $mailBody->getContent();

        $attachments = $this->getBodyParam(
            'attachments',
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
            []
        );
        $files = $this->decodeAttachmentFiles($attachments);

        $mailer = $this->umail
            ->withContextId(ilMailFormCall::getContextId() ?: '')
            ->withContextParameters(ilMailFormCall::getContextParameters());

        $mailer->setSaveInSentbox(true);

        if ($errors = $mailer->enqueue(
            ilUtil::securePlainString($this->getBodyParam('rcp_to', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_cc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('rcp_bcc', $this->refinery->kindlyTo()->string(), '')),
            ilUtil::securePlainString($this->getBodyParam('m_subject', $this->refinery->kindlyTo()->string(), '')),
            $sanitizedMessage,
            $files,
            $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false)
        )) {
            $this->requestAttachments = $files;
            $this->showSubmissionErrors($errors);
        } else {
            $mailer->persistToStage(
                $this->user->getId(),
                [],
                '',
                '',
                '',
                '',
                ''
            );

            $this->ctrl->setParameterByClass(ilMailGUI::class, 'type', 'message_sent');

            if (ilMailFormCall::isRefererStored()) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_message_send'), true);
                $this->ctrl->redirectToURL(ilMailFormCall::getRefererRedirectUrl());
            } else {
                $this->ctrl->redirectByClass(ilMailGUI::class);
            }
        }

        $this->showForm();
    }

Here is the call graph for this function:

showForm()

ilMailFormGUI::showForm

(

)

Definition at line 491 of file class.ilMailFormGUI.php.

References $context, $data, Vendor\Package\$e, ILIAS\LTI\ToolProvider\$key, $mail_form_type, $requestAttachments, $type, ilButton\BUTTON_TYPE_SUBMIT, ilSession\clear(), ILIAS\Repository\ctrl(), ilUtil\formatSize(), ilSession\get(), ilMailFormCall\getContextId(), ilButton\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilLoggerFactory\getLogger(), getQueryParam(), ilMailFormCall\getSignature(), ilMailTemplateContextService\getTemplateContextById(), ilFormPropertyGUI\getTitle(), ILIAS\FileDelivery\http(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilUtil\securePlainString(), ilSession\set(), ilMailFormCall\setContextId(), ilMailFormCall\setContextParameters(), ilManualPlaceholderInputGUI\setInstructionText(), ilCheckboxInputGUI\setValue(), ilTextAreaInputGUI\setValue(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by cancelMail(), mailAttachment(), mailRole(), mailUser(), replyMail(), returnFromAttachments(), saveDraft(), searchResults(), and sendMessage().

                              : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.mail_new.html',
            'Services/Mail'
        );
        $this->tpl->setTitle($this->lng->txt('mail'));

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

        if (ilMailFormCall::isRefererStored()) {
            $this->tabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this, 'cancelMail')
            );
        }

        $mailData = [];
        $mailData['rcp_to'] = '';
        $mailData['rcp_cc'] = '';
        $mailData['rcp_bcc'] = '';
        $mailData['attachments'] = [];

        $mailId = $this->getQueryParam('mail_id', $this->refinery->kindlyTo()->int(), 0);
        $type = $this->getQueryParam('type', $this->refinery->kindlyTo()->string(), '');
        if ($this->mail_form_type !== '') {
            $type = $this->mail_form_type;
        }

        switch ($type) {
            case self::MAIL_FORM_TYPE_REPLY:
                $mailData = $this->umail->getMail($mailId);

                $mailData['m_subject'] = $this->umail->formatReplySubject($mailData['m_subject'] ?? '');
                $mailData['m_message'] = $this->umail->prependSignature(
                    $this->umail->formatReplyMessage($mailData['m_message'] ?? '')
                );
                $mailData['attachments'] = [];
                $mailData['rcp_cc'] = '';
                $mailData['rcp_to'] = $this->umail->formatReplyRecipient();
                break;

            case self::MAIL_FORM_TYPE_SEARCH_RESULT:
                $mailData = $this->umail->retrieveFromStage();

                if (ilSession::get('mail_search_results_to')) {
                    $mailData = $this->umail->appendSearchResult(
                        $this->refinery->kindlyTo()->listOf(
                            $this->refinery->kindlyTo()->string()
                        )->transform(ilSession::get('mail_search_results_to')),
                        'to'
                    );
                }
                if (ilSession::get('mail_search_results_cc')) {
                    $mailData = $this->umail->appendSearchResult(
                        $this->refinery->kindlyTo()->listOf(
                            $this->refinery->kindlyTo()->string()
                        )->transform(ilSession::get('mail_search_results_cc')),
                        'cc'
                    );
                }
                if (ilSession::get('mail_search_results_bcc')) {
                    $mailData = $this->umail->appendSearchResult(
                        $this->refinery->kindlyTo()->listOf(
                            $this->refinery->kindlyTo()->string()
                        )->transform(ilSession::get('mail_search_results_bcc')),
                        'bc'
                    );
                }

                ilSession::clear('mail_search_results_to');
                ilSession::clear('mail_search_results_cc');
                ilSession::clear('mail_search_results_bcc');
                break;

            case self::MAIL_FORM_TYPE_ATTACH:
                $mailData = $this->umail->retrieveFromStage();
                break;

            case self::MAIL_FORM_TYPE_DRAFT:
                ilSession::set('draft', $mailId);
                $mailData = $this->umail->getMail($mailId);
                ilMailFormCall::setContextId($mailData['tpl_ctx_id']);
                ilMailFormCall::setContextParameters($mailData['tpl_ctx_params']);
                break;

            case self::MAIL_FORM_TYPE_FORWARD:
                $mailData = $this->umail->getMail($mailId);
                $mailData['rcp_to'] = $mailData['rcp_cc'] = $mailData['rcp_bcc'] = '';
                $mailData['m_subject'] = $this->umail->formatForwardSubject($mailData['m_subject'] ?? '');
                $mailData['m_message'] = $this->umail->prependSignature($mailData['m_message'] ?? '');
                if (is_array($mailData['attachments']) && count($mailData['attachments']) && $error = $this->mfile->adoptAttachments(
                    $mailData['attachments'],
                    $mailId
                )) {
                    $this->tpl->setOnScreenMessage('info', $error);
                }
                break;

            case self::MAIL_FORM_TYPE_NEW:
                // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                $to = ilUtil::securePlainString($this->getQueryParam('rcp_to', $this->refinery->kindlyTo()->string(), ''));
                if ($to === '' && ilSession::get('rcp_to')) {
                    $to = ilSession::get('rcp_to');
                }
                $mailData['rcp_to'] = $to;

                $cc = ilUtil::securePlainString($this->getQueryParam('rcp_cc', $this->refinery->kindlyTo()->string(), ''));
                if ($cc === '' && ilSession::get('rcp_cc')) {
                    $cc = ilSession::get('rcp_cc');
                }
                $mailData['rcp_cc'] = $cc;

                $bcc = ilUtil::securePlainString($this->getQueryParam('rcp_bcc', $this->refinery->kindlyTo()->string(), ''));
                if ($bcc === '' && ilSession::get('rcp_bcc')) {
                    $bcc = ilSession::get('rcp_bcc');
                }
                $mailData['rcp_bcc'] = $bcc;

                $mailData['m_message'] = '';
                if (($sig = ilMailFormCall::getSignature()) !== '') {
                    $mailData['m_message'] = $sig;
                    $mailData['m_message'] .= chr(13)
                        . chr(10)
                        . chr(13)
                        . chr(10);
                }
                $mailData['m_message'] .= $this->umail->appendSignature('');

                ilSession::set('rcp_to', '');
                ilSession::set('rcp_cc', '');
                ilSession::set('rcp_bcc', '');
                break;

            case self::MAIL_FORM_TYPE_ROLE:
                $roles = [];
                if ($this->http->wrapper()->post()->has('roles')) {
                    $roles = $this->http->wrapper()->post()->retrieve(
                        'roles',
                        $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
                    );
                } elseif (is_array(ilSession::get('mail_roles'))) {
                    $roles = $this->refinery->kindlyTo()->listOf(
                        $this->refinery->kindlyTo()->string()
                    )->transform(ilSession::get('mail_roles'));
                }

                // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                $mailData['rcp_to'] = ilUtil::securePlainString(
                    implode(',', $roles)
                );

                $mailData['m_message'] = '';
                if (($sig = ilMailFormCall::getSignature()) !== '') {
                    $mailData['m_message'] = $sig;
                    $mailData['m_message'] .= chr(13)
                        . chr(10)
                        . chr(13)
                        . chr(10);
                }

                $additionalMessageText = '';
                if ($this->http->wrapper()->post()->has('additional_message_text')) {
                    $additionalMessageText = ilUtil::securePlainString($this->http->wrapper()->post()->retrieve(
                        'additional_message_text',
                        $this->refinery->kindlyTo()->string()
                    ));
                }

                $mailData['m_message'] .= $additionalMessageText
                    . chr(13)
                    . chr(10)
                    . $this->umail->appendSignature('');
                ilSession::set('mail_roles', []);
                break;

            case self::MAIL_FORM_TYPE_ADDRESS:
                $rcp = '';
                if ($this->http->wrapper()->query()->has('rcp')) {
                    $rcp = $this->http->wrapper()->query()->retrieve('rcp', $this->refinery->kindlyTo()->string());
                }
                $mailData['rcp_to'] = urldecode($rcp);
                break;

            default:
                $mailData = $this->http->request()->getParsedBody();
                foreach ($mailData as $key => $value) {
                    if (is_string($value)) {
                        // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                        $mailData[$key] = ilUtil::securePlainString($value);
                    }
                }

                if ($this->requestAttachments) {
                    $mailData['attachments'] = $this->requestAttachments;
                }
                break;
        }

        $form_gui = new ilPropertyFormGUI();
        $form_gui->setTitle($this->lng->txt('compose'));
        $form_gui->setId('mail_compose_form');
        $form_gui->setName('mail_compose_form');
        $form_gui->setFormAction($this->ctrl->getFormAction($this, 'sendMessage'));

        $this->tpl->setVariable('FORM_ID', $form_gui->getId());

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT);
        $btn->setForm('form_' . $form_gui->getName())
            ->setName('searchUsers')
            ->setCaption('search_recipients');
        $this->toolbar->addStickyItem($btn);

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
            ->setName('searchCoursesTo')
            ->setForm('form_' . $form_gui->getName())
            ->setCaption('mail_my_courses');
        $this->toolbar->addButtonInstance($btn);

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
            ->setName('searchGroupsTo')
            ->setForm('form_' . $form_gui->getName())
            ->setCaption('mail_my_groups');
        $this->toolbar->addButtonInstance($btn);

        if (count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0) {
            $btn = ilButton::getInstance();
            $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
                ->setName('searchMailingListsTo')
                ->setForm('form_' . $form_gui->getName())
                ->setCaption('mail_my_mailing_lists');
            $this->toolbar->addButtonInstance($btn);
        }

        $dsDataLink = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true);

        $inp = new ilTextInputGUI($this->lng->txt('mail_to'), 'rcp_to');
        $inp->setMaxLength(null);
        $inp->setRequired(true);
        $inp->setSize(50);
        $inp->setValue((string) ($mailData['rcp_to'] ?? ''));
        $inp->setDataSource($dsDataLink, ',');
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('mail_cc'), 'rcp_cc');
        $inp->setMaxLength(null);
        $inp->setSize(50);
        $inp->setValue((string) ($mailData['rcp_cc'] ?? ''));
        $inp->setDataSource($dsDataLink, ',');
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('mail_bcc'), 'rcp_bcc');
        $inp->setMaxLength(null);
        $inp->setSize(50);
        $inp->setValue($mailData['rcp_bcc'] ?? '');
        $inp->setDataSource($dsDataLink, ',');
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('subject'), 'm_subject');
        $inp->setSize(50);
        $inp->setRequired(true);
        $inp->setValue((string) ($mailData['m_subject'] ?? ''));
        $form_gui->addItem($inp);

        $att = new ilMailFormAttachmentPropertyGUI(
            $this->lng->txt(
                isset($mailData['attachments']) && is_array($mailData['attachments']) ?
                'edit' :
                'add'
            )
        );
        if (isset($mailData['attachments']) && is_array($mailData['attachments'])) {
            foreach ($mailData['attachments'] as $data) {
                if (is_file($this->mfile->getMailPath() . '/' . $this->user->getId() . '_' . $data)) {
                    $hidden = new ilHiddenInputGUI('attachments[]');
                    $form_gui->addItem($hidden);
                    $size = filesize($this->mfile->getMailPath() . '/' . $this->user->getId() . '_' . $data);
                    $label = $data . ' [' . ilUtil::formatSize($size) . ']';
                    $att->addItem($label);
                    $hidden->setValue(urlencode($data));
                }
            }
        }
        $form_gui->addItem($att);

        $context = new ilMailTemplateGenericContext();
        if (ilMailFormCall::getContextId()) {
            $context_id = ilMailFormCall::getContextId();

            $mailData['use_placeholders'] = true;

            try {
                $context = ilMailTemplateContextService::getTemplateContextById($context_id);

                $templates = $this->templateService->loadTemplatesForContextId($context->getId());
                if (count($templates) > 0) {
                    $options = [];

                    $template_chb = new ilMailTemplateSelectInputGUI(
                        $this->lng->txt('mail_template_client'),
                        'template_id',
                        $this->ctrl->getLinkTarget($this, 'getTemplateDataById', '', true),
                        ['m_subject' => false, 'm_message' => true]
                    );

                    foreach ($templates as $template) {
                        $options[$template->getTplId()] = $template->getTitle();

                        if (!isset($mailData['template_id']) && $template->isDefault()) {
                            $template_chb->setValue((string) $template->getTplId());
                            $form_gui->getItemByPostVar('m_subject')->setValue($template->getSubject());
                            $mailData['m_message'] = $template->getMessage() . $this->umail->appendSignature(
                                $mailData['m_message']
                            );
                        }
                    }
                    if (isset($mailData['template_id'])) {
                        $template_chb->setValue((string) ((int) $mailData['template_id']));
                    }
                    asort($options);

                    $template_chb->setInfo($this->lng->txt('mail_template_client_info'));
                    $template_chb->setOptions(['' => $this->lng->txt('please_choose')] + $options);
                    $form_gui->addItem($template_chb);
                }
            } catch (Exception $e) {
                ilLoggerFactory::getLogger('mail')->error(sprintf(
                    '%s has been called with invalid context id: %s.',
                    __METHOD__,
                    $context_id
                ));
            }
        }

        $inp = new ilTextAreaInputGUI($this->lng->txt('message_content'), 'm_message');
        $inp->setValue((string) ($mailData['m_message'] ?? ''));
        $inp->setRequired(false);
        $inp->setCols(60);
        $inp->setRows(10);
        $form_gui->addItem($inp);

        $chb = new ilCheckboxInputGUI(
            $this->lng->txt('mail_serial_letter_placeholders'),
            'use_placeholders'
        );
        $chb->setValue('1');
        $chb->setChecked(isset($mailData['use_placeholders']) && $mailData['use_placeholders']);

        $placeholders = new ilManualPlaceholderInputGUI($this->lng->txt('mail_form_placeholders_label'), 'm_message');
        $placeholders->setInstructionText($this->lng->txt('mail_nacc_use_placeholder'));
        try {
            $placeholders->setAdviseText(sprintf($this->lng->txt('placeholders_advise'), '<br />'));
        } catch (Throwable $e) {
            $placeholders->setAdviseText($this->lng->txt('placeholders_advise'));
        }
        foreach ($context->getPlaceholders() as $key => $value) {
            $placeholders->addPlaceholder($value['placeholder'], $value['label']);
        }
        $chb->addSubItem($placeholders);
        $form_gui->addItem($chb);

        $form_gui->addCommandButton('sendMessage', $this->lng->txt('send_mail'));
        $form_gui->addCommandButton('saveDraft', $this->lng->txt('save_message'));
        if (ilMailFormCall::isRefererStored()) {
            $form_gui->addCommandButton('cancelMail', $this->lng->txt('cancel'));
        }

        $this->tpl->parseCurrentBlock();

        $this->tpl->setVariable('FORM', $form_gui->getHTML());

        $this->tpl->addJavaScript('Services/Mail/js/ilMailComposeFunctions.js');
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSubmissionErrors()

ilMailFormGUI::showSubmissionErrors ( array  $errors )

protected

Parameters

ilMailError[]

$errors

Definition at line 960 of file class.ilMailFormGUI.php.

References ILIAS\Repository\lng().

Referenced by saveDraft(), and sendMessage().

                                                          : void
    {
        $formatter = new ilMailErrorFormatter($this->lng);
        $formattedErrors = $formatter->format($errors);

        if ($formattedErrors !== '') {
            $this->tpl->setOnScreenMessage('failure', $formattedErrors);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilMailFormGUI::$ctrl

private

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

$http

GlobalHttpState ilMailFormGUI::$http

private

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

$lng

ilLanguage ilMailFormGUI::$lng

private

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

$mail_form_type

string ilMailFormGUI::$mail_form_type = ''

private

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

Referenced by showForm().

$mbox

ilMailbox ilMailFormGUI::$mbox

private

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

$mfile

ilFileDataMail ilMailFormGUI::$mfile

private

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

$purifier

ilMailBodyPurifier ilMailFormGUI::$purifier

private

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

$refinery

Refinery ilMailFormGUI::$refinery

private

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

$requestAttachments

array ilMailFormGUI::$requestAttachments = null

private

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

Referenced by showForm().

$tabs

ilTabsGUI ilMailFormGUI::$tabs

private

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

$templateService

ilMailTemplateService ilMailFormGUI::$templateService

protected

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

$toolbar

ilToolbarGUI ilMailFormGUI::$toolbar

private

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

$tpl

ilGlobalTemplateInterface ilMailFormGUI::$tpl

private

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

$umail

ilFormatMail ilMailFormGUI::$umail

private

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

$user

ilObjUser ilMailFormGUI::$user

private

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

MAIL_FORM_TYPE_ADDRESS

const ilMailFormGUI::MAIL_FORM_TYPE_ADDRESS = 'address'

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

MAIL_FORM_TYPE_ATTACH

const ilMailFormGUI::MAIL_FORM_TYPE_ATTACH = 'attach'

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

Referenced by ilMailAttachmentGUI\cancelSaveAttachments(), and ilMailGUI\executeCommand().

MAIL_FORM_TYPE_DRAFT

const ilMailFormGUI::MAIL_FORM_TYPE_DRAFT = 'draft'

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

Referenced by ilMailFolderTableGUI\addViewRowAction(), and ilMailFolderTableGUI\fetchTableData().

MAIL_FORM_TYPE_FORWARD

const ilMailFormGUI::MAIL_FORM_TYPE_FORWARD = 'forward'

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

Referenced by ilMailFolderTableGUI\addForwardRowAction(), and ilMailFolderGUI\confirmDeleteMails().

MAIL_FORM_TYPE_NEW

const ilMailFormGUI::MAIL_FORM_TYPE_NEW = 'new'

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

Referenced by ilMailGUI\executeCommand(), ilMailMemberSearchGUI\sendMailToSelectedUsers(), and ilMailGUI\showHeader().

MAIL_FORM_TYPE_REPLY

const ilMailFormGUI::MAIL_FORM_TYPE_REPLY = 'reply'

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

Referenced by ilMailFolderTableGUI\addReplyRowAction(), ilMailFolderGUI\confirmDeleteMails(), and ilMailGUI\executeCommand().

MAIL_FORM_TYPE_ROLE

const ilMailFormGUI::MAIL_FORM_TYPE_ROLE = 'role'

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

Referenced by ilMailGUI\executeCommand(), and ilMailMemberSearchGUI\nextMailForm().

MAIL_FORM_TYPE_SEARCH_RESULT

const ilMailFormGUI::MAIL_FORM_TYPE_SEARCH_RESULT = 'search_res'

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

Referenced by ilMailGUI\executeCommand().

---

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

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