ilMailFormGUI Class Reference

Collaboration diagram for ilMailFormGUI:

Public Member Functions
	__construct (ilMailTemplateService $templateService=null, ilMailBodyPurifier $bodyPurifier=null)
	ilMailFormGUI constructor. More...
	executeCommand ()
	sendMessage ()
	saveDraft ()
	searchUsers ($save=true)
	searchCoursesTo ()
	searchGroupsTo ()
	search ()
	cancelSearch ()
	editAttachments ()
	returnFromAttachments ()
	searchResults ()
	mailUser ()
	mailRole ()
	replyMail ()
	mailAttachment ()
	showForm ()
	lookupRecipientAsync ()
	cancelMail ()
	searchMailingListsTo ()

Protected Member Functions
	decodeAttachmentFiles (array $files)
	getTemplateDataById ()
	Called asynchronously when changing the template. More...
	saveMailBeforeSearch ()
	showSubmissionErrors (array $errors)

Protected Attributes
	$templateService

Private Attributes
	$tpl
	$ctrl
	$lng
	$user
	$tabs
	$toolbar
	$rbacsystem
	$umail
	$mbox
	$mfile
	$purifier

Detailed Description

Author

Jens Conze

Version

$Id$

ilMailFormGUI: ilMailFolderGUI, ilMailAttachmentGUI, ilMailSearchGUI, ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI

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

Constructor & Destructor Documentation

__construct()

ilMailFormGUI::__construct	(	ilMailTemplateService	$templateService = null,
		ilMailBodyPurifier	$bodyPurifier = null
	)

ilMailFormGUI constructor.

Parameters

ilMailTemplateService | null	$templateService
ilMailBodyPurifier | null	$bodyPurifier

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

References $_GET, $_POST, $DIC, $templateService, and user().

      {
        global $DIC;

        if (null === $templateService) {
            $templateService = $DIC['mail.texttemplates.service'];
        }
        $this->templateService = $templateService;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->rbacsystem = $DIC->rbac()->system();

        $this->umail = new ilFormatMail($this->user->getId());
        $this->mfile = new ilFileDataMail($this->user->getId());
        $this->mbox = new ilMailbox($this->user->getId());

        if (null === $bodyPurifier) {
            $bodyPurifier = new ilMailBodyPurifier();
        }
        $this->purifier = $bodyPurifier;

        if (isset($_POST['mobj_id']) && (int) $_POST['mobj_id']) {
            $_GET['mobj_id'] = $_POST['mobj_id'];
        }

        if (!(int) $_GET['mobj_id']) {
            $_GET['mobj_id'] = $this->mbox->getInboxFolder();
        }
        $_GET['mobj_id'] = (int) $_GET['mobj_id'];

        $this->ctrl->saveParameter($this, 'mobj_id');
    }

Here is the call graph for this function:

Member Function Documentation

cancelMail()

ilMailFormGUI::cancelMail

(

)

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

References ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), and showForm().

    {
        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        }

        $this->showForm();
    }

Here is the call graph for this function:

cancelSearch()

ilMailFormGUI::cancelSearch

(

)

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

References $_SESSION, and searchResults().

    {
        unset($_SESSION["mail_search"]);
        $this->searchResults();
    }

Here is the call graph for this function:

decodeAttachmentFiles()

ilMailFormGUI::decodeAttachmentFiles ( array  $files )

protected

Parameters

array

$files

Returns

array

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

References user().

