Class UserMail this class handles user mails. More...

Inheritance diagram for ilFormatMail:

Collaboration diagram for ilFormatMail:

Public Member Functions
	__construct ($a_user_id)
	Constructor setup an mail object. More...

	formatReplyMessage ()
	format a reply message public More...

	formatReplySubject ()
	format a reply subject public More...

	formatReplyRecipientsForCC ()
	get reply recipients for cc public More...

	formatReplyRecipient ()
	get reply recipient public More...

	formatForwardSubject ()
	format a forward subject public More...

	appendSearchResult ($a_names, $a_type)
	append search result to recipient public More...

	formatLinebreakMessage (string $message)

	appendSignature ()
	append signature to mail body public More...

	prependSignature ()

Public Member Functions inherited from ilMail
	__construct ( $a_user_id, ilMailAddressTypeFactory $mailAddressTypeFactory=null, ilMailRfc822AddressParserFactory $mailAddressParserFactory=null, ilAppEventHandler $eventHandler=null, ilLogger $logger=null, ilDBInterface $db=null, ilLanguage $lng=null, ilFileDataMail $mailFileData=null, ilMailOptions $mailOptions=null, ilMailbox $mailBox=null, ilMailMimeSenderFactory $senderFactory=null, callable $usrIdByLoginCallable=null, int $mailAdminNodeRefId=null)

	withContextId (string $contextId)

	withContextParameters (array $parameters)

	existsRecipient (string $newRecipient, string $existingRecipients)

	setSaveInSentbox (bool $saveInSentbox)

	getSaveInSentbox ()

	getMailObjectReferenceId ()

	formatNamesForOutput (string $recipients)
	Prepends the full name of each ILIAS login name (if user has a public profile) found in the passed string and brackets the ILIAS login name afterwards. More...

	getPreviousMail (int $mailId)

	getNextMail (int $mailId)

	getMailsOfFolder ($a_folder_id, $filter=[])

	countMailsOfFolder (int $folderId)

	deleteMailsOfFolder (int $folderId)

	getMail (int $mailId)

	markRead (array $mailIds)

	markUnread (array $mailIds)

	moveMailsToFolder (array $mailIds, int $folderId)

	deleteMails (array $mailIds)

	getNewDraftId (int $usrId, int $folderId)

	updateDraft ( $a_folder_id, $a_attachments, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_email, $a_m_subject, $a_m_message, $a_draft_id=0, $a_use_placeholders=0, $a_tpl_context_id=null, $a_tpl_context_params=[])

	savePostData ( $a_user_id, $a_attachments, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_email, $a_m_subject, $a_m_message, $a_use_placeholders, $a_tpl_context_id=null, $a_tpl_ctx_params=array())
	save post data in table public More...

	getSavedData ()

	enqueue ( $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject, $a_m_message, $a_attachment, $a_use_placeholders=0)
	Should be used to enqueue a 'mail'. More...

	sendMail (string $to, string $cc, string $bcc, string $subject, string $message, array $attachments, bool $usePlaceholders)
	This method is used to finally send internal messages and external emails To use the mail system as a consumer, please use ::enqueue. More...

	validateRecipients (string $to, string $cc, string $bcc)

	saveAttachments (array $attachments)

	appendInstallationSignature (bool $a_flag=null)

	setUserInstanceById (array $userInstanceByIdMap)

	setMailOptionsByUserIdMap (array $mailOptionsByUsrIdMap)

	formatLinebreakMessage (string $message)

Additional Inherited Members
Static Public Member Functions inherited from ilMail
static	_getAutoGeneratedMessageString (ilLanguage $lang=null)
	Get auto generated info string. More...

static	_getInstallationSignature ()

static	getSalutation ($a_usr_id, ilLanguage $a_language=null)

Data Fields inherited from ilMail
const	ILIAS_HOST = 'ilias'

	$user_id

