ilMailFormGUI Class Reference

@ilCtrl_Calls ilMailFormGUI: ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI, ilMailFormUploadHandlerGUI @ilCtrl_Calls ilMailFormGUI: ILIAS\User\Search\EndpointGUI More...

Collaboration diagram for ilMailFormGUI:

Public Member Functions
	executeCommand ()
	saveMessageToOutbox (array $form_values, Form $form)
	sendMessage ()
	saveDraft ()
	searchUsers (bool $save=true)
	searchCoursesTo ()
	searchGroupsTo ()
	search ()
	cancelSearch ()
	editAttachments ()
	returnFromAttachments ()
	searchResults ()
	mailUser ()
	mailRole ()
	replyMail ()
	mailAttachment ()
	showForm (?Form $form=null)
	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'
final const string	MAIL_FORM_TYPE_OUTBOX = 'outbox'
final const string	PARAM_SCHEDULED_EDIT_FROM_OUTBOX = 'scheduled_edit_from_outbox'
final const string	MAIL_FORM_MODE_REGULAR_MAIL = 'regular_mail'
final const string	MAIL_FORM_MODE_SERIAL_LETTER = 'serial_letter'

Protected Member Functions
	getTemplateDataById ()
	tryHandleAttachments (array $attachments, ?Form $form=null)
	showSubmissionErrors (array $errors)
	buildForm (?array $mail_data=null)
	buildFormElements (?array $mail_data)
	addToolbarButtons (Form $form)

Protected Attributes
ilMailTemplateService	$template_service

Private Member Functions
	getQueryParam (string $name, Transformation $trafo, $default=null)
	getBodyParam (string $name, Transformation $trafo, $default=null)
	resetStage ()
	getOwnMailOrRedirect (int $mail_id)
	saveMailBeforeSearch (?array $input_results=null)
	getUserSearchConfigurator ()
	mailFormToolbarDelegatedSubmitJs (string $toolbar_button_id, string $form_action)
	toggleMailMode ()

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
MailAttachments	$request_attachments = null
readonly ilMailBodyPurifier	$purifier
string	$mail_form_type = ''
readonly Factory	$ui_factory
readonly Renderer	$ui_renderer
readonly Psr Http Message ServerRequestInterface	$request
readonly ArrayBasedRequestWrapper	$post
readonly ArrayBasedRequestWrapper	$query
readonly ilMailFormUploadHandlerGUI	$upload_handler
readonly ilFileDataMail	$fdm
readonly ILIAS ResourceStorage Services	$storage
readonly ilSetting	$settings
readonly ILIAS User Search Search	$user_search
readonly ClockFactory	$clock

Detailed Description

@ilCtrl_Calls ilMailFormGUI: ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI, ilMailFormUploadHandlerGUI @ilCtrl_Calls ilMailFormGUI: ILIAS\User\Search\EndpointGUI

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

Member Function Documentation

addToolbarButtons()

ilMailFormGUI::addToolbarButtons ( Form  $form )

protected

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

                                                    : void
    {
        $bf = $this->ui_factory->button();
 
        $result = $form->getInputGroup()->getInputs()[0]->getInputs();
        $use_placeholders = (bool) $result['use_placeholders']->getValue();
        $action = $this->ctrl->getFormAction($this, 'toggleMailMode');
        $url_builder = new UrlBuilder(new URI(ILIAS_HTTP_PATH . '/' . $action));
        [$url_builder, $mail_mode_parameter] = $url_builder->acquireParameter(['mail', 'form'], 'mail_mode');
 
        $btn = $this->ui_factory->viewControl()->mode(
            [
                $this->lng->txt(self::MAIL_FORM_MODE_REGULAR_MAIL) => (string) $url_builder->withParameter(
                    $mail_mode_parameter,
                    self::MAIL_FORM_MODE_REGULAR_MAIL
                )->buildURI(),
                $this->lng->txt(self::MAIL_FORM_MODE_SERIAL_LETTER) => (string) $url_builder->withParameter(
                    $mail_mode_parameter,
                    self::MAIL_FORM_MODE_SERIAL_LETTER
                )->buildURI(),
            ],
            'mail_mode_switch_label'
        )->withActive(
            $this->lng->txt($use_placeholders ? self::MAIL_FORM_MODE_SERIAL_LETTER : self::MAIL_FORM_MODE_REGULAR_MAIL)
        );
 
        $this->toolbar->addComponent($btn);
        $this->toolbar->addSeparator();
 
        $this->tpl->addOnLoadCode(
            "document.getElementById('{$this->toolbar->getId()}')
            .querySelector('div[aria-label=\"" . $this->lng->txt('mail_mode_switch_label') . "\"]')
            .querySelectorAll('button[data-action]').forEach(function(button) {
                button.addEventListener('click', function(event) {
                    event.preventDefault();
                    event.stopPropagation();
                    event.stopImmediatePropagation();
                    
                    let mailform = document.querySelector('form.c-form');
                    let action = button.getAttribute('data-action');
                    if (action && mailform) {
                        let submitBtn = mailform.querySelector('button[type=\"submit\"]');
                        if (submitBtn) {
                            submitBtn.formAction = action;
                            mailform.requestSubmit(submitBtn);
                        } else {
                            mailform.action = action;
                            mailform.submit();
                        }
                    }
                    return false;
                }, true);
            });"
        );
 
        $action = $this->ctrl->getFormAction($this, 'searchUsers');
        $btn = $bf->standard(
            $this->lng->txt('search_recipients'),
            ''
        )->withAdditionalOnLoadCode(
            fn(string $id): string => $this->mailFormToolbarDelegatedSubmitJs($id, $action)
        );
 
        $this->toolbar->addComponent($btn);
 
        $action = $this->ctrl->getFormAction($this, 'searchCoursesTo');
        $btn = $bf->standard(
            $this->lng->txt('mail_my_courses'),
            ''
        )->withAdditionalOnLoadCode(
            fn(string $id): string => $this->mailFormToolbarDelegatedSubmitJs($id, $action)
        );
        $this->toolbar->addComponent($btn);
 
        $action = $this->ctrl->getFormAction($this, 'searchGroupsTo');
        $btn = $bf->standard(
            $this->lng->txt('mail_my_groups'),
            ''
        )->withAdditionalOnLoadCode(
            fn(string $id): string => $this->mailFormToolbarDelegatedSubmitJs($id, $action)
        );
        $this->toolbar->addComponent($btn);
 
        if (count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0) {
            $action = $this->ctrl->getFormAction($this, 'searchMailingListsTo');
            $btn = $bf->standard(
                $this->lng->txt('mail_my_mailing_lists'),
                ''
            )->withAdditionalOnLoadCode(
                fn(string $id): string => $this->mailFormToolbarDelegatedSubmitJs($id, $action)
            );
            $this->toolbar->addComponent($btn);
        }
 
        $this->toolbar->addSeparator();
 
        $action = $this->ctrl->getFormAction($this, 'editAttachments');
        $btn = $bf->standard(
            $this->lng->txt('edit_attachments'),
            ''
        )->withAdditionalOnLoadCode(
            fn(string $id): string => $this->mailFormToolbarDelegatedSubmitJs($id, $action)
        );
        $this->toolbar->addComponent($btn);
    }

