ilObjMailGUI Class Reference

ilObjMailGUI: ilPermissionGUI More...

Inheritance diagram for ilObjMailGUI:

Collaboration diagram for ilObjMailGUI:

Public Member Functions
	__construct ($a_data, int $a_id, bool $a_call_by_reference)
	executeCommand ()
	getAdminTabs ()
	viewObject ()
	saveObject ()
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $target)
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	getTabs ()
	buildSettingsSubTabs (string $active_sub_tab)
	showGeneralSettingsForm (?ilPropertyFormGUI $form=null)
	getGeneralSettingsForm ()
	populateGeneralSettingsForm (ilPropertyFormGUI $form)
	showExternalSettingsFormObject (?ilPropertyFormGUI $form=null)
	sendTestUserMailObject ()
	sendTestSystemMailObject ()
	sendTestMail (bool $is_manual_mail=false)
	getExternalSettingsForm ()
	populateExternalSettingsForm (ilPropertyFormGUI $form)
	saveExternalSettingsFormObject ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Member Functions
	isEditingAllowed ()
	isViewAllowed ()
	isPermissionChangeAllowed ()
	buildSignaturePlaceholderInputs (Signature $signature)
	getAvailableSignatures ()

Private Attributes
const string	SETTINGS_SUB_TAB_ID_GENERAL = 'settings_general'
const string	SETTINGS_SUB_TAB_ID_EXTERNAL = 'settings_external'
const string	PASSWORD_PLACE_HOLDER = '***********************'
readonly ilTabsGUI	$tabs
readonly ilMustacheFactory	$mustache_factory
readonly MailSignatureService	$mail_signature_service

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
GlobalHttpState	$http
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Refinery	$refinery
ilFavouritesManager	$favourites
CustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Detailed Description

ilObjMailGUI: ilPermissionGUI

Definition at line 30 of file class.ilObjMailGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjMailGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

    {
        global $DIC;
        $this->type = 'mail';
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);

        $this->tabs = $DIC->tabs();
        $this->mustache_factory = $DIC->mail()->mustacheFactory();
        $this->mail_signature_service = $DIC->mail()->signature();

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

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjMailGUI::_goto ( string  $target )

static

Definition at line 740 of file class.ilObjMailGUI.php.

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ROOT_FOLDER_ID.

                                                : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $mail = new ilMail($DIC->user()->getId());

        if ($DIC->rbac()->system()->checkAccess('internal_mail', $mail->getMailObjectReferenceId())) {
            $DIC->ctrl()->redirectToURL('ilias.php?baseClass=ilMailGUI');
        } elseif ($DIC->access()->checkAccess('read', '', ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $DIC->language()->txt('msg_no_perm_read_item'),
                ilObject::_lookupTitle(ilObject::_lookupObjId((int) $target))
            ), true);

            $DIC->ctrl()->setTargetScript('ilias.php');
            $DIC->ctrl()->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
            $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class);
        }

        $DIC['ilErr']->raiseError($DIC->language()->txt('msg_no_perm_read'), $DIC['ilErr']->FATAL);
    }

Here is the call graph for this function:

buildSettingsSubTabs()

ilObjMailGUI::buildSettingsSubTabs ( string  $active_sub_tab )

protected

Definition at line 143 of file class.ilObjMailGUI.php.

