ilObjMailGUI Class Reference

Inheritance diagram for ilObjMailGUI:

Collaboration diagram for ilObjMailGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)
	ilObjMailGUI constructor. More...
	executeCommand ()
	getAdminTabs ()
	viewObject ()
	saveObject ()
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Static Public Member Functions
static	_goto ($a_target)
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
const	SETTINGS_SUB_TAB_ID_GENERAL = 1
const	SETTINGS_SUB_TAB_ID_EXTERNAL = 2
const	PASSWORD_PLACE_HOLDER = '***********************'
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	getTabs ()
	buildSettingsSubTabs ($activeSubTab)
	showGeneralSettingsForm (ilPropertyFormGUI $form=null)
	getGeneralSettingsForm ()
	populateGeneralSettingsForm (ilPropertyFormGUI $form)
	showExternalSettingsFormObject (ilPropertyFormGUI $form=null)
	sendTestUserMailObject ()
	sendTestSystemMailObject ()
	sendTestMail ($is_manual_mail=false)
	getExternalSettingsForm ()
	populateExternalSettingsForm (ilPropertyFormGUI $form)
	saveExternalSettingsFormObject ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$tabs
	$rbacsystem
	$settings
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Private Member Functions
	isEditingAllowed ()
	isViewAllowed ()
	isPermissionChangeAllowed ()

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de ilObjMailGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

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

ilObjMailGUI constructor.

Parameters

	$a_data
int	$a_id
bool	$a_call_by_reference

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

References $DIC, and settings().

    {
        global $DIC;

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

        $this->tabs = $DIC->tabs();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->settings = $DIC['ilSetting'];

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

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjMailGUI::_goto (   $a_target )

static

Parameters

string

$a_target

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

References $_GET, $DIC, ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, ilUtil\redirect(), and ilUtil\sendFailure().

    {
        global $DIC;

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

        if ($DIC->rbac()->system()->checkAccess('internal_mail', $mail->getMailObjectReferenceId())) {
            ilUtil::redirect('ilias.php?baseClass=ilMailGUI');
        } else {
            if ($DIC->access()->checkAccess('read', '', ROOT_FOLDER_ID)) {
                $_GET['cmd'] = 'frameset';
                $_GET['target'] = '';
                $_GET['ref_id'] = ROOT_FOLDER_ID;
                $_GET['baseClass'] = 'ilRepositoryGUI';
                ilUtil::sendFailure(
                    sprintf(
                        $DIC->language()->txt('msg_no_perm_read_item'),
                        ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
                    ),
                    true
                );

                include 'ilias.php';
                exit();
            }
        }

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

Here is the call graph for this function:

buildSettingsSubTabs()

ilObjMailGUI::buildSettingsSubTabs (   $activeSubTab )

protected

Parameters

int

$activeSubTab

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

References isViewAllowed(), and settings().

Referenced by showExternalSettingsFormObject(), and showGeneralSettingsForm().

    {
        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')) {
                $this->tabs->addSubTab(
                    self::SETTINGS_SUB_TAB_ID_EXTERNAL,
                    $this->lng->txt('mail_settings_external_tab'),
                    $this->ctrl->getLinkTarget($this, 'showExternalSettingsForm')
                );
            }

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjMailGUI::executeCommand

(

)

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

References isViewAllowed(), and ilObjectGUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

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

            case 'ilmailtemplategui':
                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;
        }

        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjMailGUI::getAdminTabs

(

)

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

References getTabs().

    {
        $this->getTabs();
    }

Here is the call graph for this function:

getExternalSettingsForm()

ilObjMailGUI::getExternalSettingsForm ( )

protected

Returns

ilPropertyFormGUI

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

References $form, $key, $password, ilObjectGUI\$user, isEditingAllowed(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setRows(), and ilTextInputGUI\setSize().

Referenced by saveExternalSettingsFormObject(), and showExternalSettingsFormObject().

    {
        $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');
        $encryptionOptions = array(
            '' => $this->lng->txt('please_choose'),
            'tls' => $this->lng->txt('mail_smtp_encryption_tls'),
            'ssl' => $this->lng->txt('mail_smtp_encryption_ssl')
        );

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

        $user = new ilTextInputGUI($this->lng->txt('mail_smtp_user'), 'mail_smtp_user');
        $user->setDisabled(!$this->isEditingAllowed());
        $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());
        $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);

        $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);

        $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);

        $signature = new ilTextAreaInputGUI($this->lng->txt('mail_system_sys_signature'), 'mail_system_sys_signature');
        $signature->setRows(8);
        $signature->setDisabled(!$this->isEditingAllowed());
        $form->addItem($signature);

        $placeholders = new ilManualPlaceholderInputGUI('mail_system_sys_signature');
        foreach (array(
                     array('placeholder' => 'CLIENT_NAME', 'label' => $this->lng->txt('mail_nacc_client_name')),
                     array('placeholder' => 'CLIENT_DESC', 'label' => $this->lng->txt('mail_nacc_client_desc')),
                     array('placeholder' => 'CLIENT_URL', 'label' => $this->lng->txt('mail_nacc_ilias_url'))
                 ) as $key => $value) {
            $placeholders->addPlaceholder($value['placeholder'], $value['label']);
        }
        $placeholders->setDisabled(!$this->isEditingAllowed());
        $form->addItem($placeholders);

        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