Referenced by saveDraft(), and sendMessage().

    {
        $decodedFiles = array();

        foreach ($files as $value) {
            if (is_file($this->mfile->getMailPath() . '/' . $this->user->getId() . '_' . urldecode($value))) {
                $decodedFiles[] = urldecode($value);
            }
        }

        return $decodedFiles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editAttachments()

ilMailFormGUI::editAttachments

(

)

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

References $_POST, $files, ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilUtil\securePlainString(), and user().

    {
        // decode post values
        $files = array();
        if (is_array($_POST['attachments'])) {
            foreach ($_POST['attachments'] as $value) {
                $files[] = urldecode($value);
            }
        }
        
        // Note: For security reasons, ILIAS only allows Plain text messages.
        $this->umail->savePostData(
            $this->user->getId(),
            $files,
            ilUtil::securePlainString($_POST["rcp_to"]),
            ilUtil::securePlainString($_POST["rcp_cc"]),
            ilUtil::securePlainString($_POST["rcp_bcc"]),
            $_POST["m_type"],
            ilUtil::securePlainString($_POST["m_email"]),
            ilUtil::securePlainString($_POST["m_subject"]),
            ilUtil::securePlainString($_POST["m_message"]),
            ilUtil::securePlainString($_POST['use_placeholders']),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
            
        $this->ctrl->redirectByClass("ilmailattachmentgui");
    }

Here is the call graph for this function:

executeCommand()

ilMailFormGUI::executeCommand

(

)

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

    {
        $forward_class = $this->ctrl->getNextClass($this);
        switch ($forward_class) {
            case 'ilmailfoldergui':
                $this->ctrl->forwardCommand(new ilMailFolderGUI());
                break;

            case 'ilmailattachmentgui':
                $this->ctrl->setReturn($this, "returnFromAttachments");
                $this->ctrl->forwardCommand(new ilMailAttachmentGUI());
                break;

            case 'ilmailsearchgui':
                $this->ctrl->setReturn($this, "searchResults");
                $this->ctrl->forwardCommand(new ilMailSearchGUI());
                break;

            case 'ilmailsearchcoursesgui':
                $this->ctrl->setReturn($this, "searchResults");
                $this->ctrl->forwardCommand(new ilMailSearchCoursesGUI());
                break;
            
            case 'ilmailinglistsgui':
                $this->ctrl->setReturn($this, 'searchResults');
                $this->ctrl->forwardCommand(new ilMailingListsGUI());
                break;

            case 'ilmailsearchgroupsgui':
                $this->ctrl->setReturn($this, "searchResults");
                $this->ctrl->forwardCommand(new ilMailSearchGroupsGUI());
                break;

            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = "showForm";
                }

                $this->$cmd();
                break;
        }
    }

getTemplateDataById()

ilMailFormGUI::getTemplateDataById ( )

protected

Called asynchronously when changing the template.

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

References $_GET, $context, $template, exit, and ilMailTemplateContextService\getTemplateContextById().

    {
        if (!isset($_GET['template_id'])) {
            exit();
        }

        try {
            $template = $this->templateService->loadTemplateForId((int) $_GET['template_id']);
            $context = ilMailTemplateContextService::getTemplateContextById((string) $template->getContext());

            echo json_encode([
                'm_subject' => $template->getSubject(),
                'm_message' => $template->getMessage(),
            ]);
        } catch (Exception $e) {
        }
        exit();
    }

Here is the call graph for this function:

lookupRecipientAsync()

ilMailFormGUI::lookupRecipientAsync

(

)

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

References $_GET, $_POST, $result, exit, ilUtil\stripSlashes(), and ilStr\strLen().

    {
        $search = '';
        if (isset($_GET["term"]) && is_string($_GET["term"])) {
            $search = $_GET["term"];
        }
        if (isset($_POST["term"]) && is_string($_POST["term"])) {
            $search = $_POST["term"];
        }

        $search = trim($search);

        $result = array();

        require_once 'Services/Utilities/classes/class.ilStr.php';
        if (ilStr::strLen($search) < 3) {
            echo json_encode($result);
            exit;
        }

        // #14768
        $quoted = ilUtil::stripSlashes($search);
        $quoted = str_replace('%', '\%', $quoted);
        $quoted = str_replace('_', '\_', $quoted);

        $mailFormObj = new ilMailForm;
        $result = $mailFormObj->getRecipientAsync("%" . $quoted . "%", ilUtil::stripSlashes($search));

        echo json_encode($result);
        exit;
    }

Here is the call graph for this function:

mailAttachment()

ilMailFormGUI::mailAttachment

(

)

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

References $_GET, and showForm().

    {
        $_GET["type"] = "attach";
        $this->showForm();
    }

Here is the call graph for this function:

mailRole()

ilMailFormGUI::mailRole

(

)

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

References $_GET, and showForm().

    {
        $_GET["type"] = "role";
        $this->showForm();
    }

Here is the call graph for this function:

mailUser()

ilMailFormGUI::mailUser

(

)

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

References $_GET, and showForm().

    {
        $_GET["type"] = "new";
        $this->showForm();
    }

Here is the call graph for this function:

replyMail()

ilMailFormGUI::replyMail

(

)

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

References $_GET, and showForm().

    {
        $_GET["type"] = "reply";
        $this->showForm();
    }

Here is the call graph for this function:

returnFromAttachments()

ilMailFormGUI::returnFromAttachments

(

)

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

References $_GET, and showForm().

    {
        $_GET["type"] = "attach";
        $this->showForm();
    }

Here is the call graph for this function:

saveDraft()

ilMailFormGUI::saveDraft

(

)

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

References $_POST, $_SESSION, $errors, $files, decodeAttachmentFiles(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), ilUtil\securePlainString(), ilUtil\sendInfo(), showForm(), showSubmissionErrors(), and user().

    {
        if (!$_POST['m_subject']) {
            $_POST['m_subject'] = 'No title';
        }

        $draftFolderId = $this->mbox->getDraftsFolder();
        $files = $this->decodeAttachmentFiles(isset($_POST['attachments']) ? (array) $_POST['attachments'] : array());

        if ($errors = $this->umail->validateRecipients(
            (string) ilUtil::securePlainString($_POST['rcp_to']),
            (string) ilUtil::securePlainString($_POST['rcp_cc']),
            (string) ilUtil::securePlainString($_POST['rcp_bcc'])
        )) {
            $_POST['attachments'] = $files;
            $this->showSubmissionErrors($errors);
            $this->showForm();
            return;
        }

        if (isset($_SESSION["draft"])) {
            $draftId = (int) $_SESSION['draft'];
            unset($_SESSION['draft']);
        } else {
            $draftId = $this->umail->getNewDraftId($this->user->getId(), $draftFolderId);
        }

        $this->umail->updateDraft(
            $draftFolderId,
            $files,
            ilUtil::securePlainString($_POST['rcp_to']),
            ilUtil::securePlainString($_POST['rcp_cc']),
            ilUtil::securePlainString($_POST['rcp_bcc']),
            $_POST['m_type'],
            ilUtil::securePlainString($_POST['m_email']),
            ilUtil::securePlainString($_POST['m_subject']),
            ilUtil::securePlainString($_POST['m_message']),
            $draftId,
            (int) $_POST['use_placeholders'],
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );

        ilUtil::sendInfo($this->lng->txt('mail_saved'), true);

        if (ilMailFormCall::isRefererStored()) {
            ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
        } else {
            $this->ctrl->redirectByClass(['ilmailgui', 'ilmailfoldergui']);
        }

        $this->showForm();
    }

Here is the call graph for this function:

saveMailBeforeSearch()

ilMailFormGUI::saveMailBeforeSearch ( )

protected

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

References $_POST, $files, ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilUtil\securePlainString(), and user().

Referenced by searchCoursesTo(), searchGroupsTo(), and searchMailingListsTo().

    {
        $files = array();
        if (is_array($_POST['attachments'])) {
            foreach ($_POST['attachments'] as $value) {
                $files[] = urldecode($value);
            }
        }

        $this->umail->savePostData(
            $this->user->getId(),
            $files,
            ilUtil::securePlainString($_POST['rcp_to']),
            ilUtil::securePlainString($_POST['rcp_cc']),
            ilUtil::securePlainString($_POST['rcp_bcc']),
            $_POST['m_type'],
            ilUtil::securePlainString($_POST['m_email']),
            ilUtil::securePlainString($_POST['m_subject']),
            ilUtil::securePlainString($_POST['m_message']),
            ilUtil::securePlainString($_POST['use_placeholders']),
            ilMailFormCall::getContextId(),
            ilMailFormCall::getContextParameters()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

search()

ilMailFormGUI::search

(

)

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

References $_POST, $_SESSION, searchUsers(), and ilUtil\sendInfo().

    {
        $_SESSION["mail_search_search"] = $_POST["search"];
        if (strlen(trim($_SESSION["mail_search_search"])) == 0) {
            ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
            $this->searchUsers(false);
        } else {
            if (strlen(trim($_SESSION["mail_search_search"])) < 3) {
                $this->lng->loadLanguageModule('search');
                ilUtil::sendInfo($this->lng->txt('search_minimum_three'));
                $this->searchUsers(false);
            } else {
                $this->ctrl->setParameterByClass("ilmailsearchgui", "search", urlencode($_SESSION["mail_search_search"]));
                $this->ctrl->redirectByClass("ilmailsearchgui");
            }
        }
    }

Here is the call graph for this function:

searchCoursesTo()

ilMailFormGUI::searchCoursesTo

(

)

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

References $_SESSION, and saveMailBeforeSearch().

    {
        $this->saveMailBeforeSearch();

        if ($_SESSION['search_crs']) {
            $this->ctrl->setParameterByClass('ilmailsearchcoursesgui', 'cmd', 'showMembers');
        }
        
        $this->ctrl->setParameterByClass('ilmailsearchcoursesgui', 'ref', 'mail');
        $this->ctrl->redirectByClass('ilmailsearchcoursesgui');
    }

Here is the call graph for this function:

searchGroupsTo()

ilMailFormGUI::searchGroupsTo

(

)

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

References saveMailBeforeSearch().

    {
        $this->saveMailBeforeSearch();

        $this->ctrl->setParameterByClass('ilmailsearchgroupsgui', 'ref', 'mail');
        $this->ctrl->redirectByClass('ilmailsearchgroupsgui');
    }

Here is the call graph for this function:

searchMailingListsTo()

ilMailFormGUI::searchMailingListsTo

(

)

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

References saveMailBeforeSearch().

    {
        $this->saveMailBeforeSearch();

        $this->ctrl->setParameterByClass('ilmailinglistsgui', 'ref', 'mail');
        $this->ctrl->redirectByClass('ilmailinglistsgui');
    }

Here is the call graph for this function:

searchResults()

ilMailFormGUI::searchResults

(

)

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

References $_GET, and showForm().

Referenced by cancelSearch().

    {
        $_GET["type"] = "search_res";
        $this->showForm();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

searchUsers()

ilMailFormGUI::searchUsers

(

$save = true

)

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

References $_POST, $_SESSION, $files, $form, ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilUtil\prepareFormOutput(), ilUtil\securePlainString(), ilTextInputGUI\setSize(), and user().

Referenced by search().

    {
        $this->tpl->setTitle($this->lng->txt("mail"));

        if ($save) {
            // decode post values
            $files = array();
            if (is_array($_POST['attachments'])) {
                foreach ($_POST['attachments'] as $value) {
                    $files[] = urldecode($value);
                }
            }
            
            // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
            $this->umail->savePostData(
                $this->user->getId(),
                $files,
                ilUtil::securePlainString($_POST["rcp_to"]),
                ilUtil::securePlainString($_POST["rcp_cc"]),
                ilUtil::securePlainString($_POST["rcp_bcc"]),
                $_POST["m_type"],
                ilUtil::securePlainString($_POST["m_email"]),
                ilUtil::securePlainString($_POST["m_subject"]),
                ilUtil::securePlainString($_POST["m_message"]),
                ilUtil::securePlainString($_POST['use_placeholders']),
                ilMailFormCall::getContextId(),
                ilMailFormCall::getContextParameters()
            );
        }

        $form = new ilPropertyFormGUI();
        $form->setId('search_rcp');
        $form->setTitle($this->lng->txt('search_recipients'));
        $form->setFormAction($this->ctrl->getFormAction($this, 'search'));
        
        $inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
        $inp->setSize(30);
        $dsDataLink = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true, false);
        $inp->setDataSource($dsDataLink);
        
        if (strlen(trim($_SESSION["mail_search_search"])) > 0) {
            $inp->setValue(ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
        }
        $form->addItem($inp);

        $form->addCommandButton('search', $this->lng->txt("search"));
        $form->addCommandButton('cancelSearch', $this->lng->txt("cancel"));

        $this->tpl->setContent($form->getHtml());
        $this->tpl->show();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMessage()

ilMailFormGUI::sendMessage

(

)

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

References $_POST, $errors, $files, $message, decodeAttachmentFiles(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\securePlainString(), ilUtil\sendInfo(), showForm(), showSubmissionErrors(), and user().

    {
        $m_type = isset($_POST["m_type"]) ? $_POST["m_type"] : array("normal");

        $message = (string) $_POST['m_message'];

        $mailBody = new ilMailBody($message, $this->purifier);

        $sanitizedMessage = $mailBody->getContent();

        $files = $this->decodeAttachmentFiles(isset($_POST['attachments']) ? (array) $_POST['attachments'] : array());

        $mailer = $this->umail
            ->withContextId(ilMailFormCall::getContextId() ? ilMailFormCall::getContextId() : '')
            ->withContextParameters(is_array(ilMailFormCall::getContextParameters()) ? ilMailFormCall::getContextParameters() : []);

        $mailer->setSaveInSentbox(true);

        if ($errors = $mailer->sendMail(
            ilUtil::securePlainString($_POST['rcp_to']),
            ilUtil::securePlainString($_POST['rcp_cc']),
            ilUtil::securePlainString($_POST['rcp_bcc']),
            ilUtil::securePlainString($_POST['m_subject']),
            $sanitizedMessage,
            $files,
            $m_type,
            (int) $_POST['use_placeholders']
        )
        ) {
            $_POST['attachments'] = $files;
            $this->showSubmissionErrors($errors);
        } else {
            $mailer->savePostData($this->user->getId(), array(), "", "", "", "", "", "", "", "");

            $this->ctrl->setParameterByClass('ilmailgui', 'type', 'message_sent');

            if (ilMailFormCall::isRefererStored()) {
                ilUtil::sendInfo($this->lng->txt('mail_message_send'), true);
                $this->ctrl->redirectToURL(ilMailFormCall::getRefererRedirectUrl());
            } else {
                $this->ctrl->redirectByClass('ilmailgui');
            }
        }

        $this->showForm();
    }

Here is the call graph for this function:

showForm()

ilMailFormGUI::showForm

(

)

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

References $_GET, $_POST, $_SESSION, $context, $data, $key, PHPMailer\PHPMailer\$options, $size, $template, ilButton\BUTTON_TYPE_SUBMIT, ilUtil\formatSize(), ilMailFormCall\getContextId(), ilButton\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilLoggerFactory\getLogger(), ilMailFormCall\getSignature(), ilMailTemplateContextService\getTemplateContextById(), ilMailFormCall\isRefererStored(), ilUtil\securePlainString(), ilUtil\sendInfo(), ilMailFormCall\setContextId(), ilMailFormCall\setContextParameters(), ilCheckboxInputGUI\setOptionTitle(), ilFormPropertyGUI\setRequired(), ilTextInputGUI\setSize(), ilTextAreaInputGUI\setValue(), and user().

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

    {
        $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_new.html", "Services/Mail");
        $this->tpl->setTitle($this->lng->txt("mail"));
        
        $this->lng->loadLanguageModule("crs");

        if (ilMailFormCall::isRefererStored()) {
            $this->tabs->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this, 'cancelMail'));
        }

        switch ($_GET["type"]) {
            case 'reply':
                if ($_SESSION['mail_id']) {
                    $_GET['mail_id'] = $_SESSION['mail_id'];
                }
                $mailData = $this->umail->getMail($_GET["mail_id"]);
                $mailData["m_subject"] = $this->umail->formatReplySubject();
                $mailData["m_message"] = $this->umail->formatReplyMessage();
                $mailData["m_message"] = $this->umail->prependSignature();
                // NO ATTACHMENTS FOR REPLIES
                $mailData["attachments"] = array();
                //$mailData["rcp_cc"] = $this->umail->formatReplyRecipientsForCC();
                $mailData["rcp_cc"] = '';
                $mailData["rcp_to"] = $this->umail->formatReplyRecipient();
                $_SESSION["mail_id"] = "";
                break;
        
            case 'search_res':
                $mailData = $this->umail->getSavedData();

                /*if($_SESSION["mail_search_results"])
                {
                    $mailData = $this->umail->appendSearchResult($_SESSION["mail_search_results"],$_SESSION["mail_search"]);
                }
                unset($_SESSION["mail_search"]);
                unset($_SESSION["mail_search_results"]);*/

                if ($_SESSION["mail_search_results_to"]) {
                    $mailData = $this->umail->appendSearchResult($_SESSION["mail_search_results_to"], 'to');
                }
                if ($_SESSION["mail_search_results_cc"]) {
                    $mailData = $this->umail->appendSearchResult($_SESSION["mail_search_results_cc"], 'cc');
                }
                if ($_SESSION["mail_search_results_bcc"]) {
                    $mailData = $this->umail->appendSearchResult($_SESSION["mail_search_results_bcc"], 'bc');
                }
                
                unset($_SESSION["mail_search_results_to"]);
                unset($_SESSION["mail_search_results_cc"]);
                unset($_SESSION["mail_search_results_bcc"]);
                                
                break;
        
            case 'attach':
                $mailData = $this->umail->getSavedData();
                break;
        
            case 'draft':
                $_SESSION["draft"] = $_GET["mail_id"];
                $mailData = $this->umail->getMail($_GET["mail_id"]);
                ilMailFormCall::setContextId($mailData['tpl_ctx_id']);
                ilMailFormCall::setContextParameters($mailData['tpl_ctx_params']);
                break;
        
            case 'forward':
                $mailData = $this->umail->getMail($_GET["mail_id"]);
                $mailData["rcp_to"] = $mailData["rcp_cc"] = $mailData["rcp_bcc"] = '';
                $mailData["m_subject"] = $this->umail->formatForwardSubject();
                $mailData["m_message"] = $this->umail->prependSignature();
                if (is_array($mailData["attachments"]) && count($mailData["attachments"])) {
                    if ($error = $this->mfile->adoptAttachments($mailData["attachments"], $_GET["mail_id"])) {
                        ilUtil::sendInfo($error);
                    }
                }
                break;
        
            case 'new':
                if ($_GET['rcp_to']) {
                    // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                    $mailData["rcp_to"] = ilUtil::securePlainString($_GET['rcp_to']);
                } elseif ($_SESSION['rcp_to']) {
                    $mailData["rcp_to"] = $_SESSION['rcp_to'];
                }
                if ($_GET['rcp_cc']) {
                    // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                    $mailData["rcp_cc"] = ilUtil::securePlainString($_GET['rcp_cc']);
                } elseif ($_SESSION['rcp_cc']) {
                    $mailData["rcp_cc"] = $_SESSION['rcp_cc'];
                }
                if ($_GET['rcp_bcc']) {
                    // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                    $mailData["rcp_bcc"] = ilUtil::securePlainString($_GET['rcp_bcc']);
                } elseif ($_SESSION['rcp_bcc']) {
                    $mailData["rcp_bcc"] = $_SESSION['rcp_bcc'];
                }
                $mailData['m_message'] = '';
                if (strlen($sig = ilMailFormCall::getSignature())) {
                    $mailData['m_message'] = $sig;
                    $mailData['m_message'] .= chr(13) . chr(10) . chr(13) . chr(10);
                }
                $mailData['m_message'] .= $this->umail->appendSignature();

                $_SESSION['rcp_to'] = '';
                $_SESSION['rcp_cc'] = '';
                $_SESSION['rcp_bcc'] = '';
                break;
        
            case 'role':
        
                if (is_array($_POST['roles'])) {
                    // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                    $mailData['rcp_to'] = ilUtil::securePlainString(implode(',', $_POST['roles']));
                } elseif (is_array($_SESSION['mail_roles'])) {
                    $mailData['rcp_to'] = ilUtil::securePlainString(implode(',', $_SESSION['mail_roles']));
                }

                $mailData['m_message'] = '';
                if (strlen($sig = ilMailFormCall::getSignature())) {
                    $mailData['m_message'] = $sig;
                    $mailData['m_message'] .= chr(13) . chr(10) . chr(13) . chr(10);
                }
        
                $mailData['m_message'] .= $_POST["additional_message_text"] . chr(13) . chr(10) . $this->umail->appendSignature();
                $_POST["additional_message_text"] = "";
                $_SESSION['mail_roles'] = [];
                break;
        
            case 'address':
                $mailData["rcp_to"] = urldecode($_GET["rcp"]);
                break;
        
            default:
                // GET DATA FROM POST
                $mailData = $_POST;

                // strip slashes
                foreach ($mailData as $key => $value) {
                    if (is_string($value)) {
                        // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                        $mailData[$key] = ilUtil::securePlainString($value);
                    }
                }
                break;
        }

        $form_gui = new ilPropertyFormGUI();
        $form_gui->setTitle($this->lng->txt('compose'));
        $form_gui->setId('mail_compose_form');
        $form_gui->setName('mail_compose_form');
        $form_gui->setFormAction($this->ctrl->getFormAction($this, 'sendMessage'));

        $this->tpl->setVariable('FORM_ID', $form_gui->getId());

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT);
        $btn->setForm('form_' . $form_gui->getName())
            ->setName('searchUsers')
            ->setCaption('search_recipients');
        $this->toolbar->addStickyItem($btn);

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
            ->setName('searchCoursesTo')
            ->setForm('form_' . $form_gui->getName())
            ->setCaption('mail_my_courses');
        $this->toolbar->addButtonInstance($btn);

        $btn = ilButton::getInstance();
        $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
            ->setName('searchGroupsTo')
            ->setForm('form_' . $form_gui->getName())
            ->setCaption('mail_my_groups');
        $this->toolbar->addButtonInstance($btn);

        if (count(ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()) > 0) {
            $btn = ilButton::getInstance();
            $btn->setButtonType(ilButton::BUTTON_TYPE_SUBMIT)
                ->setName('searchMailingListsTo')
                ->setForm('form_' . $form_gui->getName())
                ->setCaption('mail_my_mailing_lists');
            $this->toolbar->addButtonInstance($btn);
        }

        $dsDataLink = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true);
        
        $inp = new ilTextInputGUI($this->lng->txt('mail_to'), 'rcp_to');
        $inp->setRequired(true);
        $inp->setSize(50);
        $inp->setValue($mailData["rcp_to"]);
        $inp->setDataSource($dsDataLink, ",");
        $inp->setMaxLength(null);
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('cc'), 'rcp_cc');
        $inp->setSize(50);
        $inp->setValue($mailData["rcp_cc"]);
        $inp->setDataSource($dsDataLink, ",");
        $inp->setMaxLength(null);
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('bc'), 'rcp_bcc');
        $inp->setSize(50);
        $inp->setValue($mailData["rcp_bcc"]);
        $inp->setDataSource($dsDataLink, ",");
        $inp->setMaxLength(null);
        $form_gui->addItem($inp);

        $inp = new ilTextInputGUI($this->lng->txt('subject'), 'm_subject');
        $inp->setSize(50);
        $inp->setRequired(true);
        $inp->setValue($mailData["m_subject"]);
        $form_gui->addItem($inp);

        $att = new ilMailFormAttachmentPropertyGUI($this->lng->txt(($mailData["attachments"]) ? 'edit' : 'add'));
        
        if (is_array($mailData["attachments"]) && count($mailData["attachments"])) {
            foreach ($mailData["attachments"] as $data) {
                if (is_file($this->mfile->getMailPath() . '/' . $this->user->getId() . "_" . $data)) {
                    $hidden = new ilHiddenInputGUI('attachments[]');
                    $form_gui->addItem($hidden);
                    $size = filesize($this->mfile->getMailPath() . '/' . $this->user->getId() . "_" . $data);
                    $label = $data . " [" . ilUtil::formatSize($size) . "]";
                    $att->addItem($label);
                    $hidden->setValue(urlencode($data));
                }
            }
        }
        $form_gui->addItem($att);

        // ONLY IF SYSTEM MAILS ARE ALLOWED
        if ($this->rbacsystem->checkAccess("system_message", $this->umail->getMailObjectReferenceId())) {
            $chb = new ilCheckboxInputGUI($this->lng->txt('type'), 'm_type[]');
            $chb->setOptionTitle($this->lng->txt('system_message'));
            $chb->setValue('system');
            $chb->setChecked(false);
            if (is_array($mailData["m_type"]) and in_array('system', $mailData["m_type"])) {
                $chb->setChecked(true);
            }
            $form_gui->addItem($chb);
        }

        if (ilMailFormCall::getContextId()) {
            $context_id = ilMailFormCall::getContextId();

            $mailData['use_placeholders'] = true;

            try {
                $context = ilMailTemplateContextService::getTemplateContextById($context_id);

                $templates = $this->templateService->loadTemplatesForContextId($context->getId());
                if (count($templates) > 0) {
                    $options = array();

                    $template_chb = new ilMailTemplateSelectInputGUI(
                        $this->lng->txt('mail_template_client'),
                        'template_id',
                        $this->ctrl->getLinkTarget($this, 'getTemplateDataById', '', true, false),
                        array('m_subject', 'm_message')
                    );

                    foreach ($templates as $template) {
                        $options[$template->getTplId()] = $template->getTitle();

                        if (!isset($mailData['template_id']) && $template->isDefault()) {
                            $template_chb->setValue($template->getTplId());
                            $form_gui->getItemByPostVar('m_subject')->setValue($template->getSubject());
                            $mailData["m_message"] = $template->getMessage();
                        }
                    }
                    if (isset($mailData['template_id'])) {
                        $template_chb->setValue((int) $mailData['template_id']);
                    }
                    asort($options);

                    $template_chb->setInfo($this->lng->txt('mail_template_client_info'));
                    $template_chb->setOptions(array('' => $this->lng->txt('please_choose')) + $options);
                    $form_gui->addItem($template_chb);
                }
            } catch (Exception $e) {
                ilLoggerFactory::getLogger('mail')->error(sprintf(
                    '%s has been called with invalid context id: %s.',
                    __METHOD__,
                    $context_id
                ));
            }
        } else {
            $context = new ilMailTemplateGenericContext();
        }

        // MESSAGE
        $inp = new ilTextAreaInputGUI($this->lng->txt('message_content'), 'm_message');
        //$inp->setValue(htmlspecialchars($mailData["m_message"], false));
        $inp->setValue($mailData["m_message"]);
        $inp->setRequired(false);
        $inp->setCols(60);
        $inp->setRows(10);
        $form_gui->addItem($inp);

        // PLACEHOLDERS
        $chb = new ilCheckboxInputGUI($this->lng->txt('mail_serial_letter_placeholders'), 'use_placeholders');
        $chb->setOptionTitle($this->lng->txt('activate_serial_letter_placeholders'));
        $chb->setValue(1);
        if (isset($mailData['use_placeholders']) && $mailData['use_placeholders']) {
            $chb->setChecked(true);
        }

        $placeholders = new ilManualPlaceholderInputGUI('m_message');
        $placeholders->setInstructionText($this->lng->txt('mail_nacc_use_placeholder'));
        $placeholders->setAdviseText(sprintf($this->lng->txt('placeholders_advise'), '<br />'));
        foreach ($context->getPlaceholders() as $key => $value) {
            $placeholders->addPlaceholder($value['placeholder'], $value['label']);
        }
        $chb->addSubItem($placeholders);
        $form_gui->addItem($chb);

        $form_gui->addCommandButton('sendMessage', $this->lng->txt('send_mail'));
        $form_gui->addCommandButton('saveDraft', $this->lng->txt('save_message'));
        if (ilMailFormCall::isRefererStored()) {
            $form_gui->addCommandButton('cancelMail', $this->lng->txt('cancel'));
        }

        $this->tpl->parseCurrentBlock();

        $this->tpl->setVariable('FORM', $form_gui->getHTML());

        $this->tpl->addJavaScript('Services/Mail/js/ilMailComposeFunctions.js');
        $this->tpl->show();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSubmissionErrors()

ilMailFormGUI::showSubmissionErrors ( array  $errors )

protected

Parameters

$errors

ilMailError[]

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

References ilUtil\sendFailure().

Referenced by saveDraft(), and sendMessage().

    {
        $formatter = new ilMailErrorFormatter($this->lng);
        $formattedErrors = $formatter->format($errors);

        if (strlen($formattedErrors) > 0) {
            ilUtil::sendFailure($formattedErrors);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMailFormGUI::$ctrl

private

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

$lng

ilMailFormGUI::$lng

private

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

$mbox

ilMailFormGUI::$mbox

private

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

$mfile

ilMailFormGUI::$mfile

private

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

$purifier

ilMailFormGUI::$purifier

private

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

$rbacsystem

ilMailFormGUI::$rbacsystem

private

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

$tabs

ilMailFormGUI::$tabs

private

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

$templateService

ilMailFormGUI::$templateService

protected

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

Referenced by __construct().

$toolbar

ilMailFormGUI::$toolbar

private

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

$tpl

ilMailFormGUI::$tpl

private

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

$umail

ilMailFormGUI::$umail

private

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

$user

ilMailFormGUI::$user

private

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

---

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

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