ilMail Class Reference

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

Public Member Functions
	__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)

Static Public Member Functions
static	_getAutoGeneratedMessageString (ilLanguage $lang=null)
	Get auto generated info string. More...
static	_getInstallationSignature ()
static	getSalutation ($a_usr_id, ilLanguage $a_language=null)

Data Fields
const	ILIAS_HOST = 'ilias'
const	PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix'
	$user_id

Protected Member Functions
	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
	$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

Private Member Functions
	sendInternalMail ( $folderId, $senderUsrId, $attachments, $to, $cc, $bcc, $status, $email, $subject, $message, $usrId=0, $usePlaceholders=0, $templateContextId=null, $templateContextParameters=[])
	sendMimeMail (string $to, string $cc, string $bcc, $subject, $message, array $attachments)

Private Attributes
	$eventHandler
	$mailAddressTypeFactory
	$mailAddressParserFactory

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

Definition at line 10 of file class.ilMail.php.

Constructor & Destructor Documentation

__construct()

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
	)

Parameters

integer	$a_user_id
ilMailAddressTypeFactory | null	$mailAddressTypeFactory
ilMailRfc822AddressParserFactory | null	$mailAddressParserFactory
ilAppEventHandler | null	$eventHandler
ilLogger | null	$logger
ilDBInterface | null	$db
ilLanguage | null	$lng
ilFileDataMail | null	$mailFileData
ilMailOptions | null	$mailOptions
ilMailbox | null	$mailBox
ilMailMimeSenderFactory | null	$senderFactory
callable | null	$usrIdByLoginCallable
int | null	$mailAdminNodeRefId

Definition at line 99 of file class.ilMail.php.

References $db, $DIC, $eventHandler, $GLOBALS, $lng, $logger, $login, $mailAddressParserFactory, $mailAddressTypeFactory, $senderFactory, $usrIdByLoginCallable, ilObjUser\_lookupId(), ilLoggerFactory\getLogger(), readMailObjectReferenceId(), and setSaveInSentbox().

      {
        global $DIC;

        if ($logger === null) {
            $logger = ilLoggerFactory::getLogger('mail');
        }
        if ($mailAddressTypeFactory === null) {
            $mailAddressTypeFactory = new ilMailAddressTypeFactory(null, $logger);
        }
        if ($mailAddressParserFactory === null) {
            $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
        }
        if ($eventHandler === null) {
            $eventHandler = $DIC->event();
        }
        if ($db === null) {
            $db = $DIC->database();
        }
        if ($lng === null) {
            $lng = $DIC->language();
        }
        if ($mailFileData === null) {
            $mailFileData = new ilFileDataMail($a_user_id);
        }
        if ($mailOptions === null) {
            $mailOptions = new ilMailOptions($a_user_id);
        }
        if ($mailBox === null) {
            $mailBox = new ilMailbox($a_user_id);
        }
        if ($senderFactory === null) {
            $senderFactory = $GLOBALS["DIC"]["mail.mime.sender.factory"];
        }
        if ($usrIdByLoginCallable === null) {
            $usrIdByLoginCallable = function (string $login) {
                return ilObjUser::_lookupId($login);
            };
        }

        $this->user_id = (int) $a_user_id;
        $this->mailAddressParserFactory = $mailAddressParserFactory;
        $this->mailAddressTypeFactory = $mailAddressTypeFactory;
        $this->eventHandler = $eventHandler;
        $this->logger = $logger;
        $this->db = $db;
        $this->lng = $lng;
        $this->mfile = $mailFileData;
        $this->mail_options = $mailOptions;
        $this->mailbox = $mailBox;
        $this->senderFactory = $senderFactory;
        $this->usrIdByLoginCallable = $usrIdByLoginCallable;

        $this->mail_obj_ref_id = $mailAdminNodeRefId;
        if (null === $this->mail_obj_ref_id) {
            $this->readMailObjectReferenceId();
        }

        $this->lng->loadLanguageModule('mail');
        $this->table_mail = 'mail';
        $this->table_mail_saved = 'mail_saved';
        $this->setSaveInSentbox(false);
    }

Here is the call graph for this function:

Member Function Documentation

_getAutoGeneratedMessageString()

static ilMail::_getAutoGeneratedMessageString ( ilLanguage  $lang = null )

static

Get auto generated info string.

Parameters

ilLanguage

$lang

Returns

string;

Definition at line 1600 of file class.ilMail.php.

References $DIC, $GLOBALS, $lang, $senderFactory, ilUtil\_getHttpPath(), ilLanguageFactory\_getLanguage(), and ILIAS_VERSION_NUMERIC.