References $id, ILIAS\Repository\ctrl(), ILIAS\UI\Component\Input\Container\Container\getInputs(), ilBuddyList\getInstanceByGlobalUser(), ILIAS\UI\Implementation\Component\Input\getValue(), ILIAS\Repository\lng(), mailFormToolbarDelegatedSubmitJs(), and ILIAS\Repository\toolbar().

Referenced by showForm().

Here is the call graph for this function:

Here is the caller graph for this function:

buildForm()

ilMailFormGUI::buildForm ( ?array  $mail_data = null )

protected

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

                                                          : Form
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, 'sendMessage'),
            $this->buildFormElements($mail_data)
        )->withAdditionalFormAction(
            $this->ctrl->getFormAction($this, 'saveDraft'),
            $this->lng->txt('save_message')
        )->withSubmitLabel($this->lng->txt('send_mail'));
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UI\Component\Input\Container\Form\Form\withAdditionalFormAction().

Referenced by saveDraft(), saveMailBeforeSearch(), sendMessage(), showForm(), and toggleMailMode().

Here is the call graph for this function:

Here is the caller graph for this function:

buildFormElements()

ilMailFormGUI::buildFormElements ( ?array  $mail_data )

protected

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

                                                           : array
    {
        $mail_data ??= [];
        $ff = $this->ui_factory->input()->field();
 
        $rcp_to = $this->user_search->getInput(
            $this->lng->txt('mail_to'),
            $this->getUserSearchConfigurator()
        )->withRequired(true, $this->refinery->logical()->sequential([
            $this->refinery->logical()->not($this->refinery->null()),
            $this->refinery->string()->hasMinLength(1)
        ])->withProblemBuilder(function ($txt) {
            return $txt('mail_add_recipient');
        }));
        $rcp_cc = $this->user_search->getInput(
            $this->lng->txt('mail_cc'),
            $this->getUserSearchConfigurator()
        );
        $rcp_bcc = $this->user_search->getInput(
            $this->lng->txt('mail_bcc'),
            $this->getUserSearchConfigurator()
        );
 
        if (!is_null($mail_data)) {
            if (isset($mail_data['rcp_to']) && $mail_data['rcp_to'] != '') {
                $rcp_to = $rcp_to->withValue(explode(',', $mail_data['rcp_to']) ?? (array) $mail_data['rcp_to']);
            }
            if (isset($mail_data['rcp_cc']) && $mail_data['rcp_cc'] != '') {
                $rcp_cc = $rcp_cc->withValue(explode(',', $mail_data['rcp_cc']) ?? (array) $mail_data['rcp_cc']);
            }
            if (isset($mail_data['rcp_bcc']) && $mail_data['rcp_bcc'] != '') {
                $rcp_bcc = $rcp_bcc->withValue(explode(',', $mail_data['rcp_bcc']) ?? (array) $mail_data['rcp_bcc']);
            }
        }
 
        $attachments = $ff->file(
            $this->upload_handler,
            $this->lng->txt('attachments')
        )->withMaxFiles(10);
 
        $attachment_total_size_limit = $this->fdm->getAttachmentsTotalSizeLimit();
        if ($attachment_total_size_limit !== null) {
            $attachments = $attachments->withMaxFileSize((int) $attachment_total_size_limit);
        }
 
        $mail_attachments = $mail_data['attachments'] ?? null;
        if ($mail_attachments instanceof MailAttachments && !$mail_attachments->isEmpty()) {
            // Legacy pool attachments are converted to IRSS once when the mail is read (ilMail::fetchMailData),
            // creating collections while rendering would leave an orphaned copy behind on every request
            $mail_data['attachments'] = $mail_attachments->isIrss()
                ? $this->FilesFromIRSSToLegacy($mail_attachments->rcid())
                : [];
            $attachments = $attachments->withValue($mail_data['attachments']);
        } elseif (is_array($mail_attachments) && $mail_attachments !== []) {
            $attachments = $attachments->withValue($mail_attachments);
        }
 
        $template_chb = null;
        $signal = null;
        $use_placeholder_value = false;
        $context = new ilMailTemplateGenericContext();
        if (ilMailFormCall::getContextId()) {
            $context_id = ilMailFormCall::getContextId();
 
            try {
                $context = ilMailTemplateContextService::getTemplateContextById($context_id);
                $use_placeholder_value = true;
 
                $templates = $this->template_service->loadTemplatesForContextId($context->getId());
                if (!empty($templates)) {
                    $options = [];
 
                    $tmpl_value = '';
                    $signal_generator = new ILIAS\UI\Implementation\Component\SignalGenerator();
                    $signal = $signal_generator->create();
                    foreach ($templates as $template) {
                        $options[$template->getTplId()] = $template->getTitle();
                        $signal->addOption($template->getTplId() . '_subject', urlencode($template->getSubject()));
                        $signal->addOption($template->getTplId() . '_message', urlencode($template->getMessage()));
 
                        if (!isset($mail_data['template_id']) && $template->isDefault()) {
                            $tmpl_value = $template->getTplId();
                            $mail_data['m_subject'] = $template->getSubject();
                            $mail_data['m_message'] = $this->umail->appendSignature($template->getMessage());
                        }
                    }
                    if (isset($mail_data['template_id'])) {
                        $tmpl_value = (int) $mail_data['template_id'];
                    }
                    asort($options);
 
                    $template_chb = $ff
                        ->select(
                            $this->lng->txt('mail_template_client'),
                            $options,
                            $this->lng->txt('mail_template_client_info')
                        )
                        ->withValue($tmpl_value)
                        ->withOnUpdate($signal);
                }
            } catch (Exception) {
                ilLoggerFactory::getLogger('mail')->error(sprintf(
                    '%s has been called with invalid context id: %s.',
                    __METHOD__,
                    $context_id
                ));
            }
        } else {
            $use_placeholder_value = $mail_data['use_placeholders'] ?? false;
        }
 
        $m_subject = $ff
            ->text($this->lng->txt('subject'))
            ->withRequired(
                true,
                $this->refinery->logical()->sequential([
                    $this->refinery->logical()->not($this->refinery->null()),
                    $this->refinery->string()->hasMinLength(1)
                ])->withProblemBuilder(function ($txt) {
                    return $txt('mail_add_subject');
                })
            )
            ->withMaxLength(200)
            ->withValue($mail_data['m_subject'] ?? '');
 
        $m_message = $ff->markdown(
            new ilUIMarkdownPreviewGUI(),
            $this->lng->txt('message_content')
        )->withValue($mail_data['m_message'] ?? '');
 
        $use_placeholders = $ff->hidden()->withValue($use_placeholder_value ? '1' : '0');
 
        $placeholders = [];
        $mode = $use_placeholder_value ? self::MAIL_FORM_MODE_SERIAL_LETTER : self::MAIL_FORM_MODE_REGULAR_MAIL;
        if ($mode === self::MAIL_FORM_MODE_SERIAL_LETTER && $context) {
            foreach ($context->getPlaceholders() as $value) {
                $placeholders[$value['placeholder']] = $value['label'];
            }
            if (!empty($placeholders)) {
                $m_message = $m_message
                    ->withMustacheVariables(
                        $placeholders,
                        $this->lng->txt('mail_nacc_use_placeholder') . '<br />'
                        . sprintf($this->lng->txt('placeholders_advise'), '<br />')
                    )
                ;
            }
        }
 
        $use_placeholders = $use_placeholders->withAdditionalTransformation(
            $this->refinery->kindlyTo()->bool()
        );
 
        if ($signal !== null) {
            $m_subject = $m_subject->withAdditionalOnLoadCode(
                function ($id) use ($signal) {
                    return "
                    $(document).on('{$signal}', function (event, signalData) {
                        let subject = document.getElementById('{$id}');
                        let child = subject.querySelector('.c-input__field input');
                        let triggerer = signalData.triggerer[0];
                        let tplId = triggerer.querySelector('select').value;
                        if (tplId != '') {
                            child.value = decodeURIComponent(signalData.options[tplId + '_subject'].replace(/\+/g, ' '));
                        }
                    });
                ";
                }
            );
            $m_message = $m_message->withAdditionalOnLoadCode(
                function ($id) use ($signal) {
                    return "
                    $(document).on('{$signal}', function (event, signalData) {
                        let message = document.getElementById('{$id}');
                        let child = message.querySelector('.c-input__field textarea');
                        let triggerer = signalData.triggerer[0];
                        let tplId = triggerer.querySelector('select').value;
                        if (tplId != '') {
                            child.value = decodeURIComponent(signalData.options[tplId + '_message'].replace(/\+/g, ' '));
                        }
                    });
                ";
                }
            );
        }
 
        $elements = [
            'rcp_to' => $rcp_to,
            'rcp_cc' => $rcp_cc,
            'rcp_bcc' => $rcp_bcc,
            'm_subject' => $m_subject,
            'attachments' => $attachments
        ];
        if ($template_chb !== null) {
            $elements[] = $template_chb;
        }
        $elements['m_message'] = $m_message;
 
        $schedule_date_time_value = null;
        $current_time = $this->clock->local(new DateTimeZone($this->user->getTimeZone()))->now();
        $schedule_date_time_input = $ff
            ->dateTime($this->lng->txt('mail_schedule_scheduled_datetime'))
            ->withUseTime(true)
            ->withTimezone($this->user->getTimezone())
            ->withAdditionalTransformation(
                $this->refinery->custom()->constraint(
                    function (DateTimeImmutable $v) use ($current_time) {
                        return $v > $current_time;
                    },
                    $this->lng->txt('mail_schedule_error_past_datetime')
                )
            );
 
        if (isset($mail_data['schedule_datetime'])) {
            $schedule_time = new DateTimeImmutable(
                (string) $mail_data['schedule_datetime'],
                new DateTimeZone($mail_data['schedule_timezone'] ?? '')
            );
            $schedule_time->setTimezone(new DateTimeZone($this->user->getTimeZone()));
            $schedule_date_time_value = $schedule_time > $current_time ? $schedule_time : null;
        }
 
        $use_schedule_input = $ff->optionalGroup(
            ['m_schedule' => $schedule_date_time_input],
            $this->lng->txt('mail_message_scheduled')
        )->withAdditionalTransformation(
            $this->refinery->custom()->constraint(
                function (?array $v) {
                    return $v === null || (isset($v['m_schedule']) && $v['m_schedule'] instanceof DateTimeImmutable);
                },
                $this->lng->txt('mail_schedule_error_no_datetime')
            )
        );
        if ($schedule_date_time_value !== null) {
            $use_schedule_input = $use_schedule_input->withValue(['m_schedule' => $schedule_date_time_value]);
        } else {
            $use_schedule_input = $use_schedule_input->withValue(null);
        }
 
        $elements['use_schedule'] = $use_schedule_input;
        $elements['use_placeholders'] = $use_placeholders;
 
        $section = $ff->section(
            $elements,
            $this->lng->txt('compose')
        );
 
        return [
            $section
        ];
    }

