Collaboration diagram for ilMailFormGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	sendMessage ()

	saveDraft ()

	searchUsers ($save=true)

	searchCoursesTo ()

	searchGroupsTo ()

	search ()

	cancelSearch ()

	editAttachments ()

	returnFromAttachments ()

	searchResults ()

	mailUser ()

	mailRole ()

	replyMail ()

	mailAttachment ()

	lookupRecipientAsync ()

	cancelMail ()

	searchMailingListsTo ()

	getAjaxPlaceholdersById ()

Protected Member Functions
	decodeAttachmentFiles (array $files)

	getTemplateDataById ()
	Called asynchronously when changing the template. More...

Private Attributes
	$tpl = null

	$ctrl = null

	$lng = null

	$umail = null

	$mbox = null

	$mfile = null

Detailed Description

Author: Jens Conze

Version: $Id$

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

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

Constructor & Destructor Documentation

◆ __construct()

ilMailFormGUI::__construct ( )

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

References $_GET, $_POST, $ilCtrl, $ilUser, $lng, and $tpl.

         {
                 global $tpl, $ilCtrl, $lng, $ilUser;
 
                 $this->tpl = $tpl;
                 $this->ctrl = $ilCtrl;
                 $this->lng = $lng;
                 
                 $this->umail = new ilFormatMail($ilUser->getId());
                 $this->mfile = new ilFileDataMail($ilUser->getId());
                 $this->mbox = new ilMailBox($ilUser->getId());
                 
                 if(isset($_POST['mobj_id']) && (int)$_POST['mobj_id'])
                 {
                         $_GET['mobj_id'] = $_POST['mobj_id'];
                 }
                 // IF THERE IS NO OBJ_ID GIVEN GET THE ID OF MAIL ROOT NODE
                 if(!(int)$_GET['mobj_id'])
                 {
                         $_GET['mobj_id'] = $this->mbox->getInboxFolder();
                 }
                 $_GET['mobj_id'] = (int)$_GET['mobj_id'];
                 $this->ctrl->saveParameter($this, 'mobj_id');           
         }

Member Function Documentation

◆ cancelMail()

ilMailFormGUI::cancelMail ( )

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

References $_POST, $ilUser, ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), and ilUtil\securePlainString().

     {
         if(ilMailFormCall::isRefererStored())
             ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
         else
             return $this->showForm();
     }

Here is the call graph for this function:

◆ cancelSearch()

ilMailFormGUI::cancelSearch ( )

Definition at line 341 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 114 of file class.ilMailFormGUI.php.

References $GLOBALS.

Referenced by saveDraft(), and sendMessage().

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

Here is the caller graph for this function:

◆ editAttachments()