Returns

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

References $form, ilAdministrationSettingsFormHandler\addFieldsToForm(), ilAdministrationSettingsFormHandler\FORM_MAIL, isEditingAllowed(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilNumberInputGUI\setSuffix(), and USER_FOLDER_ID.

Referenced by saveObject(), and showGeneralSettingsForm().

    {
        $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);
        
        include_once 'Services/Mail/classes/Form/class.ilIncomingMailInputGUI.php';
        $incoming_mail_gui = new ilIncomingMailInputGUI($this->lng->txt('mail_incoming'), 'incoming_type');
        $incoming_mail_gui->setDisabled(!$this->isEditingAllowed());
        $this->ctrl->setParameterByClass('ilobjuserfoldergui', 'ref_id', USER_FOLDER_ID);
        $incoming_mail_gui->setInfo(sprintf(
            $this->lng->txt('mail_settings_incoming_type_see_also'),
            $this->ctrl->getLinkTargetByClass('ilobjuserfoldergui', 'settings')
        ));
        $this->ctrl->clearParametersByClass('ilobjuserfoldergui');
        $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 = array(
            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
        );

        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 121 of file class.ilObjMailGUI.php.

References isPermissionChangeAllowed(), and isViewAllowed().

Referenced by getAdminTabs().

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

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

        if ($this->isPermissionChangeAllowed()) {
            $this->tabs->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilpermissiongui'), 'perm'),
                array('perm', 'info', 'owner'),
                'ilpermissiongui'
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isEditingAllowed()

ilObjMailGUI::isEditingAllowed ( )

private

Returns

bool

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

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

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

Here is the caller graph for this function:

isPermissionChangeAllowed()

ilObjMailGUI::isPermissionChangeAllowed ( )

private

Returns

bool

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

Referenced by getTabs().

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

Here is the caller graph for this function:

isViewAllowed()

ilObjMailGUI::isViewAllowed ( )

private

Returns

bool

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

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

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

Here is the caller graph for this function:

populateExternalSettingsForm()

ilObjMailGUI::populateExternalSettingsForm ( ilPropertyFormGUI  $form )

protected

Parameters

ilPropertyFormGUI

$form

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

References ilMail\MAIL_SUBJECT_PREFIX, settings(), and ilPropertyFormGUI\setValuesByArray().

Referenced by showExternalSettingsFormObject().

    {
        $subjectPrefix = $this->settings->get('mail_subject_prefix');
        if (false === $subjectPrefix) {
            $subjectPrefix = ilMail::MAIL_SUBJECT_PREFIX;
        }

        $form->setValuesByArray(array(
            'mail_smtp_status' => (bool) $this->settings->get('mail_smtp_status'),
            'mail_smtp_host' => $this->settings->get('mail_smtp_host'),
            'mail_smtp_port' => (int) $this->settings->get('mail_smtp_port'),
            'mail_smtp_user' => $this->settings->get('mail_smtp_user'),
            'mail_smtp_password' => strlen($this->settings->get('mail_smtp_password')) > 0 ? self::PASSWORD_PLACE_HOLDER : '',
            'mail_smtp_encryption' => $this->settings->get('mail_smtp_encryption'),
            'mail_subject_prefix' => $subjectPrefix,
            'mail_send_html' => (int) $this->settings->get('mail_send_html'),
            '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'),
            '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'),
            'mail_system_sys_signature' => $this->settings->get('mail_system_sys_signature')
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateGeneralSettingsForm()

ilObjMailGUI::populateGeneralSettingsForm ( ilPropertyFormGUI  $form )

protected

Parameters

ilPropertyFormGUI

$form

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

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

Referenced by showGeneralSettingsForm().

    {
        $form->setValuesByArray(array(
            'mail_allow_external' => $this->settings->get('mail_allow_external'),
            'incoming_type' => (int) $this->settings->get('mail_incoming_mail'),
            'mail_address_option' => strlen($this->settings->get('mail_address_option')) ? $this->settings->get('mail_address_option') : ilMailOptions::FIRST_EMAIL,
            'mail_address_option_both' => strlen($this->settings->get('mail_address_option')) ? $this->settings->get('mail_address_option') : ilMailOptions::FIRST_EMAIL,
            'show_mail_settings' => $this->settings->get('show_mail_settings', 1),
            'mail_maxsize_attach' => $this->settings->get('mail_maxsize_attach'),
            'mail_notification' => $this->settings->get('mail_notification')
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveExternalSettingsFormObject()

ilObjMailGUI::saveExternalSettingsFormObject ( )

protected

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

References $form, getExternalSettingsForm(), isEditingAllowed(), settings(), and showExternalSettingsFormObject().

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

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

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

        $isSmtpEnabled = (bool) $form->getInput('mail_smtp_status');
        if ($isSmtpEnabled && $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;
        }

        $this->settings->set('mail_smtp_status', (int) $form->getInput('mail_smtp_status'));
        $this->settings->set('mail_smtp_host', $form->getInput('mail_smtp_host'));
        $this->settings->set('mail_smtp_port', (int) $form->getInput('mail_smtp_port'));
        $this->settings->set('mail_smtp_user', $form->getInput('mail_smtp_user'));
        if ($form->getInput('mail_smtp_password') != self::PASSWORD_PLACE_HOLDER) {
            $this->settings->set('mail_smtp_password', $form->getInput('mail_smtp_password'));
        }
        $this->settings->set('mail_smtp_encryption', $form->getInput('mail_smtp_encryption'));

        $this->settings->set('mail_send_html', $form->getInput('mail_send_html'));
        $this->settings->set('mail_subject_prefix', $form->getInput('mail_subject_prefix'));
        $this->settings->set('mail_system_usr_from_addr', $form->getInput('mail_system_usr_from_addr'));
        $this->settings->set('mail_system_usr_from_name', $form->getInput('mail_system_usr_from_name'));
        $this->settings->set('mail_system_usr_env_from_addr', $form->getInput('mail_system_usr_env_from_addr'));
        $this->settings->set('mail_system_sys_from_addr', $form->getInput('mail_system_sys_from_addr'));
        $this->settings->set('mail_system_sys_from_name', $form->getInput('mail_system_sys_from_name'));
        $this->settings->set('mail_system_sys_reply_to_addr', $form->getInput('mail_system_sys_reply_to_addr'));
        $this->settings->set('mail_system_sys_env_from_addr', $form->getInput('mail_system_sys_env_from_addr'));
        $this->settings->set('mail_system_sys_signature', $form->getInput('mail_system_sys_signature'));

        ilUtil::sendSuccess($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 300 of file class.ilObjMailGUI.php.

References $form, ilMailOptions\FIRST_EMAIL, getGeneralSettingsForm(), ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, isEditingAllowed(), settings(), and showGeneralSettingsForm().

    {
        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');
            } else {
                if ($incoming_type == ilMailOptions::INCOMING_BOTH) {
                    $mail_address_option = (int) $form->getInput('mail_address_option_both');
                }
            }

            $this->settings->set('mail_allow_external', (int) $form->getInput('mail_allow_external'));
            $this->settings->set('mail_incoming_mail', $incoming_type);
            $this->settings->set('show_mail_settings', (int) $form->getInput('show_mail_settings'));

            $this->settings->set('mail_address_option', $mail_address_option);
            $this->settings->set('mail_maxsize_attach', $form->getInput('mail_maxsize_attach'));
            $this->settings->set('mail_notification', (int) $form->getInput('mail_notification'));

            ilUtil::sendSuccess($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 (   $is_manual_mail = false )

protected

Parameters

bool

$is_manual_mail

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

References $GLOBALS, $type, isViewAllowed(), showExternalSettingsFormObject(), and user().

Referenced by sendTestSystemMailObject(), and sendTestUserMailObject().

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

        if (strlen($GLOBALS['DIC']->user()->getEmail()) == 0) {
            return $this->showExternalSettingsFormObject();
        }

        if ($is_manual_mail) {
            $mail = new ilMail($GLOBALS['DIC']->user()->getId());
            $type = array('normal');
        } else {
            $mail = new ilMail(ANONYMOUS_USER_ID);
            $type = array('system');
        }

        $mail->setSaveInSentbox(false);
        $mail->appendInstallationSignature(true);
        $mail->sendMail($GLOBALS['DIC']->user()->getEmail(), '', '', 'Test Subject', 'Test Body', array(), $type);

        ilUtil::sendSuccess($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 371 of file class.ilObjMailGUI.php.

References sendTestMail().

    {
        $this->sendTestMail();
    }

Here is the call graph for this function:

sendTestUserMailObject()

ilObjMailGUI::sendTestUserMailObject ( )

protected

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

References sendTestMail().

    {
        $this->sendTestMail(true);
    }

Here is the call graph for this function:

showExternalSettingsFormObject()

ilObjMailGUI::showExternalSettingsFormObject ( ilPropertyFormGUI  $form = null )

protected

Parameters

ilPropertyFormGUI | null

$form

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

References $form, $GLOBALS, buildSettingsSubTabs(), getExternalSettingsForm(), ilLinkButton\getInstance(), isViewAllowed(), populateExternalSettingsForm(), and user().

Referenced by saveExternalSettingsFormObject(), and sendTestMail().

    {
        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 (strlen($GLOBALS['DIC']->user()->getEmail()) > 0) {
            $btn = ilLinkButton::getInstance();
            $btn->setUrl($this->ctrl->getLinkTarget($this, 'sendTestUserMail'));
            $btn->setCaption('mail_external_send_test_usr');
            $GLOBALS['DIC']->toolbar()->addButtonInstance($btn);

            $btn = ilLinkButton::getInstance();
            $btn->setUrl($this->ctrl->getLinkTarget($this, 'sendTestSystemMail'));
            $btn->setCaption('mail_external_send_test_sys');
            $GLOBALS['DIC']->toolbar()->addButtonInstance($btn);
        }

        $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

Parameters

ilPropertyFormGUI | null

$form

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

References $form, buildSettingsSubTabs(), getGeneralSettingsForm(), isViewAllowed(), and populateGeneralSettingsForm().

Referenced by saveObject(), and viewObject().

    {
        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 187 of file class.ilObjMailGUI.php.

References showGeneralSettingsForm().

    {
        $this->showGeneralSettingsForm();
    }

Here is the call graph for this function:

Field Documentation

$rbacsystem

ilObjMailGUI::$rbacsystem

protected

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

$settings

ilObjMailGUI::$settings

protected

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

$tabs

ilObjMailGUI::$tabs

protected

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

PASSWORD_PLACE_HOLDER

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

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

SETTINGS_SUB_TAB_ID_EXTERNAL

const ilObjMailGUI::SETTINGS_SUB_TAB_ID_EXTERNAL = 2

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

SETTINGS_SUB_TAB_ID_GENERAL

const ilObjMailGUI::SETTINGS_SUB_TAB_ID_GENERAL = 1

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

---

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

• Services/Mail/classes/class.ilObjMailGUI.php