Referenced by ilMailSummaryNotification\__construct(), ilECSAppEventListener\_sendNotification(), ilSystemNotification\compose(), ilECSObjectSettings\sendNewContentNotification(), and ilRemoteObjectBase\sendNewContentNotification().

                                                                                   : string
    {
        global $DIC;

        if (!($lang instanceof ilLanguage)) {
            $lang = ilLanguageFactory::_getLanguage();
        }

        $lang->loadLanguageModule('mail');

        return sprintf(
            $lang->txt('mail_auto_generated_info'),
            $DIC->settings()->get('inst_name', 'ILIAS ' . ((int) ILIAS_VERSION_NUMERIC)),
            ilUtil::_getHttpPath()
        ) . "\n\n";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getInstallationSignature()

static ilMail::_getInstallationSignature ( )

static

Returns

string The installation mail signature

Definition at line 1645 of file class.ilMail.php.

References $DIC, ilUtil\_getHttpPath(), CLIENT_ID, and ILIAS_WEB_DIR.

Referenced by ilRegistrationMimeMailNotification\__construct(), ilMailSummaryNotification\__construct(), ilForumMailNotification\addLinkToMail(), ilSystemNotification\compose(), ilForumMailEventNotificationSender\createAttachmentLinkText(), ilTimingsCronReminder\fillObjectListForMailBody(), ilObjSurveyGUI\getUserResultsPlain(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilMailCronOrphanedMailsNotification\send(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), ilWikiUtil\sendNotification(), and ilObjUserGUI\showUpperIcon().

                                                       : string
    {
        global $DIC;

        $signature = $DIC->settings()->get('mail_system_sys_signature');

        $clientUrl = ilUtil::_getHttpPath();
        $clientdirs = glob(ILIAS_WEB_DIR . '/*', GLOB_ONLYDIR);
        if (is_array($clientdirs) && count($clientdirs) > 1) {
            $clientUrl .= '/login.php?client_id=' . CLIENT_ID; // #18051
        }

        $signature = str_ireplace('[CLIENT_NAME]', $DIC['ilClientIniFile']->readVariable('client', 'name'), $signature);
        $signature = str_ireplace(
            '[CLIENT_DESC]',
            $DIC['ilClientIniFile']->readVariable('client', 'description'),
            $signature
        );
        $signature = str_ireplace('[CLIENT_URL]', $clientUrl, $signature);

        if (!preg_match('/^[\n\r]+/', $signature)) {
            $signature = "\n" . $signature;
        }

        return $signature;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendInstallationSignature()

ilMail::appendInstallationSignature

(

bool

$a_flag = null

)

Parameters

bool | null

$a_flag

Returns

self|bool

Definition at line 1632 of file class.ilMail.php.

References $appendInstallationSignature.

Referenced by enqueue().

    {
        if (null === $a_flag) {
            return $this->appendInstallationSignature;
        }

        $this->appendInstallationSignature = $a_flag;
        return $this;
    }

Here is the caller graph for this function:

checkMail()

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

protected

Parameters

string	$to
string	$cc
string	$bcc
string	$subject

Returns

ilMailError[] An array of errors determined on validation

Definition at line 1056 of file class.ilMail.php.

References $errors.

Referenced by enqueue().

                                                                                       : array
    {
        $errors = [];

        foreach ([
                     $subject => 'mail_add_subject',
                     $to => 'mail_add_recipient'
                 ] as $string => $error
        ) {
            if (0 === strlen($string)) {
                $errors[] = new ilMailError($error);
            }
        }

        return $errors;
    }

Here is the caller graph for this function:

checkRecipients()

ilMail::checkRecipients ( string  $recipients )

protected

Check if recipients are valid.

Parameters

string

$recipients

Returns

ilMailError[] An array of errors determined on validation

Exceptions

ilMailException

Definition at line 1079 of file class.ilMail.php.

References Vendor\Package\$e, $errors, and parseAddresses().

Referenced by validateRecipients().

                                                           : array
    {
        $errors = [];

        try {
            $addresses = $this->parseAddresses($recipients);
            foreach ($addresses as $address) {
                $addressType = $this->mailAddressTypeFactory->getByPrefix($address);
                if (!$addressType->validate($this->user_id)) {
                    $newErrors = $addressType->getErrors();
                    $errors = array_merge($errors, $newErrors);
                }
            }
        } catch (ilException $e) {
            $colonPosition = strpos($e->getMessage(), ':');
            throw new ilMailException(
                ($colonPosition === false) ? $e->getMessage() : substr($e->getMessage(), $colonPosition + 2)
            );
        }

        return $errors;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

countMailsOfFolder()

ilMail::countMailsOfFolder

(

int

$folderId

)

Parameters

int

$folderId

Returns

int

Definition at line 385 of file class.ilMail.php.

References $res.

                                                      : int
    {
        $res = $this->db->queryF(
            "SELECT COUNT(*) FROM {$this->table_mail} WHERE user_id = %s AND folder_id = %s",
            ['integer', 'integer'],
            [$this->user_id, $folderId]
        );

        return $this->db->numRows($res);
    }

delegateExternalEmails()

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

protected

Parameters

string	$subject
string	$message
array	$attachments
bool	$usePlaceholders
array	$usrIdToExternalEmailAddressesMap
array	$usrIdToMessageMap

Definition at line 943 of file class.ilMail.php.

References formatLinebreakMessage(), sendMimeMail(), and ilStr\strLen().

Referenced by sendChanneledMails().

      : void {
        if (1 === count($usrIdToExternalEmailAddressesMap)) {
            if ($usePlaceholders) {
                $message = array_values($usrIdToMessageMap)[0];
            }

            $usrIdToExternalEmailAddressesMap = array_values($usrIdToExternalEmailAddressesMap);
            $firstAddresses = current($usrIdToExternalEmailAddressesMap);

            $this->sendMimeMail(
                implode(',', $firstAddresses),
                '',
                '',
                $subject,
                $this->formatLinebreakMessage($message),
                (array) $attachments
            );
        } elseif (count($usrIdToExternalEmailAddressesMap) > 1) {
            if ($usePlaceholders) {
                foreach ($usrIdToExternalEmailAddressesMap as $usrId => $addresses) {
                    if (0 === count($addresses)) {
                        continue;
                    }

                    $this->sendMimeMail(
                        implode(',', $addresses),
                        '',
                        '',
                        $subject,
                        $this->formatLinebreakMessage($usrIdToMessageMap[$usrId]),
                        (array) $attachments
                    );
                }
            } else {
                $flattenEmailAddresses = iterator_to_array(new RecursiveIteratorIterator(new RecursiveArrayIterator(
                    $usrIdToExternalEmailAddressesMap
                )), false);

                $flattenEmailAddresses = array_unique($flattenEmailAddresses);

                // https://mantis.ilias.de/view.php?id=23981 and https://www.ietf.org/rfc/rfc2822.txt
                $remainingAddresses = '';
                foreach ($flattenEmailAddresses as $emailAddress) {
                    $sep = '';
                    if (strlen($remainingAddresses) > 0) {
                        $sep = ',';
                    }

                    $recipientsLineLength = ilStr::strLen($remainingAddresses) + ilStr::strLen($sep . $emailAddress);
                    if ($recipientsLineLength >= $this->maxRecipientCharacterLength) {
                        $this->sendMimeMail(
                            '',
                            '',
                            $remainingAddresses,
                            $subject,
                            $this->formatLinebreakMessage($message),
                            (array) $attachments
                        );

                        $remainingAddresses = '';
                        $sep = '';
                    }

                    $remainingAddresses .= ($sep . $emailAddress);
                }

                if ('' !== $remainingAddresses) {
                    $this->sendMimeMail(
                        '',
                        '',
                        $remainingAddresses,
                        $subject,
                        $this->formatLinebreakMessage($message),
                        (array) $attachments
                    );
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteMails()

ilMail::deleteMails

(

array

$mailIds

)

Parameters

int[]

$mailIds

Definition at line 497 of file class.ilMail.php.

Referenced by deleteMailsOfFolder(), and sendMail().

                                                : void
    {
        $mailIds = array_filter(array_map('intval', $mailIds));
        foreach ($mailIds as $id) {
            $this->db->manipulateF(
                "DELETE FROM {$this->table_mail} WHERE user_id = %s AND mail_id = %s",
                ['integer', 'integer'],
                [$this->user_id, $id]
            );
            $this->mfile->deassignAttachmentFromDirectory($id);
        }
    }

Here is the caller graph for this function:

deleteMailsOfFolder()

ilMail::deleteMailsOfFolder

(

int

$folderId

)

Parameters

int

$folderId

Definition at line 399 of file class.ilMail.php.

References $mail_data, deleteMails(), and getMailsOfFolder().

                                                       : void
    {
        $mails = $this->getMailsOfFolder($folderId);
        foreach ($mails as $mail_data) {
            $this->deleteMails([$mail_data['mail_id']]);
        }
    }

Here is the call graph for this function:

distributeMail()

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

protected

Parameters

string	$to
string	$cc
string	$bcc
string	$subject
string	$message
array	$attachments
int	$sentMailId
bool	$usePlaceholders

Returns

bool

Definition at line 738 of file class.ilMail.php.

References getUserIds(), replacePlaceholders(), and sendChanneledMails().

Referenced by sendMail().

      : bool {
        if ($usePlaceholders) {
            $toUsrIds = $this->getUserIds([$to]);
            $this->logger->debug(sprintf(
                "Parsed TO user ids from given recipients for serial letter notification: %s",
                implode(', ', $toUsrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $toUsrIds,
                $subject,
                $message,
                $attachments,
                $sentMailId,
                true
            );

            $otherUsrIds = $this->getUserIds([$cc, $bcc]);
            $this->logger->debug(sprintf(
                "Parsed CC/BCC user ids from given recipients for serial letter notification: %s",
                implode(', ', $otherUsrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $otherUsrIds,
                $subject,
                $this->replacePlaceholders($message, 0, false),
                $attachments,
                $sentMailId,
                false
            );
        } else {
            $usrIds = $this->getUserIds([$to, $cc, $bcc]);
            $this->logger->debug(sprintf(
                "Parsed TO/CC/BCC user ids from given recipients: %s",
                implode(', ', $usrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $usrIds,
                $subject,
                $message,
                $attachments,
                $sentMailId,
                false
            );
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enqueue()

ilMail::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'.

A validation is executed before, errors are returned

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
string	$a_m_subject
string	$a_m_message
array	$a_attachment
bool | int	$a_use_placeholders

Returns

ilMailError[]

Definition at line 1204 of file class.ilMail.php.

References $DIC, $errors, appendInstallationSignature(), checkMail(), ilContext\CONTEXT_CRON, getCountRecipients(), getSaveInSentbox(), ilContext\getType(), isSystemMail(), sendMail(), and validateRecipients().

      : array {
        global $DIC;

        $this->logger->info(
            "New mail system task:" .
            " To: " . $a_rcp_to .
            " | CC: " . $a_rcp_cc .
            " | BCC: " . $a_rcp_bcc .
            " | Subject: " . $a_m_subject .
            " | Attachments: " . print_r($a_attachment, true)
        );

        if ($a_attachment && !$this->mfile->checkFilesExist($a_attachment)) {
            return [new ilMailError('mail_attachment_file_not_exist', [$a_attachment])];
        }

        $errors = $this->checkMail((string) $a_rcp_to, (string) $a_rcp_cc, (string) $a_rcp_bcc, (string) $a_m_subject);
        if (count($errors) > 0) {
            return $errors;
        }

        $errors = $this->validateRecipients((string) $a_rcp_to, (string) $a_rcp_cc, (string) $a_rcp_bcc);
        if (count($errors) > 0) {
            return $errors;
        }

        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bcc = $a_rcp_bcc;

        if (null === $rcp_cc) {
            $rcp_cc = '';
        }

        if (null === $rcp_bcc) {
            $rcp_bcc = '';
        }

        $numberOfExternalAddresses = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bcc, true);
        if (
            $numberOfExternalAddresses > 0 &&
            !$this->isSystemMail() &&
            !$DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'smtp_mail', $this->mail_obj_ref_id)
        ) {
            return [new ilMailError('mail_no_permissions_write_smtp')];
        }

        if ($this->appendInstallationSignature()) {
            $a_m_message .= self::_getInstallationSignature();
        }

        if (ilContext::getType() == ilContext::CONTEXT_CRON) {
            return $this->sendMail(
                (string) $rcp_to,
                (string) $rcp_cc,
                (string) $rcp_bcc,
                (string) $a_m_subject,
                (string) $a_m_message,
                (array) $a_attachment,
                (bool) $a_use_placeholders
            );
        }

        $taskFactory = $DIC->backgroundTasks()->taskFactory();
        $taskManager = $DIC->backgroundTasks()->taskManager();

        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);

        $task = $taskFactory->createTask(ilMailDeliveryJob::class, [
            (int) $this->user_id,
            (string) $rcp_to,
            (string) $rcp_cc,
            (string) $rcp_bcc,
            (string) $a_m_subject,
            (string) $a_m_message,
            (string) serialize($a_attachment),
            (bool) $a_use_placeholders,
            (bool) $this->getSaveInSentbox(),
            (string) $this->contextId,
            (string) serialize($this->contextParameters)
        ]);
        $interaction = $taskFactory->createTask(ilMailDeliveryJobUserInteraction::class, [
            $task,
            (int) $this->user_id
        ]);

        $bucket->setTask($interaction);
        $bucket->setTitle($this->lng->txt('mail_bg_task_title'));
        $bucket->setDescription(sprintf($this->lng->txt('mail_bg_task_desc'), $a_m_subject));

        $this->logger->info('Delegated delivery to background task');
        $taskManager->run($bucket);

        return [];
    }

Here is the call graph for this function:

existsRecipient()

ilMail::existsRecipient	(	string	$newRecipient,
		string	$existingRecipients
	)

Parameters

string	$newRecipient
string	$existingRecipients

Returns

bool

Definition at line 215 of file class.ilMail.php.

References parseAddresses().

                                                                                      : bool
    {
        $newAddresses = new ilMailAddressListImpl($this->parseAddresses($newRecipient));
        $addresses = new ilMailAddressListImpl($this->parseAddresses($existingRecipients));

        $list = new ilMailDiffAddressList($newAddresses, $addresses);

        $diffedAddresses = $list->value();

        return count($diffedAddresses) === 0;
    }

Here is the call graph for this function:

fetchMailData()

ilMail::fetchMailData ( ?array  $row )

protected

Parameters

array | null

$row

Returns

array|null

Definition at line 514 of file class.ilMail.php.

Referenced by getMail(), getMailsOfFolder(), getNextMail(), getPreviousMail(), and getSavedData().

                                                  : ?array
    {
        if (!is_array($row) || empty($row)) {
            return null;
        }

        $row['attachments'] = unserialize(stripslashes($row['attachments']));
        $row['tpl_ctx_params'] = (array) (@json_decode($row['tpl_ctx_params'], true));

        return $row;
    }

Here is the caller graph for this function:

formatLinebreakMessage()

ilMail::formatLinebreakMessage

(

string

$message

)

Definition at line 1748 of file class.ilMail.php.

References $message.

Referenced by delegateExternalEmails(), sendInternalMail(), and sendMail().

                                                            : string
    {
        return $message;
    }

Here is the caller graph for this function:

formatNamesForOutput()

ilMail::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.

Parameters

string

$recipients

A string containing to, cc or bcc recipients

Returns

string

Definition at line 265 of file class.ilMail.php.

References $DIC, ilObjUser\_lookupId(), ilObjUser\_lookupPref(), and getUserInstanceById().

                                                             : string
    {
        global $DIC;

        $recipients = trim($recipients);
        if (0 === strlen($recipients)) {
            return $this->lng->txt('not_available');
        }

        $names = [];

        $recipients = array_filter(array_map('trim', explode(',', $recipients)));
        foreach ($recipients as $recipient) {
            $usrId = ilObjUser::_lookupId($recipient);
            if ($usrId > 0) {
                $pp = ilObjUser::_lookupPref($usrId, 'public_profile');
                if ($pp === 'g' || ($pp === 'y' && !$DIC->user()->isAnonymous())) {
                    $user = $this->getUserInstanceById($usrId);
                    if ($user) {
                        $names[] = $user->getFullname() . ' [' . $recipient . ']';
                        continue;
                    }
                }
            }

            $names[] = $recipient;
        }

        return implode(', ', $names);
    }

Here is the call graph for this function:

getCountRecipient()

ilMail::getCountRecipient ( string  $recipients,   $onlyExternalAddresses = true  )

protected

Parameters

string	$recipients
bool	$onlyExternalAddresses

Returns

int

Definition at line 1542 of file class.ilMail.php.

References parseAddresses().

Referenced by getCountRecipients().

                                                                                            : int
    {
        $addresses = new ilMailAddressListImpl($this->parseAddresses($recipients));
        if ($onlyExternalAddresses) {
            $addresses = new ilMailOnlyExternalAddressList(
                $addresses,
                self::ILIAS_HOST,
                $this->usrIdByLoginCallable
            );
        }

        return count($addresses->value());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCountRecipients()

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

protected

Parameters

string	$toRecipients
string	$ccRecipients
	$bccRecipients
bool	$onlyExternalAddresses

Returns

int

Definition at line 1563 of file class.ilMail.php.

References getCountRecipient().

Referenced by enqueue(), and sendMail().

      : int {
        return (
            $this->getCountRecipient($toRecipients, $onlyExternalAddresses) +
            $this->getCountRecipient($ccRecipients, $onlyExternalAddresses) +
            $this->getCountRecipient($bccRecipients, $onlyExternalAddresses)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEmailRecipients()

ilMail::getEmailRecipients ( string  $recipients )

protected

Parameters

string

$recipients

Returns

string

Definition at line 1580 of file class.ilMail.php.

References parseAddresses().

Referenced by sendMail().

                                                              : string
    {
        $addresses = new ilMailOnlyExternalAddressList(
            new ilMailAddressListImpl($this->parseAddresses($recipients)),
            self::ILIAS_HOST,
            $this->usrIdByLoginCallable
        );

        $emailRecipients = array_map(function (ilMailAddress $address) {
            return (string) $address;
        }, $addresses->value());

        return implode(',', $emailRecipients);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMail()

ilMail::getMail

(

int

$mailId

)

Parameters

int

$mailId

Returns

array|null

Definition at line 411 of file class.ilMail.php.

References $mail_data, $res, and fetchMailData().

                                         : ?array
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->table_mail} WHERE user_id = %s AND mail_id = %s",
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

Here is the call graph for this function:

getMailObjectReferenceId()

ilMail::getMailObjectReferenceId

(

)

Returns

int

Definition at line 254 of file class.ilMail.php.

References $mail_obj_ref_id.

                                               : int
    {
        return $this->mail_obj_ref_id;
    }

getMailOptionsByUserId()

ilMail::getMailOptionsByUserId ( int  $usrId )

protected

Parameters

int

$usrId

Returns

ilMailOptions

Definition at line 1727 of file class.ilMail.php.

Referenced by sendChanneledMails().

                                                          : ilMailOptions
    {
        if (!isset($this->mailOptionsByUsrIdMap[$usrId])) {
            $this->mailOptionsByUsrIdMap[$usrId] = new ilMailOptions($usrId);
        }

        return $this->mailOptionsByUsrIdMap[$usrId];
    }

Here is the caller graph for this function:

getMailsOfFolder()

ilMail::getMailsOfFolder	(		$a_folder_id,
			$filter = []
	)

Parameters

int	$a_folder_id	The id of the folder
array	$filter	An optional filter array

Returns

array

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

References $query, $res, and fetchMailData().

Referenced by deleteMailsOfFolder(), and ilPDMailBlockGUI\getMails().

                                                                 : array
    {
        $mails = [];

        $query =
            "SELECT sender_id, m_subject, mail_id, m_status, send_time " .
            "FROM {$this->table_mail} " .
            "LEFT JOIN object_data ON obj_id = sender_id " .
            "WHERE user_id = %s AND folder_id = %s " .
            "AND ((sender_id > 0 AND sender_id IS NOT NULL AND obj_id IS NOT NULL) OR (sender_id = 0 OR sender_id IS NULL))";

        if (isset($filter['status']) && strlen($filter['status']) > 0) {
            $query .= ' AND m_status = ' . $this->db->quote($filter['status'], 'text');
        }

        $query .= " ORDER BY send_time DESC";

        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $a_folder_id]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $mails[] = $this->fetchMailData($row);
        }

        return array_filter($mails);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewDraftId()

ilMail::getNewDraftId	(	int	$usrId,
		int	$folderId
	)

Parameters

int	$usrId
int	$folderId

Returns

int

Definition at line 531 of file class.ilMail.php.

                                                             : int
    {
        $nextId = (int) $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, [
            'mail_id' => ['integer', $nextId],
            'user_id' => ['integer', $usrId],
            'folder_id' => ['integer', $folderId],
            'sender_id' => ['integer', $usrId]
        ]);

        return $nextId;
    }

getNextMail()

ilMail::getNextMail

(

int

$mailId

)

Parameters

int

$mailId

Returns

array|null

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

References $mail_data, $query, $res, and fetchMailData().

                                             : ?array
    {
        $this->db->setLimit(1, 0);

        $query = implode(' ', [
            "SELECT b.* FROM {$this->table_mail} a",
            "INNER JOIN {$this->table_mail} b ON b.folder_id = a.folder_id",
            'AND b.user_id = a.user_id AND b.send_time < a.send_time',
            'WHERE a.user_id = %s AND a.mail_id = %s ORDER BY b.send_time DESC',
        ]);
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

Here is the call graph for this function:

getPreviousMail()

ilMail::getPreviousMail

(

int

$mailId

)

Parameters

int

$mailId

Returns

array|null

Definition at line 300 of file class.ilMail.php.

References $mail_data, $query, $res, and fetchMailData().

                                                 : ?array
    {
        $this->db->setLimit(1, 0);

        $query = implode(' ', [
            "SELECT b.* FROM {$this->table_mail} a",
            "INNER JOIN {$this->table_mail} b ON b.folder_id = a.folder_id",
            'AND b.user_id = a.user_id AND b.send_time > a.send_time',
            'WHERE a.user_id = %s AND a.mail_id = %s ORDER BY b.send_time ASC',
        ]);
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

Here is the call graph for this function:

getSalutation()

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

static

Parameters

int	$a_usr_id
	$a_language	ilLanguage|null

Returns

string

Definition at line 1677 of file class.ilMail.php.

References $DIC, $lang, $name, ilObjUser\_lookupGender(), and ilObjUser\_lookupName().

Referenced by ilMailSummaryNotification\__construct(), ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilForumMailNotification\createMail(), ilForumMailEventNotificationSender\createMailBodyText(), ilObjSurveyGUI\getUserResultsPlain(), ilChatroom\isOwnerOfPrivateRoom(), ilRegistrationMailNotification\send(), ilMailCronOrphanedMailsNotification\send(), ilSessionMembershipMailNotification\send(), ilBuddySystemNotification\send(), ilExerciseMailNotification\send(), ilLMMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilLearningSequenceMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

                                                                                   : string
    {
        global $DIC;

        $lang = ($a_language instanceof ilLanguage) ? $a_language : $DIC->language();
        $lang->loadLanguageModule('mail');

        $gender = ilObjUser::_lookupGender($a_usr_id);
        $gender = $gender ? $gender : 'n';
        $name = ilObjUser::_lookupName($a_usr_id);

        if (!strlen($name['firstname'])) {
            return $lang->txt('mail_salutation_anonymous') . ',';
        }

        return
            $lang->txt('mail_salutation_' . $gender) . ' ' .
            ($name['title'] ? $name['title'] . ' ' : '') .
            ($name['firstname'] ? $name['firstname'] . ' ' : '') .
            $name['lastname'] . ',';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSavedData()

ilMail::getSavedData

(

)

Returns

array|null

Definition at line 1180 of file class.ilMail.php.

References $mail_data, $res, and fetchMailData().

Referenced by ilObjUserFolderGUI\mailObject(), and savePostData().

                                   : ?array
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->table_mail_saved} WHERE user_id = %s",
            ['integer'],
            [$this->user_id]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveInSentbox()

ilMail::getSaveInSentbox

(

)

Returns

bool

Definition at line 238 of file class.ilMail.php.

References $save_in_sentbox.

Referenced by enqueue(), and sendMail().

                                       : bool
    {
        return (bool) $this->save_in_sentbox;
    }

Here is the caller graph for this function:

getUserIds()

ilMail::getUserIds ( array  $recipients )

protected

Parameters

string[]

$recipients

Returns

int[]

Definition at line 1034 of file class.ilMail.php.

References parseAddresses().

Referenced by distributeMail().

                                                     : array
    {
        $usrIds = array();

        $joinedRecipients = implode(',', array_filter(array_map('trim', $recipients)));

        $addresses = $this->parseAddresses($joinedRecipients);
        foreach ($addresses as $address) {
            $addressType = $this->mailAddressTypeFactory->getByPrefix($address);
            $usrIds = array_merge($usrIds, $addressType->resolve());
        }

        return array_unique($usrIds);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserInstanceById()

ilMail::getUserInstanceById ( int  $usrId )

protected

Definition at line 1699 of file class.ilMail.php.

References Vendor\Package\$e.

Referenced by formatNamesForOutput(), replacePlaceholders(), and sendChanneledMails().

                                                       : ?ilObjUser
    {
        if (!array_key_exists($usrId, $this->userInstancesByIdMap)) {
            try {
                $user = new ilObjUser($usrId);
            } catch (Exception $e) {
                $user = null;
            }

            $this->userInstancesByIdMap[$usrId] = $user;
        }

        return $this->userInstancesByIdMap[$usrId];
    }

Here is the caller graph for this function:

isSystemMail()

ilMail::isSystemMail ( )

protected

Returns

bool

Definition at line 205 of file class.ilMail.php.

References ANONYMOUS_USER_ID.

Referenced by enqueue(), and sendChanneledMails().

                                      : bool
    {
        return $this->user_id == ANONYMOUS_USER_ID;
    }

Here is the caller graph for this function:

markRead()

ilMail::markRead

(

array

$mailIds

)

Parameters

int[]

$mailIds

Definition at line 427 of file class.ilMail.php.

References $query.

                                             : void
    {
        $values = [];
        $types = [];

        $query = "UPDATE {$this->table_mail} SET m_status = %s WHERE user_id = %s ";
        array_push($types, 'text', 'integer');
        array_push($values, 'read', $this->user_id);

        if (count($mailIds) > 0) {
            $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');
        }

        $this->db->manipulateF($query, $types, $values);
    }

markUnread()

ilMail::markUnread

(

array

$mailIds

)

Parameters

int[]

$mailIds

Definition at line 446 of file class.ilMail.php.

References $query.

                                               : void
    {
        $values = array();
        $types = array();

        $query = "UPDATE {$this->table_mail} SET m_status = %s WHERE user_id = %s ";
        array_push($types, 'text', 'integer');
        array_push($values, 'unread', $this->user_id);

        if (count($mailIds) > 0) {
            $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');
        }

        $this->db->manipulateF($query, $types, $values);
    }

moveMailsToFolder()

ilMail::moveMailsToFolder	(	array	$mailIds,
		int	$folderId
	)

Parameters

	int[]	$mailIds
int	$folderId

Returns

bool

Definition at line 467 of file class.ilMail.php.

References $query.

                                                                     : bool
    {
        $values = [];
        $types = [];

        $mailIds = array_filter(array_map('intval', $mailIds));

        if (0 === count($mailIds)) {
            return false;
        }

        $query =
            "UPDATE {$this->table_mail} " .
            "INNER JOIN mail_obj_data " .
            "ON mail_obj_data.obj_id = %s AND mail_obj_data.user_id = %s " .
            "SET {$this->table_mail}.folder_id = mail_obj_data.obj_id " .
            "WHERE {$this->table_mail}.user_id = %s";
        array_push($types, 'integer', 'integer', 'integer');
        array_push($values, $folderId, $this->user_id, $this->user_id);

        $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');

        $affectedRows = $this->db->manipulateF($query, $types, $values);

        return $affectedRows > 0;
    }

parseAddresses()

ilMail::parseAddresses (   $addresses )

protected

Explode recipient string, allowed separators are ',' ';' ' ' Returns an array with recipient ilMailAddress instances.

Parameters

string

$addresses

Returns

ilMailAddress[] An array with objects of type ilMailAddress

Definition at line 1513 of file class.ilMail.php.

Referenced by checkRecipients(), existsRecipient(), getCountRecipient(), getEmailRecipients(), and getUserIds().

                                                  : array
    {
        if (strlen($addresses) > 0) {
            $this->logger->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }

        $parser = $this->mailAddressParserFactory->getParser((string) $addresses);
        $parsedAddresses = $parser->parse();

        if (strlen($addresses) > 0) {
            $this->logger->debug(sprintf(
                "Parsed addresses: %s",
                implode(',', array_map(function (ilMailAddress $address) {
                    return (string) $address;
                }, $parsedAddresses))
            ));
        }

        return $parsedAddresses;
    }

Here is the caller graph for this function:

readMailObjectReferenceId()

ilMail::readMailObjectReferenceId ( )

protected

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

Definition at line 246 of file class.ilMail.php.

References ilMailGlobalServices\getMailObjectRefId().

Referenced by __construct().

                                                   : void
    {
        $this->mail_obj_ref_id = (int) ilMailGlobalServices::getMailObjectRefId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replacePlaceholders()

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

protected

Parameters

string	$message
int	$usrId
boolean	$replaceEmptyPlaceholders

Returns

string

Definition at line 704 of file class.ilMail.php.

References $context, Vendor\Package\$e, $message, ilMailTemplateContextService\getTemplateContextById(), and getUserInstanceById().

Referenced by distributeMail(), sendChanneledMails(), sendInternalMail(), and sendMail().

      : string {
        try {
            if ($this->contextId) {
                $context = ilMailTemplateContextService::getTemplateContextById($this->contextId);
            } else {
                $context = new ilMailTemplateGenericContext();
            }

            $user = $usrId > 0 ? $this->getUserInstanceById($usrId) : null;

            $processor = new ilMailTemplatePlaceholderResolver($context, $message);
            $message = $processor->resolve($user, $this->contextParameters, $replaceEmptyPlaceholders);
        } catch (Exception $e) {
            $this->logger->error(__METHOD__ . ' has been called with invalid context.');
        }

        return $message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAttachments()

ilMail::saveAttachments

(

array

$attachments

)

Parameters

string[]

$attachments An array of attachments

Definition at line 1494 of file class.ilMail.php.

                                                        : void
    {
        $this->db->update(
            $this->table_mail_saved,
            [
                'attachments' => ['clob', serialize($attachments)]
            ],
            [
                'user_id' => ['integer', $this->user_id]
            ]
        );
    }

saveInSentbox()

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

protected

Stores a message in the sent bod of the current user.

Parameters

array	$attachment
string	$to
string	$cc
string	$bcc
string	$subject
string	$message

Returns

int mail id

Definition at line 1431 of file class.ilMail.php.

References $message, $user_id, and sendInternalMail().

Referenced by sendMail().

      : int {
        return $this->sendInternalMail(
            $this->mailbox->getSentFolder(),
            $this->user_id,
            $attachment,
            $to,
            $cc,
            $bcc,
            'read',
            0,
            $subject,
            $message,
            $this->user_id,
            0
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePostData()

ilMail::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

Parameters

int	$a_user_id
array	$a_attachments
string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
int	$a_m_email
string	$a_m_subject
string	$a_m_message
int	$a_use_placeholders
string | null	$a_tpl_context_id
array | null	$a_tpl_ctx_params

Returns

bool

Definition at line 1118 of file class.ilMail.php.

References getSavedData().

Referenced by ilObjUserFolderGUI\mailObject().

      {
        if (!$a_attachments) {
            $a_attachments = null;
        }
        if (!$a_rcp_to) {
            $a_rcp_to = null;
        }
        if (!$a_rcp_cc) {
            $a_rcp_cc = null;
        }
        if (!$a_rcp_bcc) {
            $a_rcp_bcc = null;
        }
        if (!$a_m_email) {
            $a_m_email = null;
        }
        if (!$a_m_message) {
            $a_m_message = null;
        }
        if (!$a_use_placeholders) {
            $a_use_placeholders = '0';
        }

        $this->db->replace(
            $this->table_mail_saved,
            [
                'user_id' => ['integer', $this->user_id]
            ],
            [
                'attachments' => ['clob', serialize($a_attachments)],
                'rcp_to' => ['clob', $a_rcp_to],
                'rcp_cc' => ['clob', $a_rcp_cc],
                'rcp_bcc' => ['clob', $a_rcp_bcc],
                'm_email' => ['integer', $a_m_email],
                'm_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', json_encode((array) $a_tpl_ctx_params)]
            ]
        );

        $this->getSavedData();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendChanneledMails()

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

protected

Parameters

string	$to
string	$cc
string	$bcc
array	$usrIds
string	$subject
string	$message
array	$attachments
int	$sentMailId
bool	$usePlaceholders

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

References $mailbox, $message, delegateExternalEmails(), getMailOptionsByUserId(), getUserInstanceById(), ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, isSystemMail(), replacePlaceholders(), and sendInternalMail().

Referenced by distributeMail().

      : void {
        $usrIdToExternalEmailAddressesMap = [];
        $usrIdToMessageMap = [];

        foreach ($usrIds as $usrId) {
            $user = $this->getUserInstanceById($usrId);
            if (!($user instanceof ilObjUser)) {
                $this->logger->critical(sprintf(
                    "Skipped recipient with id %s (User not found)",
                    $usrId
                ));
                continue;
            }

            $mailOptions = $this->getMailOptionsByUserId($user->getId());

            $canReadInternalMails = !$user->hasToAcceptTermsOfService() && $user->checkTimeLimit();

            if ($this->isSystemMail() && !$canReadInternalMails) {
                $this->logger->debug(sprintf(
                    "Skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                    $usrId,
                    var_export(!$user->hasToAcceptTermsOfService(), true),
                    var_export(!$user->checkTimeLimit(), true)
                ));
                continue;
            }

            $individualMessage = $message;
            if ($usePlaceholders) {
                $individualMessage = $this->replacePlaceholders($message, $user->getId());
                $usrIdToMessageMap[$user->getId()] = $individualMessage;
            }

            if ($user->getActive()) {
                $wantsToReceiveExternalEmail = (
                    $mailOptions->getIncomingType() == ilMailOptions::INCOMING_EMAIL ||
                    $mailOptions->getIncomingType() == ilMailOptions::INCOMING_BOTH
                );

                if (!$canReadInternalMails || $wantsToReceiveExternalEmail) {
                    $emailAddresses = $mailOptions->getExternalEmailAddresses();
                    $usrIdToExternalEmailAddressesMap[$user->getId()] = $emailAddresses;

                    if ($mailOptions->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                        $this->logger->debug(sprintf(
                            "Recipient with id %s will only receive external emails sent to: %s",
                            $user->getId(),
                            implode(', ', $emailAddresses)
                        ));
                        continue;
                    } else {
                        $this->logger->debug(sprintf(
                            "Recipient with id %s will additionally receive external emails " .
                            "(because the user wants to receive it externally, or the user cannot access " .
                            "the internal mail system) sent to: %s",
                            $user->getId(),
                            implode(', ', $emailAddresses)
                        ));
                    }
                } else {
                    $this->logger->debug(sprintf(
                        "Recipient with id %s is does not want to receive external emails",
                        $user->getId()
                    ));
                }
            } else {
                $this->logger->debug(sprintf(
                    "Recipient with id %s is inactive and will not receive external emails",
                    $user->getId()
                ));
            }

            $mbox = clone $this->mailbox;
            $mbox->setUsrId((int) $user->getId());
            $recipientInboxId = $mbox->getInboxFolder();

            $internalMailId = $this->sendInternalMail(
                $recipientInboxId,
                $this->user_id,
                $attachments,
                $to,
                $cc,
                '',
                'unread',
                0,
                $subject,
                $individualMessage,
                $user->getId(),
                0
            );

            if (count($attachments) > 0) {
                $this->mfile->assignAttachmentsToDirectory($internalMailId, $sentMailId);
            }
        }

        $this->delegateExternalEmails(
            $subject,
            $message,
            $attachments,
            $usePlaceholders,
            $usrIdToExternalEmailAddressesMap,
            $usrIdToMessageMap
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendInternalMail()

ilMail::sendInternalMail (   $folderId,   $senderUsrId,   $attachments,   $to,   $cc,   $bcc,   $status,   $email,   $subject,   $message,   $usrId = 0,   $usePlaceholders = 0,   $templateContextId = null,   $templateContextParameters = []  )

private

Parameters

integer	$folderId
integer	$senderUsrId
array	$attachments
string	$to
string	$cc
string	$bcc
string	$status
integer	$email
string	$subject
string	$message
integer	$usrId
integer	$usePlaceholders
string | null	$templateContextId
array | null	$templateContextParameters

Returns

int

Definition at line 600 of file class.ilMail.php.

References $email, $message, $user_id, formatLinebreakMessage(), and replacePlaceholders().

Referenced by saveInSentbox(), and sendChanneledMails().

      : int {
        $usrId = $usrId ? $usrId : $this->user_id;

        if ($usePlaceholders) {
            $message = $this->replacePlaceholders($message, $usrId);
        }
        $message = $this->formatLinebreakMessage((string) $message);
        $message = str_ireplace(["<br />", "<br>", "<br/>"], "\n", $message);

        if (!$usrId) {
            $usrId = '0';
        }
        if (!$folderId) {
            $folderId = '0';
        }
        if (!$senderUsrId) {
            $senderUsrId = null;
        }
        if (!$attachments) {
            $attachments = null;
        }
        if (!$to) {
            $to = null;
        }
        if (!$cc) {
            $cc = null;
        }
        if (!$bcc) {
            $bcc = null;
        }
        if (!$status) {
            $status = null;
        }
        if (!$email) {
            $email = null;
        }
        if (!$subject) {
            $subject = null;
        }
        if (!$message) {
            $message = null;
        }

        $nextId = (int) $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, array(
            'mail_id' => array('integer', $nextId),
            'user_id' => array('integer', $usrId),
            'folder_id' => array('integer', $folderId),
            'sender_id' => array('integer', $senderUsrId),
            'attachments' => array('clob', serialize($attachments)),
            'send_time' => array('timestamp', date('Y-m-d H:i:s', time())),
            'rcp_to' => array('clob', $to),
            'rcp_cc' => array('clob', $cc),
            'rcp_bcc' => array('clob', $bcc),
            'm_status' => array('text', $status),
            'm_email' => array('integer', $email),
            'm_subject' => array('text', $subject),
            'm_message' => array('clob', $message),
            'tpl_ctx_id' => array('text', $templateContextId),
            'tpl_ctx_params' => array('blob', @json_encode((array) $templateContextParameters))
        ));

        $raiseEvent = (int) $usrId !== $this->mailbox->getUsrId();
        if (!$raiseEvent) {
            $raiseEvent = (int) $folderId !== $this->mailbox->getSentFolder();
        }

        if ($raiseEvent) {
            $this->eventHandler->raise('Services/Mail', 'sentInternalMail', [
                'id' => $nextId,
                'subject' => (string) $subject,
                'body' => (string) $message,
                'from_usr_id' => (int) $senderUsrId,
                'to_usr_id' => (int) $usrId,
                'rcp_to' => (string) $to,
                'rcp_cc' => (string) $cc,
                'rcp_bcc' => (string) $bcc,
            ]);
        }

        return $nextId;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMail()

ilMail::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.

Parameters

string	$to
string	$cc
string	$bcc
string	$subject
string	$message
array	$attachments
bool	$usePlaceholders

Returns

ilMailError[]

See also

::enqueue()

Definition at line 1323 of file class.ilMail.php.

References $errors, deleteMails(), distributeMail(), formatLinebreakMessage(), getCountRecipients(), getEmailRecipients(), getSaveInSentbox(), replacePlaceholders(), saveInSentbox(), and sendMimeMail().

Referenced by enqueue().

      : array {
        $internalMessageId = $this->saveInSentbox(
            $attachments,
            $to,
            $cc,
            $bcc,
            $subject,
            $message
        );

        if (count($attachments) > 0) {
            $this->mfile->assignAttachmentsToDirectory($internalMessageId, $internalMessageId);
            $this->mfile->saveFiles($internalMessageId, $attachments);
        }

        $numberOfExternalAddresses = $this->getCountRecipients($to, $cc, $bcc, true);

        if ($numberOfExternalAddresses > 0) {
            $externalMailRecipientsTo = $this->getEmailRecipients($to);
            $externalMailRecipientsCc = $this->getEmailRecipients($cc);
            $externalMailRecipientsBcc = $this->getEmailRecipients($bcc);

            $this->logger->debug(
                "Parsed external email addresses from given recipients /" .
                " To: " . $externalMailRecipientsTo .
                " | CC: " . $externalMailRecipientsCc .
                " | BCC: " . $externalMailRecipientsBcc .
                " | Subject: " . $subject
            );

            $this->sendMimeMail(
                $externalMailRecipientsTo,
                $externalMailRecipientsCc,
                $externalMailRecipientsBcc,
                $subject,
                $this->formatLinebreakMessage(
                    $usePlaceholders ? $this->replacePlaceholders($message, 0, false) : $message
                ),
                $attachments
            );
        } else {
            $this->logger->debug('No external email addresses given in recipient string');
        }

        $errors = [];

        if (!$this->distributeMail(
            $to,
            $cc,
            $bcc,
            $subject,
            $message,
            $attachments,
            $internalMessageId,
            $usePlaceholders
        )) {
            $errors['mail_send_error'] = new ilMailError('mail_send_error');
        }

        if (!$this->getSaveInSentbox()) {
            $this->deleteMails([$internalMessageId]);
        }

        return array_values($errors);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMimeMail()

ilMail::sendMimeMail ( string  $to, string  $cc, string  $bcc,   $subject,   $message, array  $attachments  )

private

Parameters

string	$to
string	$cc
string	$bcc
string	$subject
string	$message
array	$attachments

Definition at line 1463 of file class.ilMail.php.

References $message.

Referenced by delegateExternalEmails(), and sendMail().

                                                                                                               : void
    {
        $mailer = new ilMimeMail();
        $mailer->From($this->senderFactory->getSenderByUsrId((int) $this->user_id));
        $mailer->To($to);
        $mailer->Subject($subject, true, (string) ($this->contextParameters[self::PROP_CONTEXT_SUBJECT_PREFIX] ?? ''));
        $mailer->Body($message);

        if ($cc) {
            $mailer->Cc($cc);
        }

        if ($bcc) {
            $mailer->Bcc($bcc);
        }

        foreach ($attachments as $attachment) {
            $mailer->Attach(
                $this->mfile->getAbsoluteAttachmentPoolPathByFilename($attachment),
                '',
                'inline',
                $attachment
            );
        }

        $mailer->Send();
    }

Here is the caller graph for this function:

setMailOptionsByUserIdMap()

ilMail::setMailOptionsByUserIdMap

(

array

$mailOptionsByUsrIdMap

)

Parameters

ilMailOptions[]

$mailOptionsByUsrIdMap

Definition at line 1740 of file class.ilMail.php.

References $mailOptionsByUsrIdMap.

                                                                            : void
    {
        $this->mailOptionsByUsrIdMap = $mailOptionsByUsrIdMap;
    }

setSaveInSentbox()

ilMail::setSaveInSentbox

(

bool

$saveInSentbox

)

Parameters

bool

$saveInSentbox

Definition at line 230 of file class.ilMail.php.

Referenced by __construct(), and ilSoapUtils\distributeMails().

                                                          : void
    {
        $this->save_in_sentbox = (bool) $saveInSentbox;
    }

Here is the caller graph for this function:

setUserInstanceById()

ilMail::setUserInstanceById

(

array

$userInstanceByIdMap

)

Parameters

ilObjUser[]

$userInstanceByIdMap

Definition at line 1718 of file class.ilMail.php.

                                                                    : void
    {
        $this->userInstancesByIdMap = $userInstanceByIdMap;
    }

updateDraft()

ilMail::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 = []
	)

Definition at line 544 of file class.ilMail.php.

      {
        $this->db->update(
            $this->table_mail,
            [
                'folder_id' => ['integer', $a_folder_id],
                'attachments' => ['clob', serialize($a_attachments)],
                'send_time' => ['timestamp', date('Y-m-d H:i:s', time())],
                'rcp_to' => ['clob', $a_rcp_to],
                'rcp_cc' => ['clob', $a_rcp_cc],
                'rcp_bcc' => ['clob', $a_rcp_bcc],
                'm_status' => ['text', 'read'],
                'm_email' => ['integer', $a_m_email],
                'm_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', @json_encode((array) $a_tpl_context_params)]
            ],
            [
                'mail_id' => ['integer', $a_draft_id]
            ]
        );

        return $a_draft_id;
    }

validateRecipients()

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

Parameters

string	$to
string	$cc
string	$bcc

Returns

ilMailError[] An array of errors determined on validation

Definition at line 1403 of file class.ilMail.php.

References Vendor\Package\$e, $errors, and checkRecipients().

Referenced by enqueue().

                                                                            : array
    {
        try {
            $errors = [];
            $errors = array_merge($errors, $this->checkRecipients($to));
            $errors = array_merge($errors, $this->checkRecipients($cc));
            $errors = array_merge($errors, $this->checkRecipients($bcc));

            if (count($errors) > 0) {
                return array_merge([new ilMailError('mail_following_rcp_not_valid')], $errors);
            }
        } catch (ilMailException $e) {
            return [new ilMailError('mail_generic_rcp_error', [$e->getMessage()])];
        }

        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withContextId()

ilMail::withContextId

(

string

$contextId

)

Parameters

string

$contextId

Returns

ilMail

Definition at line 180 of file class.ilMail.php.

References $contextId.

                                                     : self
    {
        $clone = clone $this;

        $clone->contextId = $contextId;

        return $clone;
    }

withContextParameters()

ilMail::withContextParameters

(

array

$parameters

)

Parameters

array

$parameters

Returns

ilMail

Definition at line 193 of file class.ilMail.php.

                                                             : self
    {
        $clone = clone $this;

        $clone->contextParameters = $parameters;

        return $clone;
    }

Field Documentation

$appendInstallationSignature

ilMail::$appendInstallationSignature = false

protected

Definition at line 49 of file class.ilMail.php.

Referenced by appendInstallationSignature().

$contextId

ilMail::$contextId = null

protected

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

Referenced by withContextId().

$contextParameters

ilMail::$contextParameters = []

protected

Definition at line 64 of file class.ilMail.php.

$db

ilMail::$db

protected

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

Referenced by __construct().

$eventHandler

ilMail::$eventHandler

private

Definition at line 52 of file class.ilMail.php.

Referenced by __construct().

$lng

ilMail::$lng

protected

Definition at line 16 of file class.ilMail.php.

Referenced by __construct().

$logger

ilMail::$logger

protected

Definition at line 67 of file class.ilMail.php.

Referenced by __construct().

$mail_data

ilMail::$mail_data = array()

protected

Definition at line 40 of file class.ilMail.php.

Referenced by ilFormatMail\appendSearchResult(), deleteMailsOfFolder(), getMail(), getNextMail(), getPreviousMail(), and getSavedData().

$mail_obj_ref_id

ilMail::$mail_obj_ref_id

protected

Definition at line 43 of file class.ilMail.php.

Referenced by getMailObjectReferenceId().

$mail_options

ilMail::$mail_options

protected

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

$mailAddressParserFactory

ilMail::$mailAddressParserFactory

private

Definition at line 58 of file class.ilMail.php.

Referenced by __construct().

$mailAddressTypeFactory

ilMail::$mailAddressTypeFactory

private

Definition at line 55 of file class.ilMail.php.

Referenced by __construct().

$mailbox

ilMail::$mailbox

protected

Definition at line 28 of file class.ilMail.php.

Referenced by sendChanneledMails().

$mailOptionsByUsrIdMap

ilMail::$mailOptionsByUsrIdMap = []

protected

Definition at line 70 of file class.ilMail.php.

Referenced by setMailOptionsByUserIdMap().

$maxRecipientCharacterLength

ilMail::$maxRecipientCharacterLength = 998

protected

Definition at line 79 of file class.ilMail.php.

$mfile

ilMail::$mfile

protected

Definition at line 22 of file class.ilMail.php.

$save_in_sentbox

ilMail::$save_in_sentbox

protected

Definition at line 46 of file class.ilMail.php.

Referenced by getSaveInSentbox().

$senderFactory

ilMail::$senderFactory

protected

Definition at line 82 of file class.ilMail.php.

Referenced by __construct(), and _getAutoGeneratedMessageString().

$table_mail

ilMail::$table_mail

protected

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

$table_mail_saved

ilMail::$table_mail_saved

protected

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

$user_id

ilMail::$user_id

Definition at line 31 of file class.ilMail.php.

Referenced by saveInSentbox(), and sendInternalMail().

$userInstancesByIdMap

ilMail::$userInstancesByIdMap = []

protected

Definition at line 73 of file class.ilMail.php.

$usrIdByLoginCallable

ilMail::$usrIdByLoginCallable = null

protected

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

Referenced by __construct().

ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

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

Referenced by ilMailAddressTypeFactory\__construct(), ilUtil\is_email(), and ilRoleMailboxSearch\searchRoleIdsByAddressString().

PROP_CONTEXT_SUBJECT_PREFIX

const ilMail::PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix'

Definition at line 13 of file class.ilMail.php.

Referenced by ilMailMemberSearchGUI\generateContextArray(), ilCourseMembershipGUI\getMailContextOptions(), ilGroupMembershipGUI\getMailContextOptions(), ilCourseMembershipMailNotification\initMail(), and ilGroupMembershipMailNotification\initMail().

---

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

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