Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Private Member Functions |
Private Attributes
ilObjMailGUI Class Reference
@ilCtrl_Calls 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 () | |
| administration tabs show only permissions and trash folder More... | |
| viewObject () | |
| viewObject container presentation for "administration -> repository, trash, permissions" More... | |
| 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 () | |
| @abstract overwrite in derived GUI class of your object type More... | |
| 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 () | |
| @abstract 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 |
Detailed Description
@ilCtrl_Calls 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.
41 {
42 global $DIC;
43 $this->type = 'mail';
45
46 $this->tabs = $DIC->tabs();
47 $this->mustache_factory = $DIC->mail()->mustacheFactory();
48 $this->mail_signature_service = $DIC->mail()->signature();
49
51 }
References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().
Here is the call graph for this function:
Member Function Documentation
◆ _goto()
|
static |
Definition at line 736 of file class.ilObjMailGUI.php.
736 : void
737 {
738 global $DIC;
739 $main_tpl = $DIC->ui()->mainTemplate();
740
742
746 $main_tpl->setOnScreenMessage('failure', sprintf(
749 ), true);
750
753 $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class);
754 }
755
757 }
Definition: class.ilMail.php:29
References $DIC, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ROOT_FOLDER_ID.
Here is the call graph for this function:
◆ buildSettingsSubTabs()
|
protected |
Definition at line 143 of file class.ilObjMailGUI.php.
143 : void
144 {
146 $this->tabs->addSubTab(
147 self::SETTINGS_SUB_TAB_ID_GENERAL,
149 $this->ctrl->getLinkTarget($this, 'view')
150 );
151
153 $this->tabs->addSubTab(
154 self::SETTINGS_SUB_TAB_ID_EXTERNAL,
156 $this->ctrl->getLinkTarget($this, 'showExternalSettingsForm')
157 );
158 }
159
160 $this->tabs->activateSubTab($active_sub_tab);
161 }
162 }
References isViewAllowed(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().
Referenced by showExternalSettingsFormObject(), and showGeneralSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ buildSignaturePlaceholderInputs()
|
private |
- Returns
- ilFormPropertyGUI[]
Definition at line 573 of file class.ilObjMailGUI.php.
573 : array
574 {
577 $signature->getPersistenceIdentifier()
578 );
579 $signature_input->setRows(8);
580 $signature_input->setDisabled(!$this->isEditingAllowed());
581
584 'm_placeholders',
585 $signature->getPersistenceIdentifier(),
586 );
587 $placeholder_input->setDisabled(!$this->isEditingAllowed());
588
589 $placeholder = $this->mail_signature_service->getPlaceholder();
590 do {
592 $placeholder_input->addPlaceholder($placeholder->getId(), $placeholder->getLabel());
593 }
594 } while ($placeholder = $placeholder->getNext());
595
596 return [$signature_input, $placeholder_input];
597 }
This class represents a text area property in a property form.
Definition: class.ilTextAreaInputGUI.php:28
getPersistenceIdentifier()
supports(Placeholder $placeholder)
References ILIAS\Mail\Signature\Signature\getPersistenceIdentifier(), isEditingAllowed(), ILIAS\Repository\lng(), and ILIAS\Mail\Signature\Signature\supports().
Referenced by getExternalSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ executeCommand()
| ilObjMailGUI::executeCommand | ( | ) |
Reimplemented from ilObjectGUI.
Definition at line 53 of file class.ilObjMailGUI.php.
53 : void
54 {
56 $cmd = $this->ctrl->getCmd();
57 $this->prepareOutput();
58
59 switch (strtolower($next_class)) {
60 case strtolower(ilPermissionGUI::class):
61 $perm_gui = new ilPermissionGUI($this);
62 $this->ctrl->forwardCommand($perm_gui);
63 break;
64
65 case strtolower(ilMailTemplateGUI::class):
67 $this->ilias->raiseError(
69 $this->ilias->error_obj->WARNING
70 );
71 }
72
74 break;
75
76 default:
77 if (!$cmd) {
78 $cmd = 'view';
79 }
80 $cmd .= 'Object';
81 $this->$cmd();
82 break;
83 }
84 }
@ilCtrl_isCalledBy ilMailTemplateGUI: ilObjMailGUI
Definition: class.ilMailTemplateGUI.php:31
prepareOutput(bool $show_sub_objects=true)
Definition: class.ilObjectGUI.php:307
Definition: class.ilPermissionGUI.php:36
Class ilObjForumAdministration.
References ILIAS\Repository\ctrl(), isViewAllowed(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().
Here is the call graph for this function:
◆ getAdminTabs()
| ilObjMailGUI::getAdminTabs | ( | ) |
administration tabs show only permissions and trash folder
Reimplemented from ilObjectGUI.
Definition at line 101 of file class.ilObjMailGUI.php.
101 : void
102 {
103 $this->getTabs();
104 }
getTabs()
@abstract overwrite in derived GUI class of your object type
Definition: class.ilObjMailGUI.php:106
References getTabs().
Here is the call graph for this function:
◆ getAvailableSignatures()
|
private |
- Returns
- Signature[]
Definition at line 762 of file class.ilObjMailGUI.php.
762 : array
763 {
764 return [
767 ];
768 }
References ILIAS\Repository\settings().
Referenced by getExternalSettingsForm(), and populateExternalSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getExternalSettingsForm()
|
protected |
Definition at line 397 of file class.ilObjMailGUI.php.
397 : ilPropertyFormGUI
398 {
400
403
406 $smtp->setValue('1');
407 $smtp->setDisabled(!$this->isEditingAllowed());
408 $form->addItem($smtp);
409
412 $host->setRequired(true);
413 $host->setDisabled(!$this->isEditingAllowed());
414 $smtp->addSubItem($host);
415
418 $port->allowDecimals(false);
419 $port->setMinValue(0);
420 $port->setMinValue(0);
421 $port->setRequired(true);
422 $port->setDisabled(!$this->isEditingAllowed());
423 $smtp->addSubItem($port);
424
427 'mail_smtp_encryption'
428 );
429 $encryption_options = [
433 ];
434
435 $encryption->setOptions($encryption_options);
436 $encryption->setDisabled(!$this->isEditingAllowed());
437 $smtp->addSubItem($encryption);
438
442 $smtp->addSubItem($user);
443
446 'mail_smtp_password'
447 );
448 $password->setRetype(false);
449 $password->setSkipSyntaxCheck(true);
450 $password->setDisabled(!$this->isEditingAllowed());
451 $password->setDisableHtmlAutoComplete(true);
452 $smtp->addSubItem($password);
453
455 $pre->setSize(12);
456 $pre->setMaxLength(32);
458 $pre->setDisabled(!$this->isEditingAllowed());
459 $form->addItem($pre);
460
463 $send_html->setValue('1');
464 $send_html->setDisabled(!$this->isEditingAllowed());
465 $form->addItem($send_html);
466
469 $form->addItem($sh);
470
473 'mail_system_usr_from_addr'
474 );
476 $user_from_address->setRequired(true);
477 $user_from_address->setDisabled(!$this->isEditingAllowed());
478 $form->addItem($user_from_address);
479
482 'use_global_reply_to_addr'
483 );
485 $use_global_reply_to_address->setValue('1');
486 $use_global_reply_to_address->setDisabled(!$this->isEditingAllowed());
487 $form->addItem($use_global_reply_to_address);
490 'global_reply_to_addr'
491 );
493 $global_reply_to->setRequired(true);
494 $global_reply_to->setDisabled(!$this->isEditingAllowed());
495 $use_global_reply_to_address->addSubItem($global_reply_to);
496
499 'mail_system_usr_from_name'
500 );
502 $user_from_name->setRequired(true);
503 $user_from_name->setDisabled(!$this->isEditingAllowed());
504 $form->addItem($user_from_name);
505
508 'mail_system_usr_env_from_addr'
509 );
511 $user_envelope_from_addr->setDisabled(!$this->isEditingAllowed());
512 $form->addItem($user_envelope_from_addr);
513
514 [$user_signature_inputs, $installation_signature_inputs] = array_map(
516 $this->getAvailableSignatures()
517 );
518 foreach ($user_signature_inputs as $user_signature_input) {
519 $form->addItem($user_signature_input);
520 }
521
524 $form->addItem($sh);
525
528 'mail_system_sys_from_addr'
529 );
531 $system_from_addr->setRequired(true);
532 $system_from_addr->setDisabled(!$this->isEditingAllowed());
533 $form->addItem($system_from_addr);
534
537 'mail_system_sys_from_name'
538 );
539 $system_from_name->setRequired(true);
540 $system_from_name->setDisabled(!$this->isEditingAllowed());
541 $form->addItem($system_from_name);
542
545 'mail_system_sys_reply_to_addr'
546 );
547 $system_reply_to_addr->setRequired(true);
548 $system_reply_to_addr->setDisabled(!$this->isEditingAllowed());
549 $form->addItem($system_reply_to_addr);
550
553 'mail_system_sys_env_from_addr'
554 );
556 $system_return_path->setDisabled(!$this->isEditingAllowed());
557 $form->addItem($system_return_path);
558
559 foreach ($installation_signature_inputs as $installation_signature_input) {
560 $form->addItem($installation_signature_input);
561 }
562
565 }
566
567 return $form;
568 }
This class represents a checkbox property in a property form.
Definition: class.ilCheckboxInputGUI.php:28
This class represents a email property in a property form.
Definition: class.ilEMailInputGUI.php:27
This class represents a section header in a property form.
Definition: class.ilFormSectionHeaderGUI.php:28
This class represents a number property in a property form.
Definition: class.ilNumberInputGUI.php:28
buildSignaturePlaceholderInputs(Signature $signature)
Definition: class.ilObjMailGUI.php:573
This class represents a password property in a property form.
Definition: class.ilPasswordInputGUI.php:28
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:32
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:28
This class represents a text property in a property form.
Definition: class.ilTextInputGUI.php:28
Definition: Signature.php:26
References ilObjectGUI\$user, buildSignaturePlaceholderInputs(), ILIAS\Repository\ctrl(), getAvailableSignatures(), isEditingAllowed(), and ILIAS\Repository\lng().
Referenced by saveExternalSettingsFormObject(), and showExternalSettingsFormObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getGeneralSettingsForm()
|
protected |
Definition at line 185 of file class.ilObjMailGUI.php.
185 : ilPropertyFormGUI
186 {
188
191
194 $cb->setValue('1');
195 $cb->setDisabled(!$this->isEditingAllowed());
196 $form->addItem($cb);
197
200 'incoming_type'
201 );
202 $incoming_mail_gui->setDisabled(!$this->isEditingAllowed());
204 $this->ctrl->clearParametersByClass(ilObjUserFolderGUI::class);
205 $form->addItem($incoming_mail_gui);
206
209 'show_mail_settings'
210 );
212 $show_mail_settings_gui->setValue('1');
213 $form->addItem($show_mail_settings_gui);
214
218 $ti->setMaxLength(10);
219 $ti->setSize(10);
220 $ti->setDisabled(!$this->isEditingAllowed());
221 $form->addItem($ti);
222
225 $form->addItem($mn);
226
229 'mail_notification'
230 );
231 $cron_options = [
234 ];
235 $cron_mail->setOptions($cron_options);
236 $cron_mail->setInfo(sprintf(
238 $this->lng->txt('mail_allow_external')
239 ));
240 $cron_mail->setDisabled(!$this->isEditingAllowed());
241 $form->addItem($cron_mail);
242
245 $form,
246 $this
247 );
248
251 $form->addItem($mn);
252
253 $input = new ilNumberInputGUI($this->lng->txt('mail_auto_responder_idle_time'), 'mail_auto_responder_idle_time');
254 $input->setMinValue(1);
255 $input->allowDecimals(false);
258 $input->setDisabled(!$this->isEditingAllowed());
259 $input->setSize(5);
260 $form->addItem($input);
261
264 }
265
266 return $form;
267 }
static addFieldsToForm(int $a_form_id, ilPropertyFormGUI $a_form, ilObjectGUI $a_parent_gui)
const FORM_MAIL
Definition: class.ilAdministrationSettingsFormHandler.php:36
References ilAdministrationSettingsFormHandler\addFieldsToForm(), ILIAS\Repository\ctrl(), ilAdministrationSettingsFormHandler\FORM_MAIL, isEditingAllowed(), ILIAS\Repository\lng(), and USER_FOLDER_ID.
Referenced by saveObject(), and showGeneralSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getTabs()
|
protected |
@abstract overwrite in derived GUI class of your object type
Reimplemented from ilObjectGUI.
Definition at line 106 of file class.ilObjMailGUI.php.
106 : void
107 {
109 $this->tabs->addTarget(
110 'settings',
112 [
113 'view',
114 'save',
115 '',
116 'showExternalSettingsForm',
117 'saveExternalSettingsForm',
118 'sendTestUserMail',
119 'sendTestSystemMail',
120 ]
121 );
122 }
123
125 $this->tabs->addTarget(
126 'mail_templates',
128 '',
129 ilMailTemplateGUI::class
130 );
131 }
132
134 $this->tabs->addTarget(
135 'perm_settings',
137 ['perm', 'info', 'owner'],
138 ilPermissionGUI::class
139 );
140 }
141 }
isPermissionChangeAllowed()
Definition: class.ilObjMailGUI.php:96
References ILIAS\Repository\ctrl(), isPermissionChangeAllowed(), isViewAllowed(), and ILIAS\Repository\tabs().
Referenced by getAdminTabs().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isEditingAllowed()
|
private |
Definition at line 86 of file class.ilObjMailGUI.php.
86 : bool
87 {
89 }
References ILIAS\Repository\object().
Referenced by buildSignaturePlaceholderInputs(), getExternalSettingsForm(), getGeneralSettingsForm(), saveExternalSettingsFormObject(), and saveObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isPermissionChangeAllowed()
|
private |
Definition at line 96 of file class.ilObjMailGUI.php.
96 : bool
97 {
99 }
References ILIAS\Repository\object().
Referenced by getTabs().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isViewAllowed()
|
private |
Definition at line 91 of file class.ilObjMailGUI.php.
References ILIAS\Repository\object().
Referenced by buildSettingsSubTabs(), executeCommand(), getTabs(), sendTestMail(), showExternalSettingsFormObject(), and showGeneralSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ populateExternalSettingsForm()
|
protected |
Definition at line 599 of file class.ilObjMailGUI.php.
599 : void
600 {
602 if ($subject_prefix === null) {
603 $subject_prefix = ilMimeMail::MAIL_SUBJECT_PREFIX;
604 }
605
606 [$user_signature, $installation_signature] = $this->getAvailableSignatures();
607
608 $form->setValuesByArray([
610 'mail_smtp_host' => $this->settings->get('mail_smtp_host', ''),
611 'mail_smtp_port' => $this->settings->get('mail_smtp_port', ''),
612 'mail_smtp_user' => $this->settings->get('mail_smtp_user', ''),
613 'mail_smtp_password' => $this->settings->get('mail_smtp_password') !== '' ?
614 self::PASSWORD_PLACE_HOLDER :
615 '',
616 'mail_smtp_encryption' => $this->settings->get('mail_smtp_encryption', ''),
617 'mail_subject_prefix' => $subject_prefix,
618 'mail_send_html' => (bool) $this->settings->get('mail_send_html', '0'),
619 'mail_system_usr_from_addr' => $this->settings->get('mail_system_usr_from_addr', ''),
620 'mail_system_usr_from_name' => $this->settings->get('mail_system_usr_from_name', ''),
621 'mail_system_usr_env_from_addr' => $this->settings->get('mail_system_usr_env_from_addr', ''),
622 'mail_system_sys_from_addr' => $this->settings->get('mail_system_sys_from_addr', ''),
623 'mail_system_sys_from_name' => $this->settings->get('mail_system_sys_from_name', ''),
624 $user_signature->getPersistenceIdentifier() => $this->settings->get($user_signature->getPersistenceIdentifier(), ''),
625 'mail_system_sys_reply_to_addr' => $this->settings->get('mail_system_sys_reply_to_addr', ''),
626 'mail_system_sys_env_from_addr' => $this->settings->get('mail_system_sys_env_from_addr', ''),
627 $installation_signature->getPersistenceIdentifier() => $this->settings->get($installation_signature->getPersistenceIdentifier(), ''),
628 'use_global_reply_to_addr' => (bool) $this->settings->get('use_global_reply_to_addr', '0'),
629 'global_reply_to_addr' => $this->settings->get('global_reply_to_addr', ''),
630 ]);
631 }
final const string MAIL_SUBJECT_PREFIX
Definition: class.ilMimeMail.php:25
setValuesByArray(array $a_values, bool $a_restrict_to_value_keys=false)
Definition: class.ilPropertyFormGUI.php:320
References getAvailableSignatures(), ilMimeMail\MAIL_SUBJECT_PREFIX, ILIAS\Repository\settings(), and ilPropertyFormGUI\setValuesByArray().
Referenced by showExternalSettingsFormObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ populateGeneralSettingsForm()
|
protected |
Definition at line 269 of file class.ilObjMailGUI.php.
269 : void
270 {
271 $form->setValuesByArray([
273 'incoming_type' => (string) $this->settings->get('mail_incoming_mail', '0'),
274 'mail_address_option' => $this->settings->get('mail_address_option', '') !== '' ?
275 $this->settings->get('mail_address_option') :
277 'mail_address_option_both' => $this->settings->get('mail_address_option', '') !== '' ?
278 $this->settings->get('mail_address_option') :
280 'show_mail_settings' => (bool) $this->settings->get('show_mail_settings', '1'),
281 'mail_maxsize_attach' => $this->settings->get('mail_maxsize_attach', ''),
282 'mail_notification' => $this->settings->get('mail_notification', ''),
283 'mail_auto_responder_idle_time' => is_numeric($this->settings->get('mail_auto_responder_idle_time', (string) AutoresponderService::AUTO_RESPONDER_DEFAULT_IDLE_TIME)) ?
284 (string) $this->settings->get('mail_auto_responder_idle_time', '3') :
285 '',
286 ]);
287 }
References ilMailOptions\FIRST_EMAIL, ILIAS\Repository\settings(), and ilPropertyFormGUI\setValuesByArray().
Referenced by showGeneralSettingsForm().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ saveExternalSettingsFormObject()
|
protected |
Definition at line 633 of file class.ilObjMailGUI.php.
633 : void
634 {
636 $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
637 }
638
639 $form = $this->getExternalSettingsForm();
640 $is_form_valid = $form->checkInput();
641
642 if (!$is_form_valid) {
643 $form->setValuesByPost();
644 $this->showExternalSettingsFormObject($form);
645 return;
646 }
647
648 $is_smtp_enabled = (bool) $form->getInput('mail_smtp_status');
649 if ($is_smtp_enabled && $form->getInput('mail_smtp_user') &&
650 !$form->getInput('mail_smtp_password')
651 ) {
652 $form->getItemByPostVar('mail_smtp_password')->setRequired(true);
653 $form->getItemByPostVar('mail_smtp_password')
655 $form->setValuesByPost();
656 $this->showExternalSettingsFormObject($form);
657 return;
658 }
659
660 // If all forms in ILIAS use the UI/KS forms (here and in Services/Mail), we should move this to a proper constraint/trafo
662 try {
663 $this->mustache_factory->getBasicEngine()->render((string) $value, []);
664 return true;
665 } catch (Exception) {
666 return false;
667 }
669
670 $valid_templates = true;
671 $availabe_signatures = array_map(
673 $this->getAvailableSignatures()
674 );
675 foreach (
676 ['mail_system_usr_from_name', ...$availabe_signatures] as $template
677 ) {
678 try {
679 $is_valid_template_syntax->check((string) $form->getInput($template));
680 } catch (Exception) {
681 $form->getItemByPostVar($template)->setAlert(
682 $is_valid_template_syntax->problemWith((string) $form->getInput($template))
683 );
684 $valid_templates = false;
685 }
686 }
687 if (!$valid_templates) {
688 $form->setValuesByPost();
689 $this->showExternalSettingsFormObject($form);
690 return;
691 }
692
697 if ($form->getInput('mail_smtp_password') !== self::PASSWORD_PLACE_HOLDER) {
699 }
703 $this->settings->set('mail_system_usr_from_addr', (string) $form->getInput('mail_system_usr_from_addr'));
704 $this->settings->set('mail_system_usr_from_name', (string) $form->getInput('mail_system_usr_from_name'));
705 $this->settings->set(
706 'mail_system_usr_env_from_addr',
707 (string) $form->getInput('mail_system_usr_env_from_addr')
708 );
709 $this->settings->set(
710 'mail_system_sys_from_addr',
711 (string) $form->getInput('mail_system_sys_from_addr')
712 );
713 $this->settings->set('mail_system_sys_from_name', (string) $form->getInput('mail_system_sys_from_name'));
714 $this->settings->set(
715 'mail_system_sys_reply_to_addr',
716 (string) $form->getInput('mail_system_sys_reply_to_addr')
717 );
718 $this->settings->set(
719 'mail_system_sys_env_from_addr',
720 (string) $form->getInput('mail_system_sys_env_from_addr')
721 );
722 $this->settings->set('use_global_reply_to_addr', (string) ((int) $form->getInput('use_global_reply_to_addr')));
724
725 foreach ($availabe_signatures as $availabe_signature) {
726 $this->settings->set(
727 $availabe_signature,
728 (string) $form->getInput($availabe_signature)
729 );
730 }
731
734 }
showExternalSettingsFormObject(?ilPropertyFormGUI $form=null)
Definition: class.ilObjMailGUI.php:322
References ILIAS\Repository\ctrl(), getExternalSettingsForm(), ILIAS\Mail\Signature\Signature\getPersistenceIdentifier(), isEditingAllowed(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and showExternalSettingsFormObject().
Here is the call graph for this function:
◆ saveObject()
| ilObjMailGUI::saveObject | ( | ) |
Reimplemented from ilObjectGUI.
Definition at line 289 of file class.ilObjMailGUI.php.
289 : void
290 {
292 $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
293 }
294
295 $form = $this->getGeneralSettingsForm();
296 if ($form->checkInput()) {
298
299 $mail_address_option = ilMailOptions::FIRST_EMAIL;
302 } elseif ($incoming_type === ilMailOptions::INCOMING_BOTH) {
304 }
305
306 $this->settings->set('mail_allow_external', (string) ((int) $form->getInput('mail_allow_external')));
308 $this->settings->set('show_mail_settings', (string) ((int) $form->getInput('show_mail_settings')));
311 $this->settings->set('mail_notification', (string) ((int) $form->getInput('mail_notification')));
312 $this->settings->set('mail_auto_responder_idle_time', (string) $form->getInput('mail_auto_responder_idle_time'));
313
315 $this->ctrl->redirect($this);
316 }
317
318 $form->setValuesByPost();
319 $this->showGeneralSettingsForm($form);
320 }
showGeneralSettingsForm(?ilPropertyFormGUI $form=null)
Definition: class.ilObjMailGUI.php:169
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().
Here is the call graph for this function:
◆ sendTestMail()
|
protected |
Definition at line 359 of file class.ilObjMailGUI.php.
359 : void
360 {
362 $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
363 }
364
366 $this->showExternalSettingsFormObject();
367 return;
368 }
369
370 if ($is_manual_mail) {
372 } else {
374 }
375
376 $mail->setSaveInSentbox(false);
377 $mail->appendInstallationSignature(!$is_manual_mail);
378
379 $lng_variable_prefix = 'sys';
380 if ($is_manual_mail) {
381 $lng_variable_prefix = 'usr';
382 }
383
384 $mail->enqueue(
385 $this->user->getEmail(),
386 '',
387 '',
388 $this->lng->txt('mail_email_' . $lng_variable_prefix . '_subject'),
389 $this->lng->txt('mail_email_' . $lng_variable_prefix . '_body'),
390 []
391 );
392
394 $this->showExternalSettingsFormObject();
395 }
References ANONYMOUS_USER_ID, isViewAllowed(), ILIAS\Repository\lng(), showExternalSettingsFormObject(), and ILIAS\Repository\user().
Referenced by sendTestSystemMailObject(), and sendTestUserMailObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ sendTestSystemMailObject()
|
protected |
Definition at line 354 of file class.ilObjMailGUI.php.
354 : void
355 {
356 $this->sendTestMail();
357 }
sendTestMail(bool $is_manual_mail=false)
Definition: class.ilObjMailGUI.php:359
References sendTestMail().
Here is the call graph for this function:
◆ sendTestUserMailObject()
|
protected |
Definition at line 349 of file class.ilObjMailGUI.php.
References sendTestMail().
Here is the call graph for this function:
◆ showExternalSettingsFormObject()
|
protected |
Definition at line 322 of file class.ilObjMailGUI.php.
322 : void
323 {
325 $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
326 }
327
328 $this->buildSettingsSubTabs(self::SETTINGS_SUB_TAB_ID_EXTERNAL);
329
330 if ($form === null) {
331 $form = $this->getExternalSettingsForm();
332 $this->populateExternalSettingsForm($form);
333 }
334
336 $this->toolbar->addComponent($this->ui_factory->button()->standard(
337 $this->lng->txt('mail_external_send_test_usr'),
338 $this->ctrl->getLinkTarget($this, 'sendTestUserMail')
339 ));
340 $this->toolbar->addComponent($this->ui_factory->button()->standard(
341 $this->lng->txt('mail_external_send_test_sys'),
342 $this->ctrl->getLinkTarget($this, 'sendTestSystemMail')
343 ));
344 }
345
346 $this->tpl->setContent($form->getHTML());
347 }
buildSettingsSubTabs(string $active_sub_tab)
Definition: class.ilObjMailGUI.php:143
populateExternalSettingsForm(ilPropertyFormGUI $form)
Definition: class.ilObjMailGUI.php:599
References buildSettingsSubTabs(), getExternalSettingsForm(), isViewAllowed(), ILIAS\Repository\lng(), populateExternalSettingsForm(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().
Referenced by saveExternalSettingsFormObject(), and sendTestMail().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ showGeneralSettingsForm()
|
protected |
Definition at line 169 of file class.ilObjMailGUI.php.
169 : void
170 {
172 $this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
173 }
174
175 $this->buildSettingsSubTabs(self::SETTINGS_SUB_TAB_ID_GENERAL);
176
177 if ($form === null) {
178 $form = $this->getGeneralSettingsForm();
179 $this->populateGeneralSettingsForm($form);
180 }
181
182 $this->tpl->setContent($form->getHTML());
183 }
populateGeneralSettingsForm(ilPropertyFormGUI $form)
Definition: class.ilObjMailGUI.php:269
References buildSettingsSubTabs(), getGeneralSettingsForm(), isViewAllowed(), ILIAS\Repository\lng(), and populateGeneralSettingsForm().
Referenced by saveObject(), and viewObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ viewObject()
| ilObjMailGUI::viewObject | ( | ) |
viewObject container presentation for "administration -> repository, trash, permissions"
Reimplemented from ilObjectGUI.
Definition at line 164 of file class.ilObjMailGUI.php.
References showGeneralSettingsForm().
Here is the call graph for this function:
Field Documentation
◆ $mail_signature_service
|
private |
Definition at line 38 of file class.ilObjMailGUI.php.
◆ $mustache_factory
|
private |
Definition at line 37 of file class.ilObjMailGUI.php.
◆ $tabs
|
private |
Definition at line 36 of file class.ilObjMailGUI.php.
◆ PASSWORD_PLACE_HOLDER
|
private |
Definition at line 34 of file class.ilObjMailGUI.php.
◆ SETTINGS_SUB_TAB_ID_EXTERNAL
|
private |
Definition at line 33 of file class.ilObjMailGUI.php.
◆ SETTINGS_SUB_TAB_ID_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