References $id, ILIAS\UI\Implementation\Component\Input\Field\$options, ilMailFormCall\getContextId(), ilLoggerFactory\getLogger(), ilMailTemplateContextService\getTemplateContextById(), getUserSearchConfigurator(), ILIAS\Repository\int(), ILIAS\Mail\Attachments\MailAttachments\isEmpty(), ILIAS\Repository\lng(), MAIL_FORM_MODE_REGULAR_MAIL, MAIL_FORM_MODE_SERIAL_LETTER, ILIAS\Repository\refinery(), ILIAS\Repository\user(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Here is the call graph for this function:

cancelMail()

ilMailFormGUI::cancelMail

(

)

Definition at line 988 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 560 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:

editAttachments()

ilMailFormGUI::editAttachments

(

)

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

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

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

Here is the call graph for this function:

executeCommand()

ilMailFormGUI::executeCommand

(

)

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

                                    : void
    {
        $forward_class = $this->ctrl->getNextClass($this) ?? '';
        switch (strtolower($forward_class)) {
            case strtolower(ILIAS\User\Search\EndpointGUI::class):
                $gui = $this->user_search->getEndpointGUI(
                    $this->getUserSearchConfigurator()
                );
                $this->ctrl->forwardCommand($gui);
                break;
 
            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;
 
            case strtolower(ilMailFormUploadHandlerGUI::class):
                $this->ctrl->forwardCommand($this->upload_handler);
                break;
 
            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = 'showForm';
                }
 
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

getBodyParam()

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

private

Definition at line 152 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 lookupRecipientAsync(), and search().

Here is the call graph for this function:

Here is the caller graph for this function:

getOwnMailOrRedirect()

ilMailFormGUI::getOwnMailOrRedirect ( int  $mail_id )

private

Returns

array<string, mixed>

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

                                                       : array
    {
        $mail_data = $this->umail->getMail($mail_id);
        if ($mail_data === null) {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('permission_denied'),
                true
            );
            $this->ctrl->redirectByClass(ilMailGUI::class);
        }
 
        return $mail_data;
    }

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

Referenced by showForm().

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 140 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(), and toggleMailMode().

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateDataById()

ilMailFormGUI::getTemplateDataById ( )

protected

Definition at line 610 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:

getUserSearchConfigurator()

ilMailFormGUI::getUserSearchConfigurator ( )

private

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

                                                : \ILIAS\User\Search\EndpointConfigurator
    {
        return new UserSearchEndpointConfigurator();
    }

Referenced by buildFormElements(), and executeCommand().

Here is the caller graph for this function:

lookupRecipientAsync()

ilMailFormGUI::lookupRecipientAsync

(

)

Definition at line 947 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 604 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:

mailFormToolbarDelegatedSubmitJs()

ilMailFormGUI::mailFormToolbarDelegatedSubmitJs ( string  $toolbar_button_id, string  $form_action  )

private

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

                                                                                                     : string
    {
        return "document.getElementById('{$toolbar_button_id}').addEventListener('click', function () {
            let mailform = document.querySelector('form.c-form');
            if (!mailform) {
                return;
            }
            let submitBtn = mailform.querySelector('button[type=\"submit\"]');
            if (submitBtn) {
                submitBtn.formAction = '$form_action';
                mailform.requestSubmit(submitBtn);
            } else {
                mailform.action = '$form_action';
                mailform.submit();
            }
        });";
    }

