Inheritance diagram for ilFormatMail:

Collaboration diagram for ilFormatMail:

Public Member Functions
	__construct (int $a_user_id)

	formatReplyRecipientsForCC ()

	formatReplyRecipient ()

	appendSearchResult (array $a_names, string $a_type)

	formatLinebreakMessage (string $message)

	appendSignature (string $message)

	prependSignature (string $message)

	formatReplyMessage (string $message)

	formatReplySubject (string $subject)

	formatForwardSubject (string $subject)

Public Member Functions inherited from ilMail
	__construct (int $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, ilObjUser $actor=null)

	withContextId (string $contextId)

	withContextParameters (array $parameters)

	existsRecipient (string $newRecipient, string $existingRecipients)

	setSaveInSentbox (bool $saveInSentbox)

	getSaveInSentbox ()

	getMailObjectReferenceId ()

	formatNamesForOutput (string $recipients)

	getPreviousMail (int $mailId)

	getNextMail (int $mailId)

	getMailsOfFolder (int $a_folder_id, array $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 $folderId)

	updateDraft (int $a_folder_id, array $a_attachments, string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, int $a_draft_id=0, bool $a_use_placeholders=false, ?string $a_tpl_context_id=null, array $a_tpl_context_params=[])

	persistToStage (int $a_user_id, array $a_attachments, string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, bool $a_use_placeholders=false, ?string $a_tpl_context_id=null, ?array $a_tpl_ctx_params=[])

	retrieveFromStage ()

	enqueue (string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, array $a_attachment, bool $a_use_placeholders=false)
	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 ilMail::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)

static	_getInstallationSignature ()

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

Data Fields inherited from ilMail
const	ILIAS_HOST = 'ilias'

const	PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix'

int	$user_id

Protected Member Functions inherited from ilMail
	isSystemMail ()

	readMailObjectReferenceId ()

	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)

	saveInSentbox (array $attachment, string $to, string $cc, string $bcc, string $subject, string $message)

	parseAddresses (string $addresses)
	Explode recipient string, allowed separators are ',' ';' ' '. More...

	getCountRecipient (string $recipients, bool $onlyExternalAddresses=true)

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

	getEmailRecipients (string $recipients)

	getUserInstanceById (int $usrId)

	getMailOptionsByUserId (int $usrId)

Protected Attributes inherited from ilMail
ilLanguage	$lng

ilDBInterface	$db

ilFileDataMail	$mfile

ilMailOptions	$mail_options

ilMailbox	$mailbox

string	$table_mail

string	$table_mail_saved

array	$mail_data = []

int	$mail_obj_ref_id = null

bool	$save_in_sentbox

bool	$appendInstallationSignature = false

string	$contextId = null

array	$contextParameters = []

ilLogger	$logger

array	$mailOptionsByUsrIdMap = []

array	$userInstancesByIdMap = []

	$usrIdByLoginCallable

int	$maxRecipientCharacterLength = 998

ilMailMimeSenderFactory	$senderFactory

ilObjUser	$actor

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om TODO All these utility functions could be moved to some kind of decorator once a mail is an elaborated object and not an array anymore

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

Constructor & Destructor Documentation

◆ __construct()

ilFormatMail::__construct ( int $a_user_id )

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

    {
        parent::__construct($a_user_id);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ appendSearchResult()

ilFormatMail::appendSearchResult	(	array	$a_names,
		string	$a_type
	)

Parameters

string[]	$a_names
string	$a_type

Returns: array

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

                                                                      : array
    {
        $name_str = implode(',', $a_names);
 
        $key = 'rcp_to';
        if ('cc' === $a_type) {
            $key = 'rcp_cc';
        } elseif ('bc' === $a_type) {
            $key = 'rcp_bcc';
        }
 
        if (!isset($this->mail_data[$key]) || !is_string($this->mail_data[$key])) {
            $this->mail_data[$key] = '';
        } else {
            $this->mail_data[$key] = trim($this->mail_data[$key]);
        }
 
        if ($this->mail_data[$key] !== '') {
            $this->mail_data[$key] .= ',';
        }
        $this->mail_data[$key] .= $name_str;
 
        return $this->mail_data;
    }

References ILIAS\LTI\ToolProvider\$key, and ilMail\$mail_data.

◆ appendSignature()

ilFormatMail::appendSignature ( string $message )

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

                                                    : string
    {
        $message .= chr(13) . chr(10) . $this->mail_options->getSignature();
 
        return $message;
    }

References $message.

◆ formatForwardSubject()

ilFormatMail::formatForwardSubject ( string $subject )

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

                                                         : string
    {
        return '[FWD: ' . $subject . ']';
    }

◆ formatLinebreakMessage()

ilFormatMail::formatLinebreakMessage ( string $message )

Reimplemented from ilMail.

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

                                                           : string
    {
        $formatted = [];
 
        $linebreak = $this->mail_options->getLinebreak();
 
        $lines = explode(chr(10), $message);
        foreach ($lines as $iValue) {
            if (strpos($iValue, '>') !== 0) {
                $formatted[] = wordwrap($iValue, $linebreak, chr(10));
            } else {
                $formatted[] = $iValue;
            }
        }
        return implode(chr(10), $formatted);
    }

References $message.

◆ formatReplyMessage()

ilFormatMail::formatReplyMessage ( string $message )

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

                                                       : string
    {
        $bodylines = preg_split("/\r\n|\n|\r/", $message);
        foreach ($bodylines as $i => $iValue) {
            $bodylines[$i] = '> ' . $iValue;
        }
 
        return implode(chr(10), $bodylines);
    }

References $i, and $message.

◆ formatReplyRecipient()

ilFormatMail::formatReplyRecipient ( )

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

                                          : string
    {
        if (empty($this->mail_data)) {
            return '';
        }
 
        $user = new ilObjUser((int) $this->mail_data['sender_id']);
        return $this->mail_data['rcp_to'] = $user->getLogin();
    }

◆ formatReplyRecipientsForCC()

ilFormatMail::formatReplyRecipientsForCC ( )

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

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

References $DIC.

◆ formatReplySubject()

ilFormatMail::formatReplySubject ( string $subject )

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

                                                       : string
    {
        return 'RE: ' . $subject;
    }

◆ prependSignature()

ilFormatMail::prependSignature ( string $message )

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

                                                     : string
    {
        return $this->mail_options->getSignature() .
            chr(13) .
            chr(10) .
            chr(13) .
            chr(10) .
            $message;
    }

References $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()