ilMailFormGUI::editAttachments ( )

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

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

         {
                 // 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($_SESSION["AccountId"],
                                                                         $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 52 of file class.ilMailFormGUI.php.

References $cmd.

         {
                 $forward_class = $this->ctrl->getNextClass($this);
                 switch($forward_class)
                 {
                         case 'ilmailfoldergui':
                                 include_once 'Services/Mail/classes/class.ilMailFolderGUI.php';
 
                                 $this->ctrl->forwardCommand(new ilMailFolderGUI());
                                 break;
 
                         case 'ilmailattachmentgui':
                                 include_once 'Services/Mail/classes/class.ilMailAttachmentGUI.php';
 
                                 $this->ctrl->setReturn($this, "returnFromAttachments");
                                 $this->ctrl->forwardCommand(new ilMailAttachmentGUI());
                                 break;
 
                         case 'ilmailsearchgui':
                                 include_once 'Services/Contact/classes/class.ilMailSearchGUI.php';
 
                                 $this->ctrl->setReturn($this, "searchResults");
                                 $this->ctrl->forwardCommand(new ilMailSearchGUI());
                                 break;
 
                         case 'ilmailsearchcoursesgui':
                                 include_once 'Services/Contact/classes/class.ilMailSearchCoursesGUI.php';
 
                                 $this->ctrl->setReturn($this, "searchResults");
                                 $this->ctrl->forwardCommand(new ilMailSearchCoursesGUI());
                                 break;
                         
                         case 'ilmailinglistsgui':
                                 include_once 'Services/Contact/classes/class.ilMailingListsGUI.php';
 
                                 $this->ctrl->setReturn($this, 'searchResults');
                                 $this->ctrl->forwardCommand(new ilMailingListsGUI());
                                 break;
 
                         case 'ilmailsearchgroupsgui':
                                 include_once 'Services/Contact/classes/class.ilMailSearchGroupsGUI.php';
 
                                 $this->ctrl->setReturn($this, "searchResults");
                                 $this->ctrl->forwardCommand(new ilMailSearchGroupsGUI());
                                 break;
 
                         default:
                                 if (!($cmd = $this->ctrl->getCmd()))
                                 {
                                         $cmd = "showForm";
                                 }
 
                                 $this->$cmd();
                                 break;
                 }
                 return true;
         }

◆ getAjaxPlaceholdersById()

ilMailFormGUI::getAjaxPlaceholdersById ( )

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

References $_GET, exit, ilMailTemplateService\getTemplateContextById(), and ilUtil\stripSlashes().

         {
                 $context_id = ilUtil::stripSlashes($_GET['context_id']);
                 require_once 'Services/Mail/classes/class.ilMailTemplateService.php';
                 require_once 'Services/Mail/classes/Form/class.ilManualPlaceholderInputGUI.php';
                 $placeholders = new ilManualPlaceholderInputGUI($this->ctrl->getLinkTarget($this, 'getAjaxPlaceholdersById', '', true, false));
                 $context = ilMailTemplateService::getTemplateContextById($context_id);
                 foreach($context->getPlaceholders() as $key => $value)
                 {
                         $placeholders->addPlaceholder($value['placeholder'], $value['label'] );
                 }
                 $placeholders->render(true);
                 exit();
         }

Here is the call graph for this function:

◆ getTemplateDataById()

ilMailFormGUI::getTemplateDataById ( )

protected

Called asynchronously when changing the template.

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

References $_GET, $_POST, $_SESSION, $data, $ilCtrl, $ilUser, $lng, $options, $size, $template_id, ilManualPlaceholderInputGUI\addPlaceholder(), ilButton\BUTTON_TYPE_SUBMIT, ilJsonUtil\encode(), exit, ilFormat\formatSize(), ilMailFormCall\getContextId(), ilButton\getInstance(), ilLoggerFactory\getLogger(), ilMailFormCall\getSignature(), ilMailTemplateService\getTemplateContextById(), ilMailFormCall\isRefererStored(), ilUtil\securePlainString(), ilUtil\sendInfo(), ilMailFormCall\setContextId(), ilMailFormCall\setContextParameters(), ilFormPropertyGUI\setInfo(), ilCheckboxInputGUI\setOptionTitle(), ilFormPropertyGUI\setRequired(), ilTextInputGUI\setSize(), and ilTextAreaInputGUI\setValue().

         {
                 require_once 'Services/JSON/classes/class.ilJsonUtil.php';
 
                 if(!isset($_GET['template_id']))
                 {
                         exit();
                 }
 
                 try
                 {
                         require_once 'Services/Mail/classes/class.ilMailTemplateService.php';
                         require_once 'Services/Mail/classes/class.ilMailTemplateDataProvider.php';
                         $template_id = (int)$_GET['template_id'];
                         $template_provider = new ilMailTemplateDataProvider();
                         $template = $template_provider->getTemplateById($template_id);
                         $context = ilMailTemplateService::getTemplateContextById($template->getContext());
                         echo ilJsonUtil::encode(array(
                                 '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 813 of file class.ilMailFormGUI.php.

References $_REQUEST, $result, ilJsonUtil\encode(), exit, and ilUtil\stripSlashes().

         {
                 include_once 'Services/JSON/classes/class.ilJsonUtil.php';
                 include_once 'Services/Mail/classes/class.ilMailForm.php';
                 
                 $search = $_REQUEST["term"];
                 $result = array();
                 if (!$search)
                 {                       
                         echo ilJsonUtil::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 ilJsonUtil::encode($result);
                 exit;
         }

Here is the call graph for this function:

◆ mailAttachment()

ilMailFormGUI::mailAttachment ( )

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

References $_GET.

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

◆ mailRole()

ilMailFormGUI::mailRole ( )

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

References $_GET.

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

◆ mailUser()

ilMailFormGUI::mailUser ( )

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

References $_GET.

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

◆ replyMail()

ilMailFormGUI::replyMail ( )

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

References $_GET.

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

◆ returnFromAttachments()

ilMailFormGUI::returnFromAttachments ( )

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

References $_GET.

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

◆ saveDraft()

ilMailFormGUI::saveDraft ( )

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

References $_POST, $_SESSION, $GLOBALS, decodeAttachmentFiles(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), ilUtil\securePlainString(), and ilUtil\sendInfo().

         {
                 if(!$_POST['m_subject'])
                 {
                         $_POST['m_subject'] = 'No title';
                 }
 
                 $draftFolderId = $this->mbox->getDraftsFolder();
                 $files    = $this->decodeAttachmentFiles(isset($_POST['attachments']) ? (array)$_POST['attachments'] : array());
 
                 if($errorMessage = $this->umail->validateRecipients(
                         ilUtil::securePlainString($_POST['rcp_to']),
                         ilUtil::securePlainString($_POST['rcp_cc']),
                         ilUtil::securePlainString($_POST['rcp_bcc'])
                 ))
                 {
                         $_POST['attachments'] = $files;
                         ilUtil::sendInfo($errorMessage);
                         $this->showForm();
                         return;
                 }
 
                 if(isset($_SESSION["draft"]))
                 {
                         $draftId = (int)$_SESSION['draft'];
                         unset($_SESSION['draft']);
                 }
                 else
                 {
                         $draftId = $this->umail->getNewDraftId($GLOBALS['ilUser']->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("ilmailfoldergui");
 
                 $this->showForm();
         }

Here is the call graph for this function:

◆ search()

ilMailFormGUI::search ( )

Definition at line 317 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 293 of file class.ilMailFormGUI.php.

References $_SESSION.

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

◆ searchGroupsTo()

ilMailFormGUI::searchGroupsTo ( )

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

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

◆ searchMailingListsTo()

ilMailFormGUI::searchMailingListsTo ( )

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

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

◆ searchResults()

ilMailFormGUI::searchResults ( )

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

References $_GET.

Referenced by cancelSearch().

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

Here is the caller graph for this function:

◆ searchUsers()

ilMailFormGUI::searchUsers ( $save = true )

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

References $_POST, $_SESSION, $ilCtrl, $ilUser, ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilUtil\prepareFormOutput(), ilUtil\securePlainString(), and ilTextInputGUI\setSize().

Referenced by search().

         {
                 global $ilUser, $ilCtrl;
                 
                 $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($ilUser->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()
                                                                         );
                 }
                 include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                 $form = new ilPropertyFormGUI();
                 $form->setId('search_rcp');
                 $form->setTitle($this->lng->txt('search_recipients'));
                 $form->setFormAction($ilCtrl->getFormAction($this, 'search'));
                 
                 $inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
                 $inp->setSize(30);
                 $dsDataLink = $ilCtrl->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 129 of file class.ilMailFormGUI.php.

References $_POST, $ilUser, decodeAttachmentFiles(), ilMailFormCall\getRefererRedirectUrl(), ilMailFormCall\isRefererStored(), ilUtil\redirect(), ilUtil\securePlainString(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

         {
                 global $ilUser;
 
                 $files = $this->decodeAttachmentFiles(isset($_POST['attachments']) ? (array)$_POST['attachments'] : array());
 
                 $message = strip_tags(ilUtil::stripSlashes($_POST['m_message'], false));
                 $message = str_replace("\r", '', $message);
                 // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.         
                 $message = $this->umail->formatLinebreakMessage($message);
 
                 $this->umail->setSaveInSentbox(true);
 
                 $m_type = isset($_POST["m_type"]) ? $_POST["m_type"] : array("normal");
 
                 // Note: For security reasons, ILIAS only allows Plain text strings in E-Mails.
                 if($errorMessage = $this->umail->sendMail(
                                 ilUtil::securePlainString($_POST['rcp_to']),
                                 ilUtil::securePlainString($_POST['rcp_cc']),
                                 ilUtil::securePlainString($_POST['rcp_bcc']),
                                 ilUtil::securePlainString($_POST['m_subject']), $message,
                                 $files,
                                 $m_type,
                                 (int)$_POST['use_placeholders']
                                 )
                         )
                 {
                         $_POST['attachments'] = $files;
                         ilUtil::sendInfo($errorMessage);
                 }
                 else
                 {
                         $this->umail->savePostData($ilUser->getId(), array(), "", "", "", "", "", "", "", "");                  
                         
                         $this->ctrl->setParameterByClass('ilmailgui', 'type', 'message_sent');
 
             if(ilMailFormCall::isRefererStored())
             {
                 ilUtil::sendInfo($this->lng->txt('mail_message_send'), true);
                 ilUtil::redirect(ilMailFormCall::getRefererRedirectUrl());
             }
             else
                $this->ctrl->redirectByClass('ilmailgui');
                 }
 
                 $this->showForm();
         }

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilMailFormGUI::$ctrl = null

private

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

◆ $lng

ilMailFormGUI::$lng = null

private

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

Referenced by __construct(), and getTemplateDataById().

◆ $mbox

ilMailFormGUI::$mbox = null

private

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

◆ $mfile

ilMailFormGUI::$mfile = null

private

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

◆ $tpl

ilMailFormGUI::$tpl = null

private

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

Referenced by __construct().

◆ $umail

ilMailFormGUI::$umail = null

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelMail()

◆ cancelSearch()

◆ decodeAttachmentFiles()

◆ editAttachments()

◆ executeCommand()

◆ getAjaxPlaceholdersById()

◆ getTemplateDataById()

◆ lookupRecipientAsync()

◆ mailAttachment()

◆ mailRole()

◆ mailUser()

◆ replyMail()

◆ returnFromAttachments()

◆ saveDraft()

◆ search()

◆ searchCoursesTo()

◆ searchGroupsTo()

◆ searchMailingListsTo()

◆ searchResults()

◆ searchUsers()

◆ sendMessage()

Field Documentation

◆ $ctrl

◆ $lng

◆ $mbox

◆ $mfile

◆ $tpl

◆ $umail