References ILIAS\Repository\ctrl(), isViewAllowed(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().

Referenced by showExternalSettingsFormObject(), and showGeneralSettingsForm().

                                                                   : void
    {
        if ($this->isViewAllowed()) {
            $this->tabs->addSubTab(
                self::SETTINGS_SUB_TAB_ID_GENERAL,
                $this->lng->txt('mail_settings_general_tab'),
                $this->ctrl->getLinkTarget($this, 'view')
            );

            if ($this->settings->get('mail_allow_external', '0')) {
                $this->tabs->addSubTab(
                    self::SETTINGS_SUB_TAB_ID_EXTERNAL,
                    $this->lng->txt('mail_settings_external_tab'),
                    $this->ctrl->getLinkTarget($this, 'showExternalSettingsForm')
                );
            }

            $this->tabs->activateSubTab($active_sub_tab);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildSignaturePlaceholderInputs()

ilObjMailGUI::buildSignaturePlaceholderInputs ( Signature  $signature )

private

Returns

ilFormPropertyGUI[]

Definition at line 577 of file class.ilObjMailGUI.php.

References ILIAS\Mail\Signature\Signature\getPersistenceIdentifier(), isEditingAllowed(), ILIAS\Repository\lng(), ilFormPropertyGUI\setDisabled(), ilTextAreaInputGUI\setRows(), and ILIAS\Mail\Signature\Signature\supports().

Referenced by getExternalSettingsForm().

                                                                          : array
    {
        $signature_input = new ilTextAreaInputGUI(
            $this->lng->txt($signature->getPersistenceIdentifier()),
            $signature->getPersistenceIdentifier()
        );
        $signature_input->setRows(8);
        $signature_input->setDisabled(!$this->isEditingAllowed());

        $placeholder_input = new ilManualPlaceholderInputGUI(
            $this->lng->txt('mail_form_placeholders_label'),
            'm_placeholders',
            $signature->getPersistenceIdentifier(),
        );
        $placeholder_input->setDisabled(!$this->isEditingAllowed());

        $placeholder = $this->mail_signature_service->getPlaceholder();
        do {
            if ($signature->supports($placeholder)) {
                $placeholder_input->addPlaceholder($placeholder->getId(), $placeholder->getLabel());
            }
        } while ($placeholder = $placeholder->getNext());

        return [$signature_input, $placeholder_input];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjMailGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl(), isViewAllowed(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this) ?? '';
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch (strtolower($next_class)) {
            case strtolower(ilPermissionGUI::class):
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case strtolower(ilMailTemplateGUI::class):
                if (!$this->isViewAllowed()) {
                    $this->ilias->raiseError(
                        $this->lng->txt('msg_no_perm_write'),
                        $this->ilias->error_obj->WARNING
                    );
                }

                $this->ctrl->forwardCommand(new ilMailTemplateGUI($this->object));
                break;

            default:
                if (!$cmd) {
                    $cmd = 'view';
                }
                $cmd .= 'Object';
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjMailGUI::getAdminTabs

(

)

Definition at line 101 of file class.ilObjMailGUI.php.

References getTabs().

                                  : void
    {
        $this->getTabs();
    }

Here is the call graph for this function:

getAvailableSignatures()

ilObjMailGUI::getAvailableSignatures ( )

private

Returns

Signature[]

Definition at line 766 of file class.ilObjMailGUI.php.

References ILIAS\Repository\settings().

Referenced by getExternalSettingsForm(), populateExternalSettingsForm(), and saveExternalSettingsFormObject().

                                             : array
    {
        return [
            new MailUserSignature($this->settings),
            new MailInstallationSignature($this->settings),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExternalSettingsForm()

ilObjMailGUI::getExternalSettingsForm ( )

protected

Definition at line 401 of file class.ilObjMailGUI.php.

References ilObjectGUI\$user, buildSignaturePlaceholderInputs(), ILIAS\Repository\ctrl(), getAvailableSignatures(), isEditingAllowed(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), and ilPasswordInputGUI\setRetype().

Referenced by saveExternalSettingsFormObject(), and showExternalSettingsFormObject().

                                                : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'saveExternalSettingsForm'));
        $form->setTitle($this->lng->txt('mail_settings_external_frm_head'));

        $smtp = new ilCheckboxInputGUI($this->lng->txt('mail_smtp_status'), 'mail_smtp_status');
        $smtp->setInfo($this->lng->txt('mail_smtp_status_info'));
        $smtp->setValue('1');
        $smtp->setDisabled(!$this->isEditingAllowed());
        $form->addItem($smtp);

        $host = new ilTextInputGUI($this->lng->txt('mail_smtp_host'), 'mail_smtp_host');
        $host->setInfo($this->lng->txt('mail_smtp_host_info'));
        $host->setRequired(true);
        $host->setDisabled(!$this->isEditingAllowed());
        $smtp->addSubItem($host);

        $port = new ilNumberInputGUI($this->lng->txt('mail_smtp_port'), 'mail_smtp_port');
        $port->setInfo($this->lng->txt('mail_smtp_port_info'));
        $port->allowDecimals(false);
        $port->setMinValue(0);
        $port->setMinValue(0);
        $port->setRequired(true);
        $port->setDisabled(!$this->isEditingAllowed());
        $smtp->addSubItem($port);

        $encryption = new ilSelectInputGUI(
            $this->lng->txt('mail_smtp_encryption'),
            'mail_smtp_encryption'
        );
        $encryption_options = [
            '' => $this->lng->txt('please_choose'),
            'tls' => $this->lng->txt('mail_smtp_encryption_tls'),
            'ssl' => $this->lng->txt('mail_smtp_encryption_ssl'),
        ];

        $encryption->setOptions($encryption_options);
        $encryption->setDisabled(!$this->isEditingAllowed());
        $smtp->addSubItem($encryption);

        $user = new ilTextInputGUI($this->lng->txt('mail_smtp_user'), 'mail_smtp_user');
        $user->setDisabled(!$this->isEditingAllowed());
        $user->setDisableHtmlAutoComplete(true);
        $smtp->addSubItem($user);

        $password = new ilPasswordInputGUI(
            $this->lng->txt('mail_smtp_password'),
            'mail_smtp_password'
        );
        $password->setRetype(false);
        $password->setSkipSyntaxCheck(true);
        $password->setDisabled(!$this->isEditingAllowed());
        $password->setDisableHtmlAutoComplete(true);
        $smtp->addSubItem($password);

        $pre = new ilTextInputGUI($this->lng->txt('mail_subject_prefix'), 'mail_subject_prefix');
        $pre->setSize(12);
        $pre->setMaxLength(32);
        $pre->setInfo($this->lng->txt('mail_subject_prefix_info'));
        $pre->setDisabled(!$this->isEditingAllowed());
        $form->addItem($pre);

        $send_html = new ilCheckboxInputGUI($this->lng->txt('mail_send_html'), 'mail_send_html');
        $send_html->setInfo($this->lng->txt('mail_send_html_info'));
        $send_html->setValue('1');
        $send_html->setDisabled(!$this->isEditingAllowed());
        $form->addItem($send_html);

        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('mail_settings_user_frm_head'));
        $form->addItem($sh);

        $user_from_address = new ilEMailInputGUI(
            $this->lng->txt('mail_system_usr_from_addr'),
            'mail_system_usr_from_addr'
        );
        $user_from_address->setInfo($this->lng->txt('mail_system_usr_from_addr_info'));
        $user_from_address->setRequired(true);
        $user_from_address->setDisabled(!$this->isEditingAllowed());
        $form->addItem($user_from_address);

        $use_global_reply_to_address = new ilCheckboxInputGUI(
            $this->lng->txt('mail_use_global_reply_to_addr'),
            'use_global_reply_to_addr'
        );
        $use_global_reply_to_address->setInfo($this->lng->txt('mail_use_global_reply_to_addr_info'));
        $use_global_reply_to_address->setValue('1');
        $use_global_reply_to_address->setDisabled(!$this->isEditingAllowed());
        $form->addItem($use_global_reply_to_address);
        $global_reply_to = new ilEMailInputGUI(
            $this->lng->txt('mail_global_reply_to_addr'),
            'global_reply_to_addr'
        );
        $global_reply_to->setInfo($this->lng->txt('mail_global_reply_to_addr_info'));
        $global_reply_to->setRequired(true);
        $global_reply_to->setDisabled(!$this->isEditingAllowed());
        $use_global_reply_to_address->addSubItem($global_reply_to);

        $user_from_name = new ilTextInputGUI(
            $this->lng->txt('mail_system_usr_from_name'),
            'mail_system_usr_from_name'
        );
        $user_from_name->setInfo($this->lng->txt('mail_system_usr_from_name_info'));
        $user_from_name->setRequired(true);
        $user_from_name->setDisabled(!$this->isEditingAllowed());
        $form->addItem($user_from_name);

        $user_envelope_from_addr = new ilEMailInputGUI(
            $this->lng->txt('mail_system_usr_env_from_addr'),
            'mail_system_usr_env_from_addr'
        );
        $user_envelope_from_addr->setInfo($this->lng->txt('mail_system_usr_env_from_addr_info'));
        $user_envelope_from_addr->setDisabled(!$this->isEditingAllowed());
        $form->addItem($user_envelope_from_addr);

        [$user_signature_inputs, $installation_signature_inputs] = array_map(
            fn(Signature $signature): array => $this->buildSignaturePlaceholderInputs($signature),
            $this->getAvailableSignatures()
        );
        foreach ($user_signature_inputs as $user_signature_input) {
            $form->addItem($user_signature_input);
        }

        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('mail_settings_system_frm_head'));
        $form->addItem($sh);

        $system_from_addr = new ilEMailInputGUI(
            $this->lng->txt('mail_system_sys_from_addr'),
            'mail_system_sys_from_addr'
        );
        $system_from_addr->setInfo($this->lng->txt('mail_system_sys_from_addr_info'));
        $system_from_addr->setRequired(true);
        $system_from_addr->setDisabled(!$this->isEditingAllowed());
        $form->addItem($system_from_addr);

        $system_from_name = new ilTextInputGUI(
            $this->lng->txt('mail_system_sys_from_name'),
            'mail_system_sys_from_name'
        );
        $system_from_name->setRequired(true);
        $system_from_name->setDisabled(!$this->isEditingAllowed());
        $form->addItem($system_from_name);

        $system_reply_to_addr = new ilEMailInputGUI(
            $this->lng->txt('mail_system_sys_reply_to_addr'),
            'mail_system_sys_reply_to_addr'
        );
        $system_reply_to_addr->setRequired(true);
        $system_reply_to_addr->setDisabled(!$this->isEditingAllowed());
        $form->addItem($system_reply_to_addr);

        $system_return_path = new ilEMailInputGUI(
            $this->lng->txt('mail_system_sys_env_from_addr'),
            'mail_system_sys_env_from_addr'
        );
        $system_return_path->setInfo($this->lng->txt('mail_system_sys_env_from_addr_info'));
        $system_return_path->setDisabled(!$this->isEditingAllowed());
        $form->addItem($system_return_path);

        foreach ($installation_signature_inputs as $installation_signature_input) {
            $form->addItem($installation_signature_input);
        }

        if ($this->isEditingAllowed()) {
            $form->addCommandButton('saveExternalSettingsForm', $this->lng->txt('save'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGeneralSettingsForm()

ilObjMailGUI::getGeneralSettingsForm ( )

protected

Definition at line 185 of file class.ilObjMailGUI.php.

References ilAdministrationSettingsFormHandler\addFieldsToForm(), ILIAS\Repository\ctrl(), ilAdministrationSettingsFormHandler\FORM_MAIL, isEditingAllowed(), ILIAS\Repository\lng(), ilFormPropertyGUI\setDisabled(), ilNumberInputGUI\setMinValue(), ilSelectInputGUI\setOptions(), ilNumberInputGUI\setSuffix(), and USER_FOLDER_ID.

Referenced by saveObject(), and showGeneralSettingsForm().

                                               : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'save'));
        $form->setTitle($this->lng->txt('general_settings'));

        $cb = new ilCheckboxInputGUI($this->lng->txt('mail_allow_external'), 'mail_allow_external');
        $cb->setInfo($this->lng->txt('mail_allow_external_info'));
        $cb->setValue('1');
        $cb->setDisabled(!$this->isEditingAllowed());
        $form->addItem($cb);

        $incoming_mail_gui = new ilIncomingMailInputGUI(
            $this->lng->txt('mail_incoming'),
            'incoming_type'
        );
        $incoming_mail_gui->setDisabled(!$this->isEditingAllowed());
        $this->ctrl->setParameterByClass(ilObjUserFolderGUI::class, 'ref_id', USER_FOLDER_ID);
        $incoming_mail_gui->setInfo(sprintf(
            $this->lng->txt('mail_settings_incoming_type_see_also'),
            $this->ctrl->getLinkTargetByClass(ilObjUserFolderGUI::class, 'settings')
        ));
        $this->ctrl->clearParametersByClass(ilObjUserFolderGUI::class);
        $form->addItem($incoming_mail_gui);

        $show_mail_settings_gui = new ilCheckboxInputGUI(
            $this->lng->txt('show_mail_settings'),
            'show_mail_settings'
        );
        $show_mail_settings_gui->setInfo($this->lng->txt('show_mail_settings_info'));
        $show_mail_settings_gui->setValue('1');
        $form->addItem($show_mail_settings_gui);

        $ti = new ilNumberInputGUI($this->lng->txt('mail_maxsize_attach'), 'mail_maxsize_attach');
        $ti->setSuffix($this->lng->txt('kb'));
        $ti->setInfo($this->lng->txt('mail_max_size_attachments_total'));
        $ti->setMaxLength(10);
        $ti->setSize(10);
        $ti->setDisabled(!$this->isEditingAllowed());
        $form->addItem($ti);

        $mn = new ilFormSectionHeaderGUI();
        $mn->setTitle($this->lng->txt('mail_member_notification'));
        $form->addItem($mn);

        $cron_mail = new ilSelectInputGUI(
            $this->lng->txt('cron_mail_notification'),
            'mail_notification'
        );
        $cron_options = [
            0 => $this->lng->txt('cron_mail_notification_never'),
            1 => $this->lng->txt('cron_mail_notification_cron'),
        ];
        $cron_mail->setOptions($cron_options);
        $cron_mail->setInfo(sprintf(
            $this->lng->txt('cron_mail_notification_desc'),
            $this->lng->txt('mail_allow_external')
        ));
        $cron_mail->setDisabled(!$this->isEditingAllowed());
        $form->addItem($cron_mail);

        ilAdministrationSettingsFormHandler::addFieldsToForm(
            ilAdministrationSettingsFormHandler::FORM_MAIL,
            $form,
            $this
        );

        $mn = new ilFormSectionHeaderGUI();
        $mn->setTitle($this->lng->txt('mail_auto_responder'));
        $form->addItem($mn);

        $input = new ilNumberInputGUI($this->lng->txt('mail_auto_responder_idle_time'), 'mail_auto_responder_idle_time');
        $input->setMinValue(1);
        $input->allowDecimals(false);
        $input->setInfo($this->lng->txt('mail_auto_responder_idle_time_info'));
        $input->setSuffix($this->lng->txt('days'));
        $input->setDisabled(!$this->isEditingAllowed());
        $input->setSize(5);
        $form->addItem($input);

        if ($this->isEditingAllowed()) {
            $form->addCommandButton('save', $this->lng->txt('save'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjMailGUI::getTabs ( )

protected

Definition at line 106 of file class.ilObjMailGUI.php.

References ILIAS\Repository\ctrl(), isPermissionChangeAllowed(), isViewAllowed(), and ILIAS\Repository\tabs().

Referenced by getAdminTabs().

                                : void
    {
        if ($this->isViewAllowed()) {
            $this->tabs->addTarget(
                'settings',
                $this->ctrl->getLinkTarget($this, 'view'),
                [
                    'view',
                    'save',
                    '',
                    'showExternalSettingsForm',
                    'saveExternalSettingsForm',
                    'sendTestUserMail',
                    'sendTestSystemMail',
                ]
            );
        }

        if ($this->isViewAllowed()) {
            $this->tabs->addTarget(
                'mail_templates',
                $this->ctrl->getLinkTargetByClass(ilMailTemplateGUI::class, 'showTemplates'),
                '',
                ilMailTemplateGUI::class
            );
        }

        if ($this->isPermissionChangeAllowed()) {
            $this->tabs->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass([static::class, ilPermissionGUI::class], 'perm'),
                ['perm', 'info', 'owner'],
                ilPermissionGUI::class
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isEditingAllowed()

ilObjMailGUI::isEditingAllowed ( )

private

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

References ILIAS\Repository\object().

Referenced by buildSignaturePlaceholderInputs(), getExternalSettingsForm(), getGeneralSettingsForm(), saveExternalSettingsFormObject(), and saveObject().

                                       : bool
    {
        return $this->rbac_system->checkAccess('write', $this->object->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isPermissionChangeAllowed()

ilObjMailGUI::isPermissionChangeAllowed ( )

private

Definition at line 96 of file class.ilObjMailGUI.php.

References ILIAS\Repository\object().

Referenced by getTabs().

                                                : bool
    {
        return $this->rbac_system->checkAccess('edit_permission', $this->object->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isViewAllowed()

ilObjMailGUI::isViewAllowed ( )

private

Definition at line 91 of file class.ilObjMailGUI.php.

References ILIAS\Repository\object().

Referenced by buildSettingsSubTabs(), executeCommand(), getTabs(), sendTestMail(), showExternalSettingsFormObject(), and showGeneralSettingsForm().

                                    : bool
    {
        return $this->rbac_system->checkAccess('read', $this->object->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateExternalSettingsForm()

ilObjMailGUI::populateExternalSettingsForm ( ilPropertyFormGUI  $form )

protected

Definition at line 603 of file class.ilObjMailGUI.php.

References getAvailableSignatures(), ilMimeMail\MAIL_SUBJECT_PREFIX, null, ILIAS\Repository\settings(), and ilPropertyFormGUI\setValuesByArray().

Referenced by showExternalSettingsFormObject().

                                                                            : void
    {
        $subject_prefix = $this->settings->get('mail_subject_prefix');
        if ($subject_prefix === null) {
            $subject_prefix = ilMimeMail::MAIL_SUBJECT_PREFIX;
        }

        [$user_signature, $installation_signature] = $this->getAvailableSignatures();

        $form->setValuesByArray([
            'mail_smtp_status' => (bool) $this->settings->get('mail_smtp_status', '0'),
            'mail_smtp_host' => $this->settings->get('mail_smtp_host', ''),
            'mail_smtp_port' => $this->settings->get('mail_smtp_port', ''),
            'mail_smtp_user' => $this->settings->get('mail_smtp_user', ''),
            'mail_smtp_password' => $this->settings->get('mail_smtp_password') !== '' ?
                self::PASSWORD_PLACE_HOLDER :
                '',
            'mail_smtp_encryption' => $this->settings->get('mail_smtp_encryption', ''),
            'mail_subject_prefix' => $subject_prefix,
            'mail_send_html' => (bool) $this->settings->get('mail_send_html', '0'),
            'mail_system_usr_from_addr' => $this->settings->get('mail_system_usr_from_addr', ''),
            'mail_system_usr_from_name' => $this->settings->get('mail_system_usr_from_name', ''),
            'mail_system_usr_env_from_addr' => $this->settings->get('mail_system_usr_env_from_addr', ''),
            'mail_system_sys_from_addr' => $this->settings->get('mail_system_sys_from_addr', ''),
            'mail_system_sys_from_name' => $this->settings->get('mail_system_sys_from_name', ''),
             $user_signature->getPersistenceIdentifier() => $this->settings->get($user_signature->getPersistenceIdentifier(), ''),
            'mail_system_sys_reply_to_addr' => $this->settings->get('mail_system_sys_reply_to_addr', ''),
            'mail_system_sys_env_from_addr' => $this->settings->get('mail_system_sys_env_from_addr', ''),
            $installation_signature->getPersistenceIdentifier() => $this->settings->get($installation_signature->getPersistenceIdentifier(), ''),
            'use_global_reply_to_addr' => (bool) $this->settings->get('use_global_reply_to_addr', '0'),
            'global_reply_to_addr' => $this->settings->get('global_reply_to_addr', ''),
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateGeneralSettingsForm()

ilObjMailGUI::populateGeneralSettingsForm ( ilPropertyFormGUI  $form )

protected

Definition at line 273 of file class.ilObjMailGUI.php.

References ilMailOptions\FIRST_EMAIL, ILIAS\Repository\settings(), and ilPropertyFormGUI\setValuesByArray().

Referenced by showGeneralSettingsForm().

                                                                           : void
    {
        $form->setValuesByArray([
            'mail_allow_external' => (bool) $this->settings->get('mail_allow_external', '0'),
            'incoming_type' => (string) $this->settings->get('mail_incoming_mail', '0'),
            'mail_address_option' => $this->settings->get('mail_address_option', '') !== '' ?
                $this->settings->get('mail_address_option') :
                (string) ilMailOptions::FIRST_EMAIL,
            'mail_address_option_both' => $this->settings->get('mail_address_option', '') !== '' ?
                $this->settings->get('mail_address_option') :
                (string) ilMailOptions::FIRST_EMAIL,
            'show_mail_settings' => (bool) $this->settings->get('show_mail_settings', '1'),
            'mail_maxsize_attach' => $this->settings->get('mail_maxsize_attach', ''),
            'mail_notification' => $this->settings->get('mail_notification', ''),
            'mail_auto_responder_idle_time' => is_numeric($this->settings->get('mail_auto_responder_idle_time', (string) AutoresponderService::AUTO_RESPONDER_DEFAULT_IDLE_TIME)) ?
                (string) $this->settings->get('mail_auto_responder_idle_time', '3') :
                '',
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveExternalSettingsFormObject()

ilObjMailGUI::saveExternalSettingsFormObject ( )

protected

Definition at line 637 of file class.ilObjMailGUI.php.

References ILIAS\Repository\ctrl(), getAvailableSignatures(), getExternalSettingsForm(), ILIAS\Mail\Signature\Signature\getPersistenceIdentifier(), isEditingAllowed(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and showExternalSettingsFormObject().

                                                       : void
    {
        if (!$this->isEditingAllowed()) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
        }

        $form = $this->getExternalSettingsForm();
        $is_form_valid = $form->checkInput();

        if (!$is_form_valid) {
            $form->setValuesByPost();
            $this->showExternalSettingsFormObject($form);
            return;
        }

        $is_smtp_enabled = (bool) $form->getInput('mail_smtp_status');
        if ($is_smtp_enabled && $form->getInput('mail_smtp_user') &&
            !$form->getInput('mail_smtp_password')
        ) {
            $form->getItemByPostVar('mail_smtp_password')->setRequired(true);
            $form->getItemByPostVar('mail_smtp_password')
                 ->setAlert($this->lng->txt('mail_smtp_password_req'));
            $form->setValuesByPost();
            $this->showExternalSettingsFormObject($form);
            return;
        }

        // If all forms in ILIAS use the UI/KS forms (here and in Services/Mail), we should move this to a proper constraint/trafo
        $is_valid_template_syntax = $this->refinery->custom()->constraint(function ($value): bool {
            try {
                $this->mustache_factory->getBasicEngine()->render((string) $value, []);
                return true;
            } catch (Exception) {
                return false;
            }
        }, $this->lng->txt('mail_template_invalid_tpl_syntax'));

        $valid_templates = true;
        $availabe_signatures = array_map(
            static fn(Signature $signature): string => $signature->getPersistenceIdentifier(),
            $this->getAvailableSignatures()
        );
        foreach (
            ['mail_system_usr_from_name', ...$availabe_signatures] as $template
        ) {
            try {
                $is_valid_template_syntax->check((string) $form->getInput($template));
            } catch (Exception) {
                $form->getItemByPostVar($template)->setAlert(
                    $is_valid_template_syntax->problemWith((string) $form->getInput($template))
                );
                $valid_templates = false;
            }
        }
        if (!$valid_templates) {
            $form->setValuesByPost();
            $this->showExternalSettingsFormObject($form);
            return;
        }

        $this->settings->set('mail_smtp_status', (string) ((int) $form->getInput('mail_smtp_status')));
        $this->settings->set('mail_smtp_host', (string) $form->getInput('mail_smtp_host'));
        $this->settings->set('mail_smtp_port', (string) ((int) $form->getInput('mail_smtp_port')));
        $this->settings->set('mail_smtp_user', (string) $form->getInput('mail_smtp_user'));
        if ($form->getInput('mail_smtp_password') !== self::PASSWORD_PLACE_HOLDER) {
            $this->settings->set('mail_smtp_password', (string) $form->getInput('mail_smtp_password'));
        }
        $this->settings->set('mail_smtp_encryption', (string) $form->getInput('mail_smtp_encryption'));
        $this->settings->set('mail_send_html', (string) $form->getInput('mail_send_html'));
        $this->settings->set('mail_subject_prefix', (string) $form->getInput('mail_subject_prefix'));
        $this->settings->set('mail_system_usr_from_addr', (string) $form->getInput('mail_system_usr_from_addr'));
        $this->settings->set('mail_system_usr_from_name', (string) $form->getInput('mail_system_usr_from_name'));
        $this->settings->set(
            'mail_system_usr_env_from_addr',
            (string) $form->getInput('mail_system_usr_env_from_addr')
        );
        $this->settings->set(
            'mail_system_sys_from_addr',
            (string) $form->getInput('mail_system_sys_from_addr')
        );
        $this->settings->set('mail_system_sys_from_name', (string) $form->getInput('mail_system_sys_from_name'));
        $this->settings->set(
            'mail_system_sys_reply_to_addr',
            (string) $form->getInput('mail_system_sys_reply_to_addr')
        );
        $this->settings->set(
            'mail_system_sys_env_from_addr',
            (string) $form->getInput('mail_system_sys_env_from_addr')
        );
        $this->settings->set('use_global_reply_to_addr', (string) ((int) $form->getInput('use_global_reply_to_addr')));
        $this->settings->set('global_reply_to_addr', (string) $form->getInput('global_reply_to_addr'));

        foreach ($availabe_signatures as $availabe_signature) {
            $this->settings->set(
                $availabe_signature,
                (string) $form->getInput($availabe_signature)
            );
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
        $this->ctrl->redirect($this, 'showExternalSettingsForm');
    }

Here is the call graph for this function:

saveObject()

ilObjMailGUI::saveObject

(

)

Definition at line 293 of file class.ilObjMailGUI.php.

References ILIAS\Repository\ctrl(), ilMailOptions\FIRST_EMAIL, getGeneralSettingsForm(), ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, ILIAS\Repository\int(), isEditingAllowed(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and showGeneralSettingsForm().

                                : void
    {
        if (!$this->isEditingAllowed()) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
        }

        $form = $this->getGeneralSettingsForm();
        if ($form->checkInput()) {
            $incoming_type = (int) $form->getInput('incoming_type');

            $mail_address_option = ilMailOptions::FIRST_EMAIL;
            if ($incoming_type === ilMailOptions::INCOMING_EMAIL) {
                $mail_address_option = (int) $form->getInput('mail_address_option');
            } elseif ($incoming_type === ilMailOptions::INCOMING_BOTH) {
                $mail_address_option = (int) $form->getInput('mail_address_option_both');
            }

            $this->settings->set('mail_allow_external', (string) ((int) $form->getInput('mail_allow_external')));
            $this->settings->set('mail_incoming_mail', (string) $incoming_type);
            $this->settings->set('show_mail_settings', (string) ((int) $form->getInput('show_mail_settings')));
            $this->settings->set('mail_address_option', (string) $mail_address_option);
            $this->settings->set('mail_maxsize_attach', (string) $form->getInput('mail_maxsize_attach'));
            $this->settings->set('mail_notification', (string) ((int) $form->getInput('mail_notification')));
            $this->settings->set('mail_auto_responder_idle_time', (string) $form->getInput('mail_auto_responder_idle_time'));

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            $this->ctrl->redirect($this);
        }

        $form->setValuesByPost();
        $this->showGeneralSettingsForm($form);
    }

Here is the call graph for this function:

sendTestMail()

ilObjMailGUI::sendTestMail ( bool  $is_manual_mail = false )

protected

Definition at line 363 of file class.ilObjMailGUI.php.

References ANONYMOUS_USER_ID, isViewAllowed(), ILIAS\Repository\lng(), showExternalSettingsFormObject(), and ILIAS\Repository\user().

Referenced by sendTestSystemMailObject(), and sendTestUserMailObject().

                                                                 : void
    {
        if (!$this->isViewAllowed()) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
        }

        if ($this->user->getEmail() === '') {
            $this->showExternalSettingsFormObject();
            return;
        }

        if ($is_manual_mail) {
            $mail = new ilMail($this->user->getId());
        } else {
            $mail = new ilMail(ANONYMOUS_USER_ID);
        }

        $mail->setSaveInSentbox(false);
        $mail->appendInstallationSignature(!$is_manual_mail);

        $lng_variable_prefix = 'sys';
        if ($is_manual_mail) {
            $lng_variable_prefix = 'usr';
        }

        $mail->enqueue(
            $this->user->getEmail(),
            '',
            '',
            $this->lng->txt('mail_email_' . $lng_variable_prefix . '_subject'),
            $this->lng->txt('mail_email_' . $lng_variable_prefix . '_body'),
            []
        );

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_external_test_sent'));
        $this->showExternalSettingsFormObject();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendTestSystemMailObject()

ilObjMailGUI::sendTestSystemMailObject ( )

protected

Definition at line 358 of file class.ilObjMailGUI.php.

References sendTestMail().

                                                 : void
    {
        $this->sendTestMail();
    }

Here is the call graph for this function:

sendTestUserMailObject()

ilObjMailGUI::sendTestUserMailObject ( )

protected

Definition at line 353 of file class.ilObjMailGUI.php.

References sendTestMail().

                                               : void
    {
        $this->sendTestMail(true);
    }

Here is the call graph for this function:

showExternalSettingsFormObject()

ilObjMailGUI::showExternalSettingsFormObject ( ?ilPropertyFormGUI  $form = null )

protected

Definition at line 326 of file class.ilObjMailGUI.php.

References buildSettingsSubTabs(), ILIAS\Repository\ctrl(), getExternalSettingsForm(), isViewAllowed(), ILIAS\Repository\lng(), null, populateExternalSettingsForm(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by saveExternalSettingsFormObject(), and sendTestMail().

                                                                                      : void
    {
        if (!$this->isViewAllowed()) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
        }

        $this->buildSettingsSubTabs(self::SETTINGS_SUB_TAB_ID_EXTERNAL);

        if ($form === null) {
            $form = $this->getExternalSettingsForm();
            $this->populateExternalSettingsForm($form);
        }

        if ($this->user->getEmail() !== '') {
            $this->toolbar->addComponent($this->ui_factory->button()->standard(
                $this->lng->txt('mail_external_send_test_usr'),
                $this->ctrl->getLinkTarget($this, 'sendTestUserMail')
            ));
            $this->toolbar->addComponent($this->ui_factory->button()->standard(
                $this->lng->txt('mail_external_send_test_sys'),
                $this->ctrl->getLinkTarget($this, 'sendTestSystemMail')
            ));
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

showGeneralSettingsForm()

ilObjMailGUI::showGeneralSettingsForm ( ?ilPropertyFormGUI  $form = null )

protected

Definition at line 169 of file class.ilObjMailGUI.php.

References buildSettingsSubTabs(), getGeneralSettingsForm(), isViewAllowed(), ILIAS\Repository\lng(), null, and populateGeneralSettingsForm().

Referenced by saveObject(), and viewObject().

                                                                               : void
    {
        if (!$this->isViewAllowed()) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
        }

        $this->buildSettingsSubTabs(self::SETTINGS_SUB_TAB_ID_GENERAL);

        if ($form === null) {
            $form = $this->getGeneralSettingsForm();
            $this->populateGeneralSettingsForm($form);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

viewObject()

ilObjMailGUI::viewObject

(

)

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

References showGeneralSettingsForm().

                                : void
    {
        $this->showGeneralSettingsForm();
    }

Here is the call graph for this function:

Field Documentation

$mail_signature_service

readonly MailSignatureService ilObjMailGUI::$mail_signature_service

private

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

$mustache_factory

readonly ilMustacheFactory ilObjMailGUI::$mustache_factory

private

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

$tabs

readonly ilTabsGUI ilObjMailGUI::$tabs

private

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

PASSWORD_PLACE_HOLDER

const string ilObjMailGUI::PASSWORD_PLACE_HOLDER = '***********************'

private

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

SETTINGS_SUB_TAB_ID_EXTERNAL

const string ilObjMailGUI::SETTINGS_SUB_TAB_ID_EXTERNAL = 'settings_external'

private

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

SETTINGS_SUB_TAB_ID_GENERAL

const string ilObjMailGUI::SETTINGS_SUB_TAB_ID_GENERAL = 'settings_general'

private

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

---

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

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