Referenced by addToolbarButtons().

Here is the caller graph for this function:

mailRole()

ilMailFormGUI::mailRole

(

)

Definition at line 592 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 586 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 598 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:

resetStage()

ilMailFormGUI::resetStage ( )

private

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

                                 : void
    {
        $this->umail->persistToStage($this->user->getId(), '', '', '', '', '', null);
    }

References ILIAS\Repository\user().

Referenced by saveDraft(), and saveMessageToOutbox().

Here is the call graph for this function:

Here is the caller graph for this function:

returnFromAttachments()

ilMailFormGUI::returnFromAttachments

(

)

Definition at line 574 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 405 of file class.ilMailFormGUI.php.

                               : void
    {
        $form = $this->buildForm()->withRequest($this->request);
        $result = $form->getInputGroup()->getContent();
 
        if (!$result->isOK()) {
            $this->showForm($form);
            return;
        }
 
        $value = $result->value()[0];
 
        if ($value['m_subject'] === '') {
            $value['m_subject'] = $this->lng->txt('mail_no_subject');
        }
        try {
            $attachments = $this->attachmentsFromFormUpload($value['attachments']);
        } catch (ilMailAttachmentsTotalSizeLimitExceededException $e) {
            $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $e->getMessage());
            $this->showForm($form);
            return;
        }
 
        $draft_folder_id = $this->mbox->getDraftsFolder();
 
        $rcp_to = !empty($value['rcp_to']) ? implode(',', $value['rcp_to']) : '';
        $rcp_cc = !empty($value['rcp_cc']) ? implode(',', $value['rcp_cc']) : '';
        $rcp_bcc = !empty($value['rcp_bcc']) ? implode(',', $value['rcp_bcc']) : '';
 
        if ($errors = $this->umail->validateRecipients($rcp_to, $rcp_cc, $rcp_bcc)) {
            $this->umail->saveAttachments($attachments);
            $this->request_attachments = $attachments;
            $this->showSubmissionErrors($errors);
            $this->showForm($form);
            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,
            $attachments,
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
            ilUtil::securePlainString($value['m_subject']),
            $value['m_message'],
            $draft_id,
            $value['use_schedule']['m_schedule'] ?? null,
            $value['use_placeholders'],
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
 
        if (ilSession::get('outbox')) {
            $outbox_id = (int) ilSession::get('outbox');
            ilSession::clear('outbox');
            $this->umail->deleteMails([$outbox_id]);
        }
 
        $this->resetStage();
 
        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $draft_folder_id);
        $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 Vendor\Package\$e, buildForm(), ilSession\clear(), ILIAS\Repository\ctrl(), ilSession\get(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ILIAS\Repository\int(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ilUtil\redirect(), resetStage(), ilUtil\securePlainString(), showForm(), and showSubmissionErrors().

Here is the call graph for this function:

saveMailBeforeSearch()

ilMailFormGUI::saveMailBeforeSearch ( ?array  $input_results = null )

private

Parameters

array<string|

ILIAS\UI\Component\Input\Input>|null $input_results

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

                                                                       : void
    {
        if (empty($input_results)) {
            $form = $this->buildForm()->withRequest($this->request);
            $result = $form->getInputGroup()->getInputs()[0]->getInputs();
        } else {
            $result = $input_results;
        }
 
        $stage_attachments = null;
        if (!empty($result['attachments']->getValue())) {
            $stage_attachments = $this->tryHandleAttachments($result['attachments']->getValue());
            if ($stage_attachments === null) {
                return;
            }
        }
 
        $rcp_to = implode(',', $result['rcp_to']->getValue() ?? []);
        $rcp_cc = implode(',', $result['rcp_cc']->getValue() ?? []);
        $rcp_bcc = implode(',', $result['rcp_bcc']->getValue() ?? []);
 
        $this->umail->persistToStage(
            $this->user->getId(),
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
            ilUtil::securePlainString($result['m_subject']->getValue()),
            ilUtil::securePlainString($result['m_message']->getValue()),
            $stage_attachments,
            (bool) $result['use_placeholders']->getValue(),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
    }

References buildForm(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ILIAS\UI\Implementation\Component\Input\getValue(), ilUtil\securePlainString(), tryHandleAttachments(), and ILIAS\Repository\user().

Referenced by editAttachments(), searchCoursesTo(), searchGroupsTo(), searchMailingListsTo(), searchUsers(), and toggleMailMode().

Here is the call graph for this function:

Here is the caller graph for this function:

saveMessageToOutbox()

ilMailFormGUI::saveMessageToOutbox	(	array	$form_values,
		Form	$form
	)

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

                                                                       : void
    {
        try {
            $attachments = $this->attachmentsFromFormUpload($form_values['attachments']);
        } catch (ilMailAttachmentsTotalSizeLimitExceededException $e) {
            $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $e->getMessage());
            $this->showForm($form);
            return;
        }
 
        $rcp_to = '';
        $rcp_cc = '';
        $rcp_bcc = '';
        if ($form_values['rcp_to'] !== []) {
            $rcp_to = $form_values['rcp_to'][0];
        }
        if ($form_values['rcp_cc'] !== []) {
            $rcp_cc = $form_values['rcp_cc'][0];
        }
        if ($form_values['rcp_bcc'] !== []) {
            $rcp_bcc = $form_values['rcp_bcc'][0];
        }
 
        $errors = $this->umail->validateRecipients(
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
        );
        if ($errors) {
            $this->umail->saveAttachments($attachments);
            $this->showSubmissionErrors($errors);
            $this->showForm();
            $this->http->close();
        }
 
        $sanitized_message = (new ilMailBody($form_values['m_message'], $this->purifier))->getContent();
 
        $outbox_folder_id = $this->mbox->getOutboxFolder();
        if (ilSession::get('outbox')) {
            $outbox_id = (int) ilSession::get('outbox');
            ilSession::clear('outbox');
        }
 
        $this->umail->scheduledMail(
            $outbox_folder_id,
            $this->user->getId(),
            new MailScheduleData(
                new MailDeliveryData(
                    $rcp_to,
                    $rcp_cc,
                    $rcp_bcc,
                    ilUtil::securePlainString($form_values['m_subject'] ?? $this->lng->txt('mail_no_subject')),
                    $sanitized_message,
                    $attachments,
                    $form_values['use_placeholders'],
                    $outbox_id ?? null
                ),
                $form_values['use_schedule']['m_schedule']
            ),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
 
        if (ilSession::get('draft')) {
            $draft_id = (int) ilSession::get('draft');
            ilSession::clear('draft');
            $this->umail->deleteMails([$draft_id]);
        }
 
        // The scheduled mail now owns its attachments, a new mail must not inherit them
        $this->resetStage();
 
        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $outbox_folder_id);
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_scheduled'), true);
 
        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        } else {
            $this->ctrl->redirectByClass([ilMailGUI::class, ilMailFolderGUI::class]);
        }
 
        $this->showForm();
    }

References Vendor\Package\$e, ilSession\clear(), ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\UI\Implementation\Component\Input\ViewControl\getContent(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ilUtil\redirect(), resetStage(), ilUtil\securePlainString(), showForm(), showSubmissionErrors(), and ILIAS\Repository\user().

Referenced by sendMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

search()

ilMailFormGUI::search

(

)

Definition at line 536 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 520 of file class.ilMailFormGUI.php.

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

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

Here is the call graph for this function:

searchGroupsTo()

ilMailFormGUI::searchGroupsTo

(

)

Definition at line 528 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 1035 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 580 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 489 of file class.ilMailFormGUI.php.

                                                  : void
    {
        $this->tpl->setTitle($this->lng->txt('mail_new'));
 
        if ($save) {
            $this->saveMailBeforeSearch();
        }
 
        $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(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), and saveMailBeforeSearch().

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

                                 : void
    {
        $form = $this->buildForm()->withRequest($this->request);
        $result = $form->getInputGroup()->getContent();
 
        if (!$result->isOK()) {
            $this->showForm($form);
            return;
        }
 
        $value = $result->value()[0];
 
        $schedule_date = $value['use_schedule']['m_schedule'] ?? null;
        if ($schedule_date instanceof DateTimeImmutable &&
            $schedule_date > $this->clock->local(new DateTimeZone($this->user->getTimeZone()))->now()) {
            $this->saveMessageToOutbox($value, $form);
            return;
        }
 
        try {
            $attachments = $this->attachmentsFromFormUpload($value['attachments']);
        } catch (ilMailAttachmentsTotalSizeLimitExceededException $e) {
            $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $e->getMessage());
            $this->showForm($form);
            return;
        }
 
        $mailer = $this->umail
            ->withContextId(ilMailFormCall::getContextId() ?: '')
            ->withContextParameters(ilMailFormCall::getContextParameters());
 
        $mailer->setSaveInSentbox(true);
 
        $mailer->autoresponder()->enableAutoresponder();
 
        $rcp_to = '';
        $rcp_cc = '';
        $rcp_bcc = '';
        if (!empty($value['rcp_to'])) {
            $rcp_to = implode(',', $value['rcp_to']);
        }
        if (!empty($value['rcp_cc'])) {
            $rcp_cc = implode(',', $value['rcp_cc']);
        }
        if (!empty($value['rcp_bcc'])) {
            $rcp_bcc = implode(',', $value['rcp_bcc']);
        }
 
        if ($errors = $mailer->enqueue(
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
            ilUtil::securePlainString($value['m_subject']),
            (new ilMailBody($value['m_message'], $this->purifier))->getContent(),
            $attachments,
            $value['use_placeholders']
        )) {
            $mailer->autoresponder()->disableAutoresponder();
 
            $this->umail->saveAttachments($attachments);
            $this->showSubmissionErrors($errors);
            $this->showForm($form);
 
            $this->http->close();
        } else {
            $mailer->autoresponder()->disableAutoresponder();
 
            $mailer->persistToStage(
                $this->user->getId(),
                '',
                '',
                '',
                '',
                '',
                null
            );
 
            $mail_id = null;
            if (ilSession::get('outbox')) {
                $mail_id = (int) ilSession::get('outbox');
                ilSession::clear('outbox');
            } elseif (ilSession::get('draft')) {
                $mail_id = (int) ilSession::get('draft');
                ilSession::clear('draft');
            }
 
            if ($mail_id) {
                $mailer->deleteMails([$mail_id]);
            }
 
            $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 Vendor\Package\$e, buildForm(), ilSession\clear(), ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\UI\Implementation\Component\Input\ViewControl\getContent(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ilMailFormCall\isRefererStored(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, saveMessageToOutbox(), ilUtil\securePlainString(), showForm(), showSubmissionErrors(), and ILIAS\Repository\user().

Here is the call graph for this function:

showForm()

ilMailFormGUI::showForm

(

?Form

$form = null

)

Definition at line 637 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_new'));
 
        $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_data['m_subject'] = '';
        $mail_data['m_message'] = '';
 
        $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_DRAFT:
                $mail_data = $this->getOwnMailOrRedirect($mail_id);
                ilSession::set('draft', $mail_id);
 
                if ($mail_data['attachments'] instanceof MailAttachments && !$mail_data['attachments']->isEmpty()) {
                    $stage_attachments = $this->stageAttachmentsFromMailAttachments($mail_data['attachments']);
                    $this->umail->persistToStage(
                        $this->user->getId(),
                        (string) ($mail_data['rcp_to'] ?? ''),
                        (string) ($mail_data['rcp_cc'] ?? ''),
                        (string) ($mail_data['rcp_bcc'] ?? ''),
                        (string) ($mail_data['m_subject'] ?? ''),
                        (string) ($mail_data['m_message'] ?? ''),
                        $stage_attachments,
                        (bool) ($mail_data['use_placeholders'] ?? false),
                        $mail_data['tpl_ctx_id'] ?? null,
                        (array) ($mail_data['tpl_ctx_params'] ?? [])
                    );
                    $mail_data['attachments'] = $this->formRidsFromMailAttachments($stage_attachments);
                } else {
                    $mail_data['attachments'] = [];
                }
 
                ilMailFormCall::setContextId($mail_data['tpl_ctx_id']);
                ilMailFormCall::setContextParameters($mail_data['tpl_ctx_params']);
                break;
 
            case self::MAIL_FORM_TYPE_OUTBOX:
                $mail_data = $this->getOwnMailOrRedirect($mail_id);
                ilSession::set('outbox', $mail_id);
 
                if ($mail_data['attachments'] instanceof MailAttachments && !$mail_data['attachments']->isEmpty()) {
                    $stage_attachments = $this->stageAttachmentsFromMailAttachments($mail_data['attachments']);
                    $this->umail->persistToStage(
                        $this->user->getId(),
                        (string) ($mail_data['rcp_to'] ?? ''),
                        (string) ($mail_data['rcp_cc'] ?? ''),
                        (string) ($mail_data['rcp_bcc'] ?? ''),
                        (string) ($mail_data['m_subject'] ?? ''),
                        (string) ($mail_data['m_message'] ?? ''),
                        $stage_attachments,
                        (bool) ($mail_data['use_placeholders'] ?? false),
                        $mail_data['tpl_ctx_id'] ?? null,
                        (array) ($mail_data['tpl_ctx_params'] ?? [])
                    );
                    $mail_data['attachments'] = $this->formRidsFromMailAttachments($stage_attachments);
                } else {
                    $mail_data['attachments'] = [];
                }
 
                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 ($mail_data['attachments'] instanceof MailAttachments && !$mail_data['attachments']->isEmpty()) {
                    $stage_attachments = $mail_data['attachments']->isLegacy()
                        ? $this->fdm->createStageFromLegacyMailAttachments(
                            (int) $mail_id,
                            $mail_data['attachments']->legacyFilenames()
                        )
                        : $this->stageAttachmentsFromMailAttachments($mail_data['attachments']);
                    $this->umail->persistToStage(
                        $this->user->getId(),
                        '',
                        '',
                        '',
                        $mail_data['m_subject'] ?? '',
                        $mail_data['m_message'] ?? '',
                        $stage_attachments,
                        false
                    );
                    $mail_data['attachments'] = $this->formRidsFromMailAttachments($stage_attachments);
                } else {
                    $mail_data['attachments'] = [];
                }
                break;
 
            case self::MAIL_FORM_TYPE_NEW:
                ilSession::clear('draft');
                ilSession::clear('outbox');
                // 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;
            case self::MAIL_FORM_TYPE_ATTACH:
                $mail_data = $this->umail->retrieveFromStage();
                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 instanceof MailAttachments && $this->request_attachments->isIrss()) {
                    $mail_data['attachments'] = $this->FilesFromIRSSToLegacy($this->request_attachments->rcid());
                }
                break;
        }
 
        if (
            $type === self::MAIL_FORM_TYPE_DRAFT
            && !empty($mail_data['schedule_datetime'])
            && !(
                $this->http->wrapper()->query()->has(self::PARAM_SCHEDULED_EDIT_FROM_OUTBOX)
                && $this->http->wrapper()->query()->retrieve(
                    self::PARAM_SCHEDULED_EDIT_FROM_OUTBOX,
                    $this->refinery->kindlyTo()->int()
                ) === 1
            )
        ) {
            $this->tpl->setOnScreenMessage(
                ilGlobalTemplateInterface::MESSAGE_TYPE_INFO,
                $this->lng->txt('mail_scheduled_edit_compose_info'),
                true
            );
        }
 
        $this->tpl->parseCurrentBlock();
 
        $form ??= $this->buildForm($mail_data);
        $this->addToolbarButtons($form);
 
        $this->tpl->setVariable('FORM', $this->ui_renderer->render($form));
        $this->tpl->addJavaScript('assets/js/ilMailComposeFunctions.js');
        $this->tpl->printToStdout();
    }

References $mail_form_type, addToolbarButtons(), buildForm(), ilSession\clear(), ilSession\get(), getOwnMailOrRedirect(), getQueryParam(), ilMailFormCall\getSignature(), ILIAS\FileDelivery\http(), ILIAS\Mail\Attachments\MailAttachments\isIrss(), 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_OUTBOX, MAIL_FORM_TYPE_REPLY, MAIL_FORM_TYPE_ROLE, MAIL_FORM_TYPE_SEARCH_RESULT, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_INFO, ILIAS\Repository\refinery(), ilUtil\securePlainString(), ilSession\set(), ilMailFormCall\setContextId(), ilMailFormCall\setContextParameters(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

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

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 1060 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(), saveMessageToOutbox(), and sendMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

toggleMailMode()

ilMailFormGUI::toggleMailMode ( )

private

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

                                     : never
    {
        $form = $this->buildForm()->withRequest($this->request);
 
        $mode = $this->getQueryParam(
            'mail_form_mail_mode',
            $this->refinery->kindlyTo()->string(),
            self::MAIL_FORM_MODE_REGULAR_MAIL
        );
 
        $result = null;
        if (!ilMailFormCall::getContextId() && in_array(
            $mode,
            [self::MAIL_FORM_MODE_REGULAR_MAIL, self::MAIL_FORM_MODE_SERIAL_LETTER],
            true
        )) {
            $result = $form->getInputGroup()->getInputs()[0]->getInputs();
            $result['use_placeholders'] = $result['use_placeholders']->withValue(
                $mode === self::MAIL_FORM_MODE_SERIAL_LETTER ? '1' : '0'
            );
        } elseif ($mode === self::MAIL_FORM_MODE_REGULAR_MAIL && ilMailFormCall::getContextId()) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_INFO,
                sprintf(
                    $this->lng->txt('mail_mode_switch_locked'),
                    $this->lng->txt('regular_mail')
                ),
                true
            );
        }
 
        $this->saveMailBeforeSearch($result ?? null);
 
        $this->ctrl->redirect($this, 'searchResults');
    }

References buildForm(), ILIAS\Repository\ctrl(), ilMailFormCall\getContextId(), getQueryParam(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and saveMailBeforeSearch().

Here is the call graph for this function:

tryHandleAttachments()

ilMailFormGUI::tryHandleAttachments ( array  $attachments, ?Form  $form = null  )

protected

Parameters

list<string>

$attachments

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

                                                                                   : ?MailAttachments
    {
        try {
            return $this->attachmentsFromFormUpload($attachments);
        } catch (ilMailAttachmentsTotalSizeLimitExceededException $e) {
            $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $e->getMessage());
            $this->showForm($form);
            return null;
        }
    }

References Vendor\Package\$e, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, and showForm().

Referenced by saveMailBeforeSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$clock

readonly ClockFactory ilMailFormGUI::$clock

private

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

$ctrl

readonly ilCtrlInterface ilMailFormGUI::$ctrl

private

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

$fdm

readonly ilFileDataMail ilMailFormGUI::$fdm

private

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

$http

readonly GlobalHttpState ilMailFormGUI::$http

private

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

$lng

readonly ilLanguage ilMailFormGUI::$lng

private

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

$mail_form_type

string ilMailFormGUI::$mail_form_type = ''

private

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

Referenced by showForm().

$mbox

readonly ilMailbox ilMailFormGUI::$mbox

private

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

$mfile

readonly ilFileDataMail ilMailFormGUI::$mfile

private

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

$post

readonly ArrayBasedRequestWrapper ilMailFormGUI::$post

private

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

$purifier

readonly ilMailBodyPurifier ilMailFormGUI::$purifier

private

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

$query

readonly ArrayBasedRequestWrapper ilMailFormGUI::$query

private

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

$refinery

readonly Refinery ilMailFormGUI::$refinery

private

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

$request

readonly Psr Http Message ServerRequestInterface ilMailFormGUI::$request

private

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

$request_attachments

MailAttachments ilMailFormGUI::$request_attachments = null

private

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

$settings

readonly ilSetting ilMailFormGUI::$settings

private

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

$storage

readonly ILIAS ResourceStorage Services ilMailFormGUI::$storage

private

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

$tabs

readonly ilTabsGUI ilMailFormGUI::$tabs

private

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

$template_service

ilMailTemplateService ilMailFormGUI::$template_service

protected

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

$toolbar

readonly ilToolbarGUI ilMailFormGUI::$toolbar

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailFormGUI::$tpl

private

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

$ui_factory

readonly Factory ilMailFormGUI::$ui_factory

private

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

$ui_renderer

readonly Renderer ilMailFormGUI::$ui_renderer

private

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

$umail

readonly ilFormatMail ilMailFormGUI::$umail

private

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

$upload_handler

readonly ilMailFormUploadHandlerGUI ilMailFormGUI::$upload_handler

private

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

$user

readonly ilObjUser ilMailFormGUI::$user

private

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

$user_search

readonly ILIAS User Search Search ilMailFormGUI::$user_search

private

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

MAIL_FORM_MODE_REGULAR_MAIL

final const string ilMailFormGUI::MAIL_FORM_MODE_REGULAR_MAIL = 'regular_mail'

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

Referenced by buildFormElements().

MAIL_FORM_MODE_SERIAL_LETTER

final const string ilMailFormGUI::MAIL_FORM_MODE_SERIAL_LETTER = 'serial_letter'

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

Referenced by buildFormElements().

MAIL_FORM_TYPE_ADDRESS

final const string ilMailFormGUI::MAIL_FORM_TYPE_ADDRESS = 'address'

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

Referenced by showForm().

MAIL_FORM_TYPE_ATTACH

final const string ilMailFormGUI::MAIL_FORM_TYPE_ATTACH = 'attach'

Definition at line 50 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 57 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 56 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 52 of file class.ilMailFormGUI.php.

Referenced by ilMailGUI\executeCommand(), ILIAS\Mail\Provider\MailGlobalScreenToolProvider\getToolsForContextStack(), mailUser(), ilMailMemberSearchGUI\sendMailToSelectedUsers(), and showForm().

MAIL_FORM_TYPE_OUTBOX

final const string ilMailFormGUI::MAIL_FORM_TYPE_OUTBOX = 'outbox'

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

Referenced by showForm().

MAIL_FORM_TYPE_REPLY

final const string ilMailFormGUI::MAIL_FORM_TYPE_REPLY = 'reply'

Definition at line 54 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 53 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 51 of file class.ilMailFormGUI.php.

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

PARAM_SCHEDULED_EDIT_FROM_OUTBOX

final const string ilMailFormGUI::PARAM_SCHEDULED_EDIT_FROM_OUTBOX = 'scheduled_edit_from_outbox'

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

Referenced by ilMailFolderGUI\executeTableAction().

---

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

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