@ilCtrl_Calls ilMailFormGUI: ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI More...

Collaboration diagram for ilMailFormGUI:

Public Member Functions
	__construct (?ilMailTemplateService $template_service=null, ?ilMailBodyPurifier $body_purifier=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
final const string	MAIL_FORM_TYPE_ATTACH = 'attach'

final const string	MAIL_FORM_TYPE_SEARCH_RESULT = 'search_res'

final const string	MAIL_FORM_TYPE_NEW = 'new'

final const string	MAIL_FORM_TYPE_ROLE = 'role'

final const string	MAIL_FORM_TYPE_REPLY = 'reply'

final const string	MAIL_FORM_TYPE_ADDRESS = 'address'

final const string	MAIL_FORM_TYPE_FORWARD = 'forward'

final const string	MAIL_FORM_TYPE_DRAFT = 'draft'

Protected Member Functions
	decodeAttachmentFiles (array $files)

	getTemplateDataById ()

	saveMailBeforeSearch ()

	showSubmissionErrors (array $errors)

Protected Attributes
ilMailTemplateService	$template_service

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

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

Private Attributes
readonly ilGlobalTemplateInterface	$tpl

readonly ilCtrlInterface	$ctrl

readonly ilLanguage	$lng

readonly ilObjUser	$user

readonly ilTabsGUI	$tabs

readonly ilToolbarGUI	$toolbar

readonly ilFormatMail	$umail

readonly ilMailbox	$mbox

readonly ilFileDataMail	$mfile

readonly GlobalHttpState	$http

readonly Refinery	$refinery

array	$request_attachments = null

readonly ilMailBodyPurifier	$purifier

string	$mail_form_type = ''

readonly Factory	$ui_factory

Detailed Description

@ilCtrl_Calls ilMailFormGUI: ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilMailFormGUI::__construct	(	?ilMailTemplateService	$template_service = `null`,
		?ilMailBodyPurifier	$body_purifier = `null`
	)

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

      {
        global $DIC;
 
        $this->template_service = $template_service ?? $DIC->mail()->textTemplates();
        $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 = $body_purifier ?? new ilMailBodyPurifier();
        $this->ui_factory = $DIC->ui()->factory();
 
        $mail_obj_id = $this->getBodyParam(
            'mobj_id',
            $this->refinery->kindlyTo()->int(),
            $this->getQueryParam(
                'mobj_id',
                $this->refinery->kindlyTo()->int(),
                0
            )
        );
 
        if ($mail_obj_id === 0) {
            $mail_obj_id = $this->mbox->getInboxFolder();
        }
 
        $this->ctrl->setParameter($this, 'mobj_id', $mail_obj_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ cancelMail()

ilMailFormGUI::cancelMail ( )

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

                                : void
    {
        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        }
 
        $this->showForm();
    }

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

Here is the call graph for this function:

◆ cancelSearch()

ilMailFormGUI::cancelSearch ( )

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

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

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

Here is the call graph for this function:

◆ decodeAttachmentFiles()

ilMailFormGUI::decodeAttachmentFiles ( array $files )

protected

Parameters

list<string> $files

Returns: list<string>

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

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

Referenced by saveDraft(), and sendMessage().

Here is the caller graph for this function:

◆ editAttachments()

ilMailFormGUI::editAttachments ( )

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

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

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

Here is the call graph for this function:

◆ executeCommand()

ilMailFormGUI::executeCommand ( )

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

                                    : void
    {
        $forward_class = $this->ctrl->getNextClass($this) ?? '';
        switch (strtolower($forward_class)) {
            case strtolower(ilMailAttachmentGUI::class):
                $this->ctrl->setReturn($this, 'returnFromAttachments');
                $gui = new ilMailAttachmentGUI();
                $gui->consume();
                $this->ctrl->forwardCommand($gui);
                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;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getBodyParam()

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

private

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

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

References ILIAS\FileDelivery\http().

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

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 97 of file class.ilMailFormGUI.php.

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

References ILIAS\FileDelivery\http().

Referenced by showForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplateDataById()

ilMailFormGUI::getTemplateDataById ( )

protected

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

                                            : void
    {
        if (!$this->http->wrapper()->query()->has('template_id')) {
            $this->http->close();
        }
 
        try {
            $template = $this->template_service->loadTemplateForId(
                $this->http->wrapper()->query()->retrieve('template_id', $this->refinery->kindlyTo()->int())
            );
            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) {
        }
 
        $this->http->sendResponse();
        $this->http->close();
    }

References ilMailTemplateContextService\getTemplateContextById(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ lookupRecipientAsync()

ilMailFormGUI::lookupRecipientAsync ( )

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

                                          : void
    {
        $search = trim((string) $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);
 
        $form = new ilMailForm();
        $result = $form->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();
    }

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

Here is the call graph for this function:

◆ mailAttachment()

ilMailFormGUI::mailAttachment ( )

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

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

References MAIL_FORM_TYPE_ATTACH, and showForm().

Here is the call graph for this function:

◆ mailRole()

ilMailFormGUI::mailRole ( )

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

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

References MAIL_FORM_TYPE_ROLE, and showForm().

Here is the call graph for this function:

◆ mailUser()

ilMailFormGUI::mailUser ( )

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

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

References MAIL_FORM_TYPE_NEW, and showForm().

Here is the call graph for this function:

◆ replyMail()

ilMailFormGUI::replyMail ( )

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

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

References MAIL_FORM_TYPE_REPLY, and showForm().

Here is the call graph for this function:

◆ returnFromAttachments()

ilMailFormGUI::returnFromAttachments ( )

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

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

References MAIL_FORM_TYPE_ATTACH, and showForm().

Here is the call graph for this function:

◆ saveDraft()

ilMailFormGUI::saveDraft ( )

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

                               : void
    {
        $draft_folder_id = $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->request_attachments = $files;
            $this->showSubmissionErrors($errors);
            $this->showForm();
            return;
        }
 
        if (ilSession::get('draft')) {
            $draft_id = (int) ilSession::get('draft');
            ilSession::clear('draft');
        } else {
            $draft_id = $this->umail->getNewDraftId($draft_folder_id);
        }
 
        $this->umail->updateDraft(
            $draft_folder_id,
            $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(), '')),
            $draft_id,
            $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();
    }

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

Here is the call graph for this function:

◆ saveMailBeforeSearch()

ilMailFormGUI::saveMailBeforeSearch ( )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search()

ilMailFormGUI::search ( )

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

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

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

Here is the call graph for this function:

◆ searchCoursesTo()

ilMailFormGUI::searchCoursesTo ( )

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

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

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

Here is the call graph for this function:

◆ searchGroupsTo()

ilMailFormGUI::searchGroupsTo ( )

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

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

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

Here is the call graph for this function:

◆ searchMailingListsTo()

ilMailFormGUI::searchMailingListsTo ( )

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

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

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

Here is the call graph for this function:

◆ searchResults()

ilMailFormGUI::searchResults ( )

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

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

References MAIL_FORM_TYPE_SEARCH_RESULT, and showForm().

Referenced by cancelSearch().

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 300 of file class.ilMailFormGUI.php.

                                                  : 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);
        $data_source_url = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true);
        $inp->setDataSource($data_source_url);
 
        $search_query = trim((string) ilSession::get('mail_search_search'));
        if ($search_query !== '') {
            $inp->setValue(ilLegacyFormElementsUtil::prepareFormOutput($search_query, 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();
    }

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

Referenced by search().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMessage()

ilMailFormGUI::sendMessage ( )

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

                                 : void
    {
        $message = $this->getBodyParam('m_message', $this->refinery->kindlyTo()->string(), '');
 
        $mail_body = new ilMailBody($message, $this->purifier);
 
        $sanitized_message = $mail_body->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);
 
        $mailer->autoresponder()->enableAutoresponder();
 
        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(), '')),
            $sanitized_message,
            $files,
            $this->getBodyParam('use_placeholders', $this->refinery->kindlyTo()->bool(), false)
        )) {
            $this->request_attachments = $files;
            $this->showSubmissionErrors($errors);
        } else {
            $mailer->autoresponder()->disableAutoresponder();
 
            $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);
            }
        }
        $mailer->autoresponder()->disableAutoresponder();
 
        $this->showForm();
    }

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