Protected Member Functions inherited from ilMail
	isSystemMail ()

	readMailObjectReferenceId ()
	Read and set the mail object ref id (administration node) More...

	fetchMailData (?array $row)

	replacePlaceholders (string $message, int $usrId=0, bool $replaceEmptyPlaceholders=true)

	distributeMail (string $to, string $cc, string $bcc, string $subject, string $message, array $attachments, int $sentMailId, bool $usePlaceholders=false)

	sendChanneledMails (string $to, string $cc, string $bcc, array $usrIds, string $subject, string $message, array $attachments, int $sentMailId, bool $usePlaceholders=false)

	delegateExternalEmails (string $subject, string $message, array $attachments, bool $usePlaceholders, array $usrIdToExternalEmailAddressesMap, array $usrIdToMessageMap)

	getUserIds (array $recipients)

	checkMail (string $to, string $cc, string $bcc, string $subject)

	checkRecipients (string $recipients)
	Check if recipients are valid. More...

	saveInSentbox (array $attachment, string $to, string $cc, string $bcc, string $subject, string $message)
	Stores a message in the sent bod of the current user. More...

	parseAddresses ($addresses)
	Explode recipient string, allowed separators are ',' ';' ' ' Returns an array with recipient ilMailAddress instances. More...

	getCountRecipient (string $recipients, $onlyExternalAddresses=true)

	getCountRecipients (string $toRecipients, string $ccRecipients, string $bccRecipients, $onlyExternalAddresses=true)

	getEmailRecipients (string $recipients)

	getUserInstanceById (int $usrId)

	getMailOptionsByUserId (int $usrId)

Protected Attributes inherited from ilMail
	$lng

	$db

	$mfile

	$mail_options

	$mailbox

	$table_mail

	$table_mail_saved

	$mail_data = array()

	$mail_obj_ref_id

	$save_in_sentbox

	$appendInstallationSignature = false

	$contextId = null

	$contextParameters = []

	$logger

	$mailOptionsByUsrIdMap = []

	$userInstancesByIdMap = []

	$usrIdByLoginCallable = null

	$maxRecipientCharacterLength = 998

	$senderFactory

Detailed Description

Class UserMail this class handles user mails.

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

Version: $Id$

Definition at line 15 of file class.ilFormatMail.php.

Constructor & Destructor Documentation

◆ __construct()

ilFormatMail::__construct ( $a_user_id )

Constructor setup an mail object.

Parameters

int	user_id public

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

References ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct($a_user_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ appendSearchResult()

ilFormatMail::appendSearchResult	(	$a_names,
		$a_type
	)

append search result to recipient public

Parameters

array	names to append
string	rcp type ('to','cc','bc')

Returns: string

Definition at line 129 of file class.ilFormatMail.php.

References $a_type, and ilMail\$mail_data.

     {
         if (empty($this->mail_data)) {
             return false;
         }
         $name_str = implode(',', $a_names);
         switch ($a_type) {
             case 'to':
                 $this->mail_data["rcp_to"] = trim($this->mail_data["rcp_to"]);
                 if ($this->mail_data["rcp_to"]) {
                     $this->mail_data["rcp_to"] = $this->mail_data["rcp_to"] . ",";
                 }
                 $this->mail_data["rcp_to"] = $this->mail_data["rcp_to"] . $name_str;
                 break;
 
             case 'cc':
                 $this->mail_data["rcp_cc"] = trim($this->mail_data["rcp_cc"]);
                 if ($this->mail_data["rcp_cc"]) {
                     $this->mail_data["rcp_cc"] = $this->mail_data["rcp_cc"] . ",";
                 }
                 $this->mail_data["rcp_cc"] = $this->mail_data["rcp_cc"] . $name_str;
                 break;
 
             case 'bc':
                 $this->mail_data["rcp_bcc"] = trim($this->mail_data["rcp_bcc"]);
                 if ($this->mail_data["rcp_bcc"]) {
                     $this->mail_data["rcp_bcc"] = $this->mail_data["rcp_bcc"] . ",";
                 }
                 $this->mail_data["rcp_bcc"] = $this->mail_data["rcp_bcc"] . $name_str;
                 break;
 
         }
         return $this->mail_data;
     }

◆ appendSignature()

ilFormatMail::appendSignature ( )

append signature to mail body public

Returns: string

Definition at line 194 of file class.ilFormatMail.php.

     {
         return $this->mail_data["m_message"] .= chr(13) . chr(10) . $this->mail_options->getSignature();
     }

◆ formatForwardSubject()

ilFormatMail::formatForwardSubject ( )

format a forward subject public

Returns: string

Definition at line 114 of file class.ilFormatMail.php.

     {
         if (empty($this->mail_data)) {
             return false;
         }
         return $this->mail_data["m_subject"] = "[FWD: " . $this->mail_data["m_subject"] . "]";
     }

◆ formatLinebreakMessage()

ilFormatMail::formatLinebreakMessage ( string $message )

Parameters

string $message

Returns: string

Definition at line 168 of file class.ilFormatMail.php.

References $i.

                                                             : string
     {
         $formatted = [];
 
         $linebreak = $this->mail_options->getLinebreak();
 
         $lines = explode(chr(10), $message);
         for ($i = 0; $i < count($lines); $i++) {
             if (substr($lines[$i], 0, 1) != '>') {
                 $formatted[] = wordwrap($lines[$i], $linebreak, chr(10));
             } else {
                 $formatted[] = $lines[$i];
             }
         }
         $formatted = implode(chr(10), $formatted);
 
         return $formatted;
     }

◆ formatReplyMessage()

ilFormatMail::formatReplyMessage ( )

format a reply message public

Returns: string

Definition at line 34 of file class.ilFormatMail.php.

References $i.

     {
         if (empty($this->mail_data)) {
             return false;
         }
 
         $bodylines = preg_split("/\r\n|\n|\r/", $this->mail_data["m_message"]);
         for ($i = 0; $i < count($bodylines); $i++) {
             $bodylines[$i] = "> " . $bodylines[$i];
         }
 
         return $this->mail_data["m_message"] = implode(chr(10), $bodylines);
     }

◆ formatReplyRecipient()

ilFormatMail::formatReplyRecipient ( )

get reply recipient public

Returns: string

Definition at line 98 of file class.ilFormatMail.php.

     {
         if (empty($this->mail_data)) {
             return false;
         }
 
         require_once './Services/User/classes/class.ilObjUser.php';
 
         $user = new ilObjUser($this->mail_data["sender_id"]);
         return $this->mail_data["rcp_to"] = $user->getLogin();
     }

◆ formatReplyRecipientsForCC()

ilFormatMail::formatReplyRecipientsForCC ( )

get reply recipients for cc public

Returns: string

Definition at line 66 of file class.ilFormatMail.php.

References $DIC.

     {
         global $DIC;
 
         if (empty($this->mail_data)) {
             return '';
         }
 
         $newCC = array();
 
         $currentUserLogin = $DIC->user()->getLogin();
 
         foreach (explode(',', $this->mail_data['rcp_to']) as $to) {
             if (trim($to) != '' && $currentUserLogin != trim($to)) {
                 $newCC[] = trim($to);
             }
         }
 
         foreach (explode(',', $this->mail_data['rcp_cc']) as $cc) {
             if (trim($cc) != '' && $currentUserLogin != trim($cc)) {
                 $newCC[] = trim($cc);
             }
         }
 
         return ($this->mail_data['rcp_cc'] = implode(', ', $newCC));
     }

◆ formatReplySubject()

ilFormatMail::formatReplySubject ( )

format a reply subject public

Returns: string

Definition at line 53 of file class.ilFormatMail.php.

     {
         if (empty($this->mail_data)) {
             return false;
         }
         return $this->mail_data["m_subject"] = "RE: " . $this->mail_data["m_subject"];
     }

◆ prependSignature()

ilFormatMail::prependSignature ( )

Returns: string

Definition at line 202 of file class.ilFormatMail.php.

     {
         return $this->mail_options->getSignature() . chr(13) . chr(10) . chr(13) . chr(10) . $this->mail_data["m_message"];
     }

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

Services/Mail/classes/class.ilFormatMail.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendSearchResult()

◆ appendSignature()

◆ formatForwardSubject()

◆ formatLinebreakMessage()

◆ formatReplyMessage()

◆ formatReplyRecipient()

◆ formatReplyRecipientsForCC()

◆ formatReplySubject()

◆ prependSignature()