19 declare(strict_types=1);
40 public function __construct($a_data,
int $a_id,
bool $a_call_by_reference)
46 $this->
tabs = $DIC->tabs();
47 $this->mustache_factory = $DIC->mail()->mustacheFactory();
48 $this->mail_signature_service = $DIC->mail()->signature();
50 $this->
lng->loadLanguageModule(
'mail');
55 $next_class = $this->
ctrl->getNextClass($this) ??
'';
56 $cmd = $this->
ctrl->getCmd();
59 switch (strtolower($next_class)) {
60 case strtolower(ilPermissionGUI::class):
62 $this->
ctrl->forwardCommand($perm_gui);
65 case strtolower(ilMailTemplateGUI::class):
67 $this->
ilias->raiseError(
68 $this->
lng->txt(
'msg_no_perm_write'),
69 $this->
ilias->error_obj->WARNING
88 return $this->rbac_system->checkAccess(
'write', $this->
object->getRefId());
93 return $this->rbac_system->checkAccess(
'read', $this->
object->getRefId());
98 return $this->rbac_system->checkAccess(
'edit_permission', $this->
object->getRefId());
109 $this->
tabs->addTarget(
111 $this->
ctrl->getLinkTarget($this,
'view'),
116 'showExternalSettingsForm',
117 'saveExternalSettingsForm',
119 'sendTestSystemMail',
125 $this->
tabs->addTarget(
127 $this->
ctrl->getLinkTargetByClass(ilMailTemplateGUI::class,
'showTemplates'),
129 ilMailTemplateGUI::class
134 $this->
tabs->addTarget(
136 $this->
ctrl->getLinkTargetByClass([static::class, ilPermissionGUI::class],
'perm'),
137 [
'perm',
'info',
'owner'],
138 ilPermissionGUI::class
146 $this->
tabs->addSubTab(
147 self::SETTINGS_SUB_TAB_ID_GENERAL,
148 $this->
lng->txt(
'mail_settings_general_tab'),
149 $this->
ctrl->getLinkTarget($this,
'view')
152 if ($this->
settings->get(
'mail_allow_external',
'0')) {
153 $this->
tabs->addSubTab(
154 self::SETTINGS_SUB_TAB_ID_EXTERNAL,
155 $this->
lng->txt(
'mail_settings_external_tab'),
156 $this->
ctrl->getLinkTarget($this,
'showExternalSettingsForm')
160 $this->
tabs->activateSubTab($active_sub_tab);
172 $this->
ilias->raiseError($this->
lng->txt(
'msg_no_perm_write'), $this->
ilias->error_obj->WARNING);
177 if ($form ===
null) {
182 $this->tpl->setContent($form->getHTML());
189 $form->setFormAction($this->
ctrl->getFormAction($this,
'save'));
190 $form->setTitle($this->
lng->txt(
'general_settings'));
193 $cb->setInfo($this->
lng->txt(
'mail_allow_external_info'));
199 $this->
lng->txt(
'mail_incoming'),
203 $this->
ctrl->setParameterByClass(ilObjUserFolderGUI::class,
'ref_id',
USER_FOLDER_ID);
204 $incoming_mail_gui->setInfo(sprintf(
205 $this->
lng->txt(
'mail_settings_incoming_type_see_also'),
206 $this->
ctrl->getLinkTargetByClass(ilObjUserFolderGUI::class,
'settings')
208 $this->
ctrl->clearParametersByClass(ilObjUserFolderGUI::class);
209 $form->addItem($incoming_mail_gui);
212 $this->
lng->txt(
'show_mail_settings'),
215 $show_mail_settings_gui->setInfo($this->
lng->txt(
'show_mail_settings_info'));
216 $show_mail_settings_gui->setValue(
'1');
217 $form->addItem($show_mail_settings_gui);
221 $ti->setInfo($this->
lng->txt(
'mail_max_size_attachments_total'));
222 $ti->setMaxLength(10);
228 $mn->setTitle($this->
lng->txt(
'mail_member_notification'));
232 $this->
lng->txt(
'cron_mail_notification'),
236 0 => $this->
lng->txt(
'cron_mail_notification_never'),
237 1 => $this->
lng->txt(
'cron_mail_notification_cron'),
240 $cron_mail->setInfo(sprintf(
241 $this->
lng->txt(
'cron_mail_notification_desc'),
242 $this->
lng->txt(
'mail_allow_external')
245 $form->addItem($cron_mail);
254 $mn->setTitle($this->
lng->txt(
'mail_auto_responder'));
257 $input =
new ilNumberInputGUI($this->
lng->txt(
'mail_auto_responder_idle_time'),
'mail_auto_responder_idle_time');
259 $input->allowDecimals(
false);
260 $input->setInfo($this->
lng->txt(
'mail_auto_responder_idle_time_info'));
261 $input->setSuffix($this->
lng->txt(
'days'));
264 $form->addItem($input);
267 $form->addCommandButton(
'save', $this->
lng->txt(
'save'));
276 'mail_allow_external' => (
bool) $this->
settings->get(
'mail_allow_external',
'0'),
277 'incoming_type' => (string) $this->
settings->get(
'mail_incoming_mail',
'0'),
278 'mail_address_option' => $this->
settings->get(
'mail_address_option',
'') !==
'' ?
279 $this->
settings->get(
'mail_address_option') :
281 'mail_address_option_both' => $this->
settings->get(
'mail_address_option',
'') !==
'' ?
282 $this->
settings->get(
'mail_address_option') :
284 'show_mail_settings' => (
bool) $this->
settings->get(
'show_mail_settings',
'1'),
285 'mail_maxsize_attach' => $this->
settings->get(
'mail_maxsize_attach',
''),
286 'mail_notification' => $this->
settings->get(
'mail_notification',
''),
287 'mail_auto_responder_idle_time' => is_numeric($this->
settings->get(
'mail_auto_responder_idle_time', (
string) AutoresponderService::AUTO_RESPONDER_DEFAULT_IDLE_TIME)) ?
288 (
string) $this->
settings->get(
'mail_auto_responder_idle_time',
'3') :
296 $this->
ilias->raiseError($this->
lng->txt(
'msg_no_perm_write'), $this->
ilias->error_obj->WARNING);
300 if ($form->checkInput()) {
301 $incoming_type = (
int) $form->getInput(
'incoming_type');
305 $mail_address_option = (
int) $form->getInput(
'mail_address_option');
307 $mail_address_option = (
int) $form->getInput(
'mail_address_option_both');
310 $this->
settings->set(
'mail_allow_external', (
string) ((
int) $form->getInput(
'mail_allow_external')));
311 $this->
settings->set(
'mail_incoming_mail', (
string) $incoming_type);
312 $this->
settings->set(
'show_mail_settings', (
string) ((
int) $form->getInput(
'show_mail_settings')));
313 $this->
settings->set(
'mail_address_option', (
string) $mail_address_option);
314 $this->
settings->set(
'mail_maxsize_attach', (
string) $form->getInput(
'mail_maxsize_attach'));
315 $this->
settings->set(
'mail_notification', (
string) ((
int) $form->getInput(
'mail_notification')));
316 $this->
settings->set(
'mail_auto_responder_idle_time', (
string) $form->getInput(
'mail_auto_responder_idle_time'));
318 $this->tpl->setOnScreenMessage(
'success', $this->
lng->txt(
'saved_successfully'),
true);
319 $this->
ctrl->redirect($this);
322 $form->setValuesByPost();
329 $this->
ilias->raiseError($this->
lng->txt(
'msg_no_perm_write'), $this->
ilias->error_obj->WARNING);
334 if ($form ===
null) {
339 if ($this->
user->getEmail() !==
'') {
340 $this->
toolbar->addComponent($this->ui_factory->button()->standard(
341 $this->
lng->txt(
'mail_external_send_test_usr'),
342 $this->
ctrl->getLinkTarget($this,
'sendTestUserMail')
344 $this->
toolbar->addComponent($this->ui_factory->button()->standard(
345 $this->
lng->txt(
'mail_external_send_test_sys'),
346 $this->
ctrl->getLinkTarget($this,
'sendTestSystemMail')
350 $this->tpl->setContent($form->getHTML());
366 $this->
ilias->raiseError($this->
lng->txt(
'msg_no_perm_write'), $this->
ilias->error_obj->WARNING);
369 if ($this->
user->getEmail() ===
'') {
374 if ($is_manual_mail) {
380 $mail->setSaveInSentbox(
false);
381 $mail->appendInstallationSignature(!$is_manual_mail);
383 $lng_variable_prefix =
'sys';
384 if ($is_manual_mail) {
385 $lng_variable_prefix =
'usr';
389 $this->
user->getEmail(),
392 $this->
lng->txt(
'mail_email_' . $lng_variable_prefix .
'_subject'),
393 $this->
lng->txt(
'mail_email_' . $lng_variable_prefix .
'_body'),
397 $this->tpl->setOnScreenMessage(
'success', $this->
lng->txt(
'mail_external_test_sent'));
405 $form->setFormAction($this->
ctrl->getFormAction($this,
'saveExternalSettingsForm'));
406 $form->setTitle($this->
lng->txt(
'mail_settings_external_frm_head'));
409 $smtp->setInfo($this->
lng->txt(
'mail_smtp_status_info'));
410 $smtp->setValue(
'1');
412 $form->addItem($smtp);
415 $host->setInfo($this->
lng->txt(
'mail_smtp_host_info'));
416 $host->setRequired(
true);
418 $smtp->addSubItem($host);
421 $port->
setInfo($this->
lng->txt(
'mail_smtp_port_info'));
422 $port->allowDecimals(
false);
423 $port->setMinValue(0);
424 $port->setMinValue(0);
425 $port->setRequired(
true);
427 $smtp->addSubItem($port);
430 $this->
lng->txt(
'mail_smtp_encryption'),
431 'mail_smtp_encryption' 433 $encryption_options = [
434 '' => $this->
lng->txt(
'please_choose'),
435 'tls' => $this->
lng->txt(
'mail_smtp_encryption_tls'),
436 'ssl' => $this->
lng->txt(
'mail_smtp_encryption_ssl'),
441 $smtp->addSubItem($encryption);
445 $user->setDisableHtmlAutoComplete(
true);
446 $smtp->addSubItem(
$user);
449 $this->
lng->txt(
'mail_smtp_password'),
453 $password->setSkipSyntaxCheck(
true);
455 $password->setDisableHtmlAutoComplete(
true);
456 $smtp->addSubItem($password);
458 $pre =
new ilTextInputGUI($this->
lng->txt(
'mail_subject_prefix'),
'mail_subject_prefix');
460 $pre->setMaxLength(32);
461 $pre->setInfo($this->
lng->txt(
'mail_subject_prefix_info'));
463 $form->addItem($pre);
466 $send_html->setInfo($this->
lng->txt(
'mail_send_html_info'));
467 $send_html->setValue(
'1');
469 $form->addItem($send_html);
472 $sh->setTitle($this->
lng->txt(
'mail_settings_user_frm_head'));
476 $this->
lng->txt(
'mail_system_usr_from_addr'),
477 'mail_system_usr_from_addr' 479 $user_from_address->
setInfo($this->
lng->txt(
'mail_system_usr_from_addr_info'));
480 $user_from_address->setRequired(
true);
482 $form->addItem($user_from_address);
485 $this->
lng->txt(
'mail_use_global_reply_to_addr'),
486 'use_global_reply_to_addr' 488 $use_global_reply_to_address->setInfo($this->
lng->txt(
'mail_use_global_reply_to_addr_info'));
489 $use_global_reply_to_address->setValue(
'1');
491 $form->addItem($use_global_reply_to_address);
493 $this->
lng->txt(
'mail_global_reply_to_addr'),
494 'global_reply_to_addr' 496 $global_reply_to->
setInfo($this->
lng->txt(
'mail_global_reply_to_addr_info'));
497 $global_reply_to->setRequired(
true);
499 $use_global_reply_to_address->addSubItem($global_reply_to);
502 $this->
lng->txt(
'mail_system_usr_from_name'),
503 'mail_system_usr_from_name' 505 $user_from_name->setInfo($this->
lng->txt(
'mail_system_usr_from_name_info'));
506 $user_from_name->setRequired(
true);
508 $form->addItem($user_from_name);
511 $this->
lng->txt(
'mail_system_usr_env_from_addr'),
512 'mail_system_usr_env_from_addr' 514 $user_envelope_from_addr->
setInfo($this->
lng->txt(
'mail_system_usr_env_from_addr_info'));
516 $form->addItem($user_envelope_from_addr);
518 [$user_signature_inputs, $installation_signature_inputs] =
array_map(
522 foreach ($user_signature_inputs as $user_signature_input) {
523 $form->addItem($user_signature_input);
527 $sh->setTitle($this->
lng->txt(
'mail_settings_system_frm_head'));
531 $this->
lng->txt(
'mail_system_sys_from_addr'),
532 'mail_system_sys_from_addr' 534 $system_from_addr->
setInfo($this->
lng->txt(
'mail_system_sys_from_addr_info'));
535 $system_from_addr->setRequired(
true);
537 $form->addItem($system_from_addr);
540 $this->
lng->txt(
'mail_system_sys_from_name'),
541 'mail_system_sys_from_name' 543 $system_from_name->setRequired(
true);
545 $form->addItem($system_from_name);
548 $this->
lng->txt(
'mail_system_sys_reply_to_addr'),
549 'mail_system_sys_reply_to_addr' 553 $form->addItem($system_reply_to_addr);
556 $this->
lng->txt(
'mail_system_sys_env_from_addr'),
557 'mail_system_sys_env_from_addr' 559 $system_return_path->
setInfo($this->
lng->txt(
'mail_system_sys_env_from_addr_info'));
561 $form->addItem($system_return_path);
563 foreach ($installation_signature_inputs as $installation_signature_input) {
564 $form->addItem($installation_signature_input);
568 $form->addCommandButton(
'saveExternalSettingsForm', $this->
lng->txt(
'save'));
587 $this->
lng->txt(
'mail_form_placeholders_label'),
593 $placeholder = $this->mail_signature_service->getPlaceholder();
595 if ($signature->
supports($placeholder)) {
596 $placeholder_input->addPlaceholder($placeholder->getId(), $placeholder->getLabel());
598 }
while ($placeholder = $placeholder->getNext());
600 return [$signature_input, $placeholder_input];
605 $subject_prefix = $this->
settings->get(
'mail_subject_prefix');
606 if ($subject_prefix ===
null) {
613 'mail_smtp_status' => (
bool) $this->
settings->get(
'mail_smtp_status',
'0'),
614 'mail_smtp_host' => $this->
settings->get(
'mail_smtp_host',
''),
615 'mail_smtp_port' => $this->
settings->get(
'mail_smtp_port',
''),
616 'mail_smtp_user' => $this->
settings->get(
'mail_smtp_user',
''),
617 'mail_smtp_password' => $this->
settings->get(
'mail_smtp_password') !==
'' ?
618 self::PASSWORD_PLACE_HOLDER :
620 'mail_smtp_encryption' => $this->
settings->get(
'mail_smtp_encryption',
''),
621 'mail_subject_prefix' => $subject_prefix,
622 'mail_send_html' => (bool) $this->
settings->get(
'mail_send_html',
'0'),
623 'mail_system_usr_from_addr' => $this->
settings->get(
'mail_system_usr_from_addr',
''),
624 'mail_system_usr_from_name' => $this->
settings->get(
'mail_system_usr_from_name',
''),
625 'mail_system_usr_env_from_addr' => $this->
settings->get(
'mail_system_usr_env_from_addr',
''),
626 'mail_system_sys_from_addr' => $this->
settings->get(
'mail_system_sys_from_addr',
''),
627 'mail_system_sys_from_name' => $this->
settings->get(
'mail_system_sys_from_name',
''),
628 $user_signature->getPersistenceIdentifier() => $this->
settings->get($user_signature->getPersistenceIdentifier(),
''),
629 'mail_system_sys_reply_to_addr' => $this->
settings->get(
'mail_system_sys_reply_to_addr',
''),
630 'mail_system_sys_env_from_addr' => $this->
settings->get(
'mail_system_sys_env_from_addr',
''),
631 $installation_signature->getPersistenceIdentifier() => $this->
settings->get($installation_signature->getPersistenceIdentifier(),
''),
632 'use_global_reply_to_addr' => (
bool) $this->
settings->get(
'use_global_reply_to_addr',
'0'),
633 'global_reply_to_addr' => $this->
settings->get(
'global_reply_to_addr',
''),
640 $this->
ilias->raiseError($this->
lng->txt(
'msg_no_perm_write'), $this->
ilias->error_obj->WARNING);
644 $is_form_valid = $form->checkInput();
646 if (!$is_form_valid) {
647 $form->setValuesByPost();
652 $is_smtp_enabled = (bool) $form->getInput(
'mail_smtp_status');
653 if ($is_smtp_enabled && $form->getInput(
'mail_smtp_user') &&
654 !$form->getInput(
'mail_smtp_password')
656 $form->getItemByPostVar(
'mail_smtp_password')->setRequired(
true);
657 $form->getItemByPostVar(
'mail_smtp_password')
658 ->setAlert($this->
lng->txt(
'mail_smtp_password_req'));
659 $form->setValuesByPost();
665 $is_valid_template_syntax = $this->
refinery->custom()->constraint(
function ($value):
bool {
667 $this->mustache_factory->getBasicEngine()->render((
string) $value, []);
672 }, $this->
lng->txt(
'mail_template_invalid_tpl_syntax'));
674 $valid_templates =
true;
680 [
'mail_system_usr_from_name', ...$availabe_signatures] as $template
683 $is_valid_template_syntax->check((
string) $form->getInput($template));
685 $form->getItemByPostVar($template)->setAlert(
686 $is_valid_template_syntax->problemWith((
string) $form->getInput($template))
688 $valid_templates =
false;
691 if (!$valid_templates) {
692 $form->setValuesByPost();
697 $this->
settings->set(
'mail_smtp_status', (
string) ((
int) $form->getInput(
'mail_smtp_status')));
698 $this->
settings->set(
'mail_smtp_host', (
string) $form->getInput(
'mail_smtp_host'));
699 $this->
settings->set(
'mail_smtp_port', (
string) ((
int) $form->getInput(
'mail_smtp_port')));
700 $this->
settings->set(
'mail_smtp_user', (
string) $form->getInput(
'mail_smtp_user'));
701 if ($form->getInput(
'mail_smtp_password') !== self::PASSWORD_PLACE_HOLDER) {
702 $this->
settings->set(
'mail_smtp_password', (
string) $form->getInput(
'mail_smtp_password'));
704 $this->
settings->set(
'mail_smtp_encryption', (
string) $form->getInput(
'mail_smtp_encryption'));
705 $this->
settings->set(
'mail_send_html', (
string) $form->getInput(
'mail_send_html'));
706 $this->
settings->set(
'mail_subject_prefix', (
string) $form->getInput(
'mail_subject_prefix'));
707 $this->
settings->set(
'mail_system_usr_from_addr', (
string) $form->getInput(
'mail_system_usr_from_addr'));
708 $this->
settings->set(
'mail_system_usr_from_name', (
string) $form->getInput(
'mail_system_usr_from_name'));
710 'mail_system_usr_env_from_addr',
711 (
string) $form->getInput(
'mail_system_usr_env_from_addr')
714 'mail_system_sys_from_addr',
715 (
string) $form->getInput(
'mail_system_sys_from_addr')
717 $this->
settings->set(
'mail_system_sys_from_name', (
string) $form->getInput(
'mail_system_sys_from_name'));
719 'mail_system_sys_reply_to_addr',
720 (
string) $form->getInput(
'mail_system_sys_reply_to_addr')
723 'mail_system_sys_env_from_addr',
724 (
string) $form->getInput(
'mail_system_sys_env_from_addr')
726 $this->
settings->set(
'use_global_reply_to_addr', (
string) ((
int) $form->getInput(
'use_global_reply_to_addr')));
727 $this->
settings->set(
'global_reply_to_addr', (
string) $form->getInput(
'global_reply_to_addr'));
729 foreach ($availabe_signatures as $availabe_signature) {
732 (
string) $form->getInput($availabe_signature)
736 $this->tpl->setOnScreenMessage(
'success', $this->
lng->txt(
'saved_successfully'),
true);
737 $this->
ctrl->redirect($this,
'showExternalSettingsForm');
740 public static function _goto(
string $target): void
743 $main_tpl = $DIC->ui()->mainTemplate();
745 $mail =
new ilMail($DIC->user()->getId());
747 if ($DIC->rbac()->system()->checkAccess(
'internal_mail', $mail->getMailObjectReferenceId())) {
748 $DIC->ctrl()->redirectToURL(
'ilias.php?baseClass=ilMailGUI');
749 } elseif ($DIC->access()->checkAccess(
'read',
'',
ROOT_FOLDER_ID)) {
750 $main_tpl->setOnScreenMessage(
'failure', sprintf(
751 $DIC->language()->txt(
'msg_no_perm_read_item'),
755 $DIC->ctrl()->setTargetScript(
'ilias.php');
756 $DIC->ctrl()->setParameterByClass(ilRepositoryGUI::class,
'ref_id',
ROOT_FOLDER_ID);
757 $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class);
760 $DIC[
'ilErr']->raiseError($DIC->language()->txt(
'msg_no_perm_read'), $DIC[
'ilErr']->FATAL);
const string SETTINGS_SUB_TAB_ID_EXTERNAL
final const int INCOMING_BOTH
showGeneralSettingsForm(?ilPropertyFormGUI $form=null)
buildSettingsSubTabs(string $active_sub_tab)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
ilMailTemplateGUI: ilObjMailGUI
populateGeneralSettingsForm(ilPropertyFormGUI $form)
prepareOutput(bool $show_sub_objects=true)
readonly ilMustacheFactory $mustache_factory
isPermissionChangeAllowed()
supports(Placeholder $placeholder)
sendTestMail(bool $is_manual_mail=false)
final const int INCOMING_EMAIL
ilObjMailGUI: ilPermissionGUI
static _goto(string $target)
static _lookupObjId(int $ref_id)
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
buildSignaturePlaceholderInputs(Signature $signature)
sendTestSystemMailObject()
saveExternalSettingsFormObject()
const string SETTINGS_SUB_TAB_ID_GENERAL
final const string MAIL_SUBJECT_PREFIX
__construct($a_data, int $a_id, bool $a_call_by_reference)
static _lookupTitle(int $obj_id)
Class ilObjectGUI Basic methods of all Output classes.
showExternalSettingsFormObject(?ilPropertyFormGUI $form=null)
Class ilObjForumAdministration.
readonly MailSignatureService $mail_signature_service
__construct(Container $dic, ilPlugin $plugin)
getPersistenceIdentifier()
This class represents a text area property in a property form.
getExternalSettingsForm()
populateExternalSettingsForm(ilPropertyFormGUI $form)
final const int FIRST_EMAIL
const string PASSWORD_PLACE_HOLDER