Here is the call graph for this function:

◆ showForm()

ilMailFormGUI::showForm ( )

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

                              : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.mail_new.html',
            'components/ILIAS/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')
            );
        }
 
        $mail_data = [];
        $mail_data['rcp_to'] = '';
        $mail_data['rcp_cc'] = '';
        $mail_data['rcp_bcc'] = '';
        $mail_data['attachments'] = [];
 
        $mail_id = $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:
                $mail_data = $this->umail->getMail($mail_id);
 
                $mail_data['m_subject'] = $this->umail->formatReplySubject($mail_data['m_subject'] ?? '');
                $mail_data['m_message'] = $this->umail->prependSignature(
                    $this->umail->formatReplyMessage($mail_data['m_message'] ?? '')
                );
                $mail_data['attachments'] = [];
                $mail_data['rcp_cc'] = '';
                $mail_data['rcp_to'] = $this->umail->formatReplyRecipient();
                break;
 
            case self::MAIL_FORM_TYPE_SEARCH_RESULT:
                $mail_data = $this->umail->retrieveFromStage();
 
                if (ilSession::get('mail_search_results_to')) {
                    $mail_data = $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')) {
                    $mail_data = $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')) {
                    $mail_data = $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:
                $mail_data = $this->umail->retrieveFromStage();
                break;
 
            case self::MAIL_FORM_TYPE_DRAFT:
                ilSession::set('draft', $mail_id);
                $mail_data = $this->umail->getMail($mail_id);
                ilMailFormCall::setContextId($mail_data['tpl_ctx_id']);
                ilMailFormCall::setContextParameters($mail_data['tpl_ctx_params']);
                break;
 
            case self::MAIL_FORM_TYPE_FORWARD:
                $mail_data = $this->umail->getMail($mail_id);
                $mail_data['rcp_to'] = $mail_data['rcp_cc'] = $mail_data['rcp_bcc'] = '';
                $mail_data['m_subject'] = $this->umail->formatForwardSubject($mail_data['m_subject'] ?? '');
                $mail_data['m_message'] = $this->umail->prependSignature($mail_data['m_message'] ?? '');
                if (is_array($mail_data['attachments']) && count($mail_data['attachments']) && $error = $this->mfile->adoptAttachments(
                    $mail_data['attachments'],
                    $mail_id
                )) {
                    $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');
                }
                $mail_data['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');
                }
                $mail_data['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');
                }
                $mail_data['rcp_bcc'] = $bcc;
 
                $mail_data['m_message'] = '';
                if (($sig = ilMailFormCall::getSignature()) !== '') {
                    $mail_data['m_message'] = $sig;
                    $mail_data['m_message'] .= chr(13)
                        . chr(10)
                        . chr(13)
                        . chr(10);
                }
                $mail_data['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.
                $mail_data['rcp_to'] = ilUtil::securePlainString(
                    implode(',', $roles)
                );
 
                $mail_data['m_message'] = '';
                if (($sig = ilMailFormCall::getSignature()) !== '') {
                    $mail_data['m_message'] = $sig;
                    $mail_data['m_message'] .= chr(13)
                        . chr(10)
                        . chr(13)
                        . chr(10);
                }
 
                $additional_msg_text = '';
                if ($this->http->wrapper()->post()->has('additional_message_text')) {
                    $additional_msg_text = ilUtil::securePlainString($this->http->wrapper()->post()->retrieve(
                        'additional_message_text',
                        $this->refinery->kindlyTo()->string()
                    ));
                }
 
                $mail_data['m_message'] .= $additional_msg_text
                    . 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());
                }
                $mail_data['rcp_to'] = urldecode((string) $rcp);
                break;
 
            default:
                $mail_data = $this->http->request()->getParsedBody();
                foreach ($mail_data as $key => $value) {
                    if (is_string($value)) {
                        // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                        $mail_data[$key] = ilUtil::securePlainString($value);
                    }
                }
 
                if ($this->request_attachments) {
                    $mail_data['attachments'] = $this->request_attachments;
                }
                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());
 
        $mail_form = 'form_' . $form_gui->getName();
 
        $btn = $this->ui_factory->button()
                                ->standard($this->lng->txt('search_recipients'), '#')
                                ->withOnLoadCode(static fn($id): string => "
                document.getElementById('$id').addEventListener('click', function() {
                    const frm = document.getElementById('$mail_form'),
                        action = new URL(frm.action),
                        action_params = new URLSearchParams(action.search);
 
                    action_params.delete('cmd');
                    action_params.append('cmd', 'searchUsers');
 
                    action.search = action_params.toString();
 
                    frm.action = action.href;
                    frm.submit();
                    return false;
                });
            ");
        $this->toolbar->addStickyItem($btn);
 
        $btn = $this->ui_factory->button()
                                ->standard($this->lng->txt('mail_my_courses'), '#')
                                ->withOnLoadCode(static fn($id): string => "
                document.getElementById('$id').addEventListener('click', function() {
                    const frm = document.getElementById('$mail_form'),
                        action = new URL(frm.action),
                        action_params = new URLSearchParams(action.search);
 
                    action_params.delete('cmd');
                    action_params.append('cmd', 'searchCoursesTo');
 
                    action.search = action_params.toString();
 
                    frm.action = action.href;
                    frm.submit();
                    return false;
                });
            ");
        $this->toolbar->addComponent($btn);
 
        $btn = $this->ui_factory->button()
                                ->standard($this->lng->txt('mail_my_groups'), '#')
                                ->withOnLoadCode(static fn($id): string => "
                document.getElementById('$id').addEventListener('click', function() {
                    const frm = document.getElementById('$mail_form'),
                        action = new URL(frm.action),
                        action_params = new URLSearchParams(action.search);
 
                    action_params.delete('cmd');
                    action_params.append('cmd', 'searchGroupsTo');
 
                    action.search = action_params.toString();
 
                    frm.action = action.href;
                    frm.submit();
                    return false;
                });
            ");
        $this->toolbar->addComponent($btn);
 
        if (count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0) {
            $btn = $this->ui_factory->button()
                                    ->standard($this->lng->txt('mail_my_mailing_lists'), '#')
                                    ->withOnLoadCode(static fn($id): string => "
                document.getElementById('$id').addEventListener('click', function() {
                    const frm = document.getElementById('$mail_form'),
                        action = new URL(frm.action),
                        action_params = new URLSearchParams(action.search);
 
                    action_params.delete('cmd');
                    action_params.append('cmd', 'searchMailingListsTo');
 
                    action.search = action_params.toString();
 
                    frm.action = action.href;
                    frm.submit();
                    return false;
                });
            ");
            $this->toolbar->addComponent($btn);
        }
 
        $data_source_url = $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) ($mail_data['rcp_to'] ?? ''));
        $inp->setDataSource($data_source_url, ',');
        $form_gui->addItem($inp);
 
        $inp = new ilTextInputGUI($this->lng->txt('mail_cc'), 'rcp_cc');
        $inp->setMaxLength(null);
        $inp->setSize(50);
        $inp->setValue((string) ($mail_data['rcp_cc'] ?? ''));
        $inp->setDataSource($data_source_url, ',');
        $form_gui->addItem($inp);
 
        $inp = new ilTextInputGUI($this->lng->txt('mail_bcc'), 'rcp_bcc');
        $inp->setMaxLength(null);
        $inp->setSize(50);
        $inp->setValue($mail_data['rcp_bcc'] ?? '');
        $inp->setDataSource($data_source_url, ',');
        $form_gui->addItem($inp);
 
        $inp = new ilTextInputGUI($this->lng->txt('subject'), 'm_subject');
        $inp->setSize(50);
        $inp->setRequired(true);
        $inp->setValue((string) ($mail_data['m_subject'] ?? ''));
        $form_gui->addItem($inp);
 
        $att = new ilMailFormAttachmentPropertyGUI(
            $this->lng->txt(
                isset($mail_data['attachments']) && is_array($mail_data['attachments']) ?
                'edit' :
                'add'
            ),
            'm_attachment'
        );
        if (isset($mail_data['attachments']) && is_array($mail_data['attachments'])) {
            foreach ($mail_data['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((string) $data));
                }
            }
        }
        $form_gui->addItem($att);
 
        $context = new ilMailTemplateGenericContext();
        if (ilMailFormCall::getContextId()) {
            $context_id = ilMailFormCall::getContextId();
 
            $mail_data['use_placeholders'] = true;
 
            try {
                $context = ilMailTemplateContextService::getTemplateContextById($context_id);
 
                $templates = $this->template_service->loadTemplatesForContextId($context->getId());
                if ($templates !== []) {
                    $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($mail_data['template_id']) && $template->isDefault()) {
                            $template_chb->setValue((string) $template->getTplId());
                            $form_gui->getItemByPostVar('m_subject')->setValue($template->getSubject());
                            $mail_data['m_message'] = $template->getMessage() . $this->umail->appendSignature(
                                $mail_data['m_message']
                            );
                        }
                    }
                    if (isset($mail_data['template_id'])) {
                        $template_chb->setValue((string) ((int) $mail_data['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) {
                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) ($mail_data['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($mail_data['use_placeholders']) && $mail_data['use_placeholders']);
 
        $placeholders = new ilManualPlaceholderInputGUI(
            $this->lng->txt('mail_form_placeholders_label'),
            'm_placeholders',
            'm_message'
        );
        $placeholders->setInstructionText($this->lng->txt('mail_nacc_use_placeholder'));
        try {
            $placeholders->setAdviseText(sprintf($this->lng->txt('placeholders_advise'), '<br />'));
        } catch (Throwable) {
            $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('assets/js/ilMailComposeFunctions.js');
        $this->tpl->printToStdout();
    }

References $context, $data, $id, $mail_form_type, $request_attachments, ilSession\clear(), ILIAS\Repository\ctrl(), ilUtil\formatSize(), ilSession\get(), ilMailFormCall\getContextId(), ilBuddyList\getInstanceByGlobalUser(), ilLoggerFactory\getLogger(), getQueryParam(), ilMailFormCall\getSignature(), ilMailTemplateContextService\getTemplateContextById(), ILIAS\FileDelivery\http(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), MAIL_FORM_TYPE_ADDRESS, MAIL_FORM_TYPE_ATTACH, MAIL_FORM_TYPE_DRAFT, MAIL_FORM_TYPE_FORWARD, MAIL_FORM_TYPE_NEW, MAIL_FORM_TYPE_REPLY, MAIL_FORM_TYPE_ROLE, MAIL_FORM_TYPE_SEARCH_RESULT, ILIAS\Repository\refinery(), ilUtil\securePlainString(), ilSession\set(), ilMailFormCall\setContextId(), ilMailFormCall\setContextParameters(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSubmissionErrors()

ilMailFormGUI::showSubmissionErrors ( array $errors )

protected

Parameters

list<ilMailError> $errors

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

                                                          : void
    {
        $formatter = new ilMailErrorFormatter($this->lng);
        $formatted_errors = $formatter->format($errors);
 
        if ($formatted_errors !== '') {
            $this->tpl->setOnScreenMessage('failure', $formatted_errors);
        }
    }

References ILIAS\Repository\lng().

Referenced by saveDraft(), and sendMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

readonly ilCtrlInterface ilMailFormGUI::$ctrl

private

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

◆ $http

readonly GlobalHttpState ilMailFormGUI::$http

private

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

◆ $lng

readonly ilLanguage ilMailFormGUI::$lng

private

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

◆ $mail_form_type

string ilMailFormGUI::$mail_form_type = ''

private

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

Referenced by showForm().

◆ $mbox

readonly ilMailbox ilMailFormGUI::$mbox

private

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

◆ $mfile

readonly ilFileDataMail ilMailFormGUI::$mfile

private

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

◆ $purifier

readonly ilMailBodyPurifier ilMailFormGUI::$purifier

private

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

◆ $refinery

readonly Refinery ilMailFormGUI::$refinery

private

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

◆ $request_attachments

array ilMailFormGUI::$request_attachments = null

private

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

Referenced by showForm().

◆ $tabs

readonly ilTabsGUI ilMailFormGUI::$tabs

private

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

◆ $template_service

ilMailTemplateService ilMailFormGUI::$template_service

protected

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

Referenced by __construct().

◆ $toolbar

readonly ilToolbarGUI ilMailFormGUI::$toolbar

private

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

◆ $tpl

readonly ilGlobalTemplateInterface ilMailFormGUI::$tpl

private

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

◆ $ui_factory

readonly Factory ilMailFormGUI::$ui_factory

private

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

◆ $umail

readonly ilFormatMail ilMailFormGUI::$umail

private

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

◆ $user

readonly ilObjUser ilMailFormGUI::$user

private

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

◆ MAIL_FORM_TYPE_ADDRESS

final const string ilMailFormGUI::MAIL_FORM_TYPE_ADDRESS = 'address'

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

Referenced by showForm().

◆ MAIL_FORM_TYPE_ATTACH

final const string ilMailFormGUI::MAIL_FORM_TYPE_ATTACH = 'attach'

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

Referenced by ilMailAttachmentGUI\cancelSaveAttachmentsCommand(), ilMailGUI\executeCommand(), mailAttachment(), returnFromAttachments(), and showForm().

◆ MAIL_FORM_TYPE_DRAFT

final const string ilMailFormGUI::MAIL_FORM_TYPE_DRAFT = 'draft'

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

Referenced by ilMailFolderGUI\executeTableAction(), and showForm().

◆ MAIL_FORM_TYPE_FORWARD

final const string ilMailFormGUI::MAIL_FORM_TYPE_FORWARD = 'forward'

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

Referenced by ilMailFolderGUI\executeTableAction(), and showForm().

◆ MAIL_FORM_TYPE_NEW

final const string ilMailFormGUI::MAIL_FORM_TYPE_NEW = 'new'

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

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

◆ MAIL_FORM_TYPE_REPLY

final const string ilMailFormGUI::MAIL_FORM_TYPE_REPLY = 'reply'

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

Referenced by ilMailGUI\executeCommand(), ilMailFolderGUI\executeTableAction(), replyMail(), and showForm().

◆ MAIL_FORM_TYPE_ROLE

final const string ilMailFormGUI::MAIL_FORM_TYPE_ROLE = 'role'

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

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

◆ MAIL_FORM_TYPE_SEARCH_RESULT

final const string ilMailFormGUI::MAIL_FORM_TYPE_SEARCH_RESULT = 'search_res'

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

Referenced by ilMailGUI\executeCommand(), searchResults(), and showForm().

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

components/ILIAS/Mail/classes/class.ilMailFormGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelMail()

◆ cancelSearch()

◆ decodeAttachmentFiles()

◆ editAttachments()

◆ executeCommand()

◆ getBodyParam()

◆ getQueryParam()

◆ getTemplateDataById()

◆ lookupRecipientAsync()

◆ mailAttachment()

◆ mailRole()

◆ mailUser()

◆ replyMail()

◆ returnFromAttachments()

◆ saveDraft()

◆ saveMailBeforeSearch()

◆ search()

◆ searchCoursesTo()

◆ searchGroupsTo()

◆ searchMailingListsTo()

◆ searchResults()

◆ searchUsers()

◆ sendMessage()

◆ showForm()

◆ showSubmissionErrors()

Field Documentation

◆ $ctrl

◆ $http

◆ $lng

◆ $mail_form_type

◆ $mbox

◆ $mfile

◆ $purifier

◆ $refinery

◆ $request_attachments

◆ $tabs

◆ $template_service

◆ $toolbar

◆ $tpl

◆ $ui_factory

◆ $umail

◆ $user

◆ MAIL_FORM_TYPE_ADDRESS

◆ MAIL_FORM_TYPE_ATTACH

◆ MAIL_FORM_TYPE_DRAFT

◆ MAIL_FORM_TYPE_FORWARD

◆ MAIL_FORM_TYPE_NEW

◆ MAIL_FORM_TYPE_REPLY

◆ MAIL_FORM_TYPE_ROLE

◆ MAIL_FORM_TYPE_SEARCH_RESULT