ilMail Class Reference

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

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

Static Public Member Functions
static	_getAutoGeneratedMessageString (ilLanguage $lang=null)
static	_getInstallationSignature ()
static	getSalutation (int $a_usr_id, ?ilLanguage $a_language=null)

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

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

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

Private Attributes
ilAppEventHandler	$eventHandler
ilMailAddressTypeFactory	$mailAddressTypeFactory
ilMailRfc822AddressParserFactory	$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 27 of file class.ilMail.php.

Constructor & Destructor Documentation

__construct()

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
	)

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

      {
        global $DIC;
        $this->logger = $logger ?? ilLoggerFactory::getLogger('mail');
        $this->mailAddressTypeFactory = $mailAddressTypeFactory ?? new ilMailAddressTypeFactory(null, $logger);
        $this->mailAddressParserFactory = $mailAddressParserFactory ?? new ilMailRfc822AddressParserFactory();
        $this->eventHandler = $eventHandler ?? $DIC->event();
        $this->db = $db ?? $DIC->database();
        $this->lng = $lng ?? $DIC->language();
        $this->actor = $actor ?? $DIC->user();
        $this->mfile = $mailFileData ?? new ilFileDataMail($a_user_id);
        $this->mail_options = $mailOptions ?? new ilMailOptions($a_user_id);
        $this->mailbox = $mailBox ?? new ilMailbox($a_user_id);
        $this->senderFactory = $senderFactory ?? $GLOBALS["DIC"]["mail.mime.sender.factory"];
        $this->usrIdByLoginCallable = $usrIdByLoginCallable ?? static function (string $login): int {
            return (int) ilObjUser::_lookupId($login);
        };
        $this->user_id = $a_user_id;
        $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);
    }

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

Here is the call graph for this function:

Member Function Documentation

_getAutoGeneratedMessageString()

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

static

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

                                                                                  : 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";
    }

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

Referenced by ilMailSummaryNotification\send(), ilRemoteObjectBase\sendNewContentNotification(), ilECSObjectSettings\sendNewContentNotification(), and ilECSAppEventListener\sendNotification().

Here is the call graph for this function:

Here is the caller graph for this function:

_getInstallationSignature()

static ilMail::_getInstallationSignature ( )

static

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

                                                      : 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(
            '[INSTALLATION_NAME]',
            $DIC['ilClientIniFile']->readVariable('client', 'name'),
            $signature
        );
        $signature = str_ireplace(
            '[INSTALLATION_DESC]',
            $DIC['ilClientIniFile']->readVariable('client', 'description'),
            $signature
        );
        $signature = str_ireplace('[ILIAS_URL]', $clientUrl, $signature);
 
        if (!preg_match('/^[\n\r]+/', $signature)) {
            $signature = "\n" . $signature;
        }
 
        return $signature;
    }

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

Referenced by ilForumMailNotification\addLinkToMail(), ilForumMailEventNotificationSender\createAttachmentLinkText(), ilTimingsCronReminder\fillObjectListForMailBody(), ilMailSummaryNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), and ilCronDeleteInactiveUserReminderMailNotification\send().

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 1458 of file class.ilMail.php.

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

checkMail()

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

protected

Parameters

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

Returns

ilMailError[]

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

                                                                                      : array
    {
        $errors = [];
 
        $checks = [
            $subject => 'mail_add_subject',
            $to => 'mail_add_recipient',
        ];
        foreach ($checks as $string => $error) {
            if ($string === '') {
                $errors[] = new ilMailError($error);
            }
        }
 
        if (ilStr::strLen($subject) > 255) {
            // https://mantis.ilias.de/view.php?id=37881
            $errors[] = new ilMailError('mail_subject_too_long');
        }
 
        return $errors;
    }

References $errors, and ilStr\strLen().

Here is the call graph for this function:

checkRecipients()

ilMail::checkRecipients ( string  $recipients )

protected

Parameters

string

$recipients

Returns

ilMailError[]

Exceptions

ilMailException

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

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

References Vendor\Package\$e, and $errors.

countMailsOfFolder()

ilMail::countMailsOfFolder

(

int

$folderId

)

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

                                                     : 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);
    }

References $res.

delegateExternalEmails()

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

protected

Parameters

string	$subject
string	$message
string[]	$attachments
bool	$usePlaceholders
	array<int,string[]>	$usrIdToExternalEmailAddressesMap
	array<int,string>	$usrIdToMessageMap

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

     : 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),
                $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]),
                        $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 ($remainingAddresses !== '') {
                        $sep = ',';
                    }
 
                    $recipientsLineLength = ilStr::strLen($remainingAddresses) +
                        ilStr::strLen($sep . $emailAddress);
                    if ($recipientsLineLength >= $this->maxRecipientCharacterLength) {
                        $this->sendMimeMail(
                            '',
                            '',
                            $remainingAddresses,
                            $subject,
                            $this->formatLinebreakMessage($message),
                            $attachments
                        );
 
                        $remainingAddresses = '';
                        $sep = '';
                    }
 
                    $remainingAddresses .= ($sep . $emailAddress);
                }
 
                if ('' !== $remainingAddresses) {
                    $this->sendMimeMail(
                        '',
                        '',
                        $remainingAddresses,
                        $subject,
                        $this->formatLinebreakMessage($message),
                        $attachments
                    );
                }
            }
        }
    }

References $message.

deleteMails()

ilMail::deleteMails

(

array

$mailIds

)

Parameters

int[]

$mailIds

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

                                               : 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);
        }
    }

References $id.

Referenced by deleteMailsOfFolder().

Here is the caller graph for this function:

deleteMailsOfFolder()

ilMail::deleteMailsOfFolder

(

int

$folderId

)

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

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

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

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
string[]	$attachments
int	$sentMailId
bool	$usePlaceholders

Returns

bool

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

     : 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,
                '',
                $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,
                '',
                $otherUsrIds,
                $subject,
                $this->replacePlaceholders($message, 0, false),
                $attachments,
                $sentMailId
            );
        } 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,
                '',
                $usrIds,
                $subject,
                $message,
                $attachments,
                $sentMailId
            );
        }
 
        return true;
    }

References $message, and ILIAS\Repository\logger().

Here is the call graph for this function:

enqueue()

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

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
string[]	$a_attachment
bool	$a_use_placeholders

Returns

ilMailError[]

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

     : 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($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject);
        if (count($errors) > 0) {
            return $errors;
        }
 
        $errors = $this->validateRecipients($a_rcp_to, $a_rcp_cc, $a_rcp_bcc);
        if (count($errors) > 0) {
            return $errors;
        }
 
        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bcc = $a_rcp_bcc;
 
        $numberOfExternalAddresses = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bcc);
        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(
                $rcp_to,
                $rcp_cc,
                $rcp_bcc,
                $a_m_subject,
                $a_m_message,
                $a_attachment,
                $a_use_placeholders
            );
        }
 
        $taskFactory = $DIC->backgroundTasks()->taskFactory();
        $taskManager = $DIC->backgroundTasks()->taskManager();
 
        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);
 
        $task = $taskFactory->createTask(ilMailDeliveryJob::class, [
            $this->user_id,
            $rcp_to,
            $rcp_cc,
            $rcp_bcc,
            $a_m_subject,
            $a_m_message,
            serialize($a_attachment),
            $a_use_placeholders,
            $this->getSaveInSentbox(),
            (string) $this->contextId,
            serialize($this->contextParameters),
        ]);
        $interaction = $taskFactory->createTask(ilMailDeliveryJobUserInteraction::class, [
            $task,
            $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 [];
    }

existsRecipient()

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

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

                                                                                     : 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;
    }

References parseAddresses().

Here is the call graph for this function:

fetchMailData()

ilMail::fetchMailData ( ?array  $row )

protected

Parameters

array | null

$row

Returns

array|null

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

                                                 : ?array
    {
        if (!is_array($row) || empty($row)) {
            return null;
        }
 
        if (isset($row['attachments'])) {
            $unserialized = unserialize(stripslashes($row['attachments']), ['allowed_classes' => false]);
            $row['attachments'] = is_array($unserialized) ? $unserialized : [];
        } else {
            $row['attachments'] = [];
        }
 
        if (isset($row['tpl_ctx_params']) && is_string($row['tpl_ctx_params'])) {
            $decoded = json_decode($row['tpl_ctx_params'], true, 512, JSON_THROW_ON_ERROR);
            $row['tpl_ctx_params'] = (array) ($decoded ?? []);
        } else {
            $row['tpl_ctx_params'] = [];
        }
 
        if (isset($row['mail_id'])) {
            $row['mail_id'] = (int) $row['mail_id'];
        }
 
        if (isset($row['user_id'])) {
            $row['user_id'] = (int) $row['user_id'];
        }
 
        if (isset($row['folder_id'])) {
            $row['folder_id'] = (int) $row['folder_id'];
        }
 
        if (isset($row['sender_id'])) {
            $row['sender_id'] = (int) $row['sender_id'];
        }
 
        if (isset($row['use_placeholders'])) {
            $row['use_placeholders'] = (bool) $row['use_placeholders'];
        }
 
        $null_to_string_properties = ['m_subject', 'm_message', 'rcp_to', 'rcp_cc', 'rcp_bcc'];
        foreach ($null_to_string_properties as $null_to_string_property) {
            if (!isset($row[$null_to_string_property])) {
                $row[$null_to_string_property] = '';
            }
        }
 
        return $row;
    }

References ILIAS\Repository\int().

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

Here is the call graph for this function:

Here is the caller graph for this function:

formatLinebreakMessage()

ilMail::formatLinebreakMessage

(

string

$message

)

Reimplemented in ilFormatMail.

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

                                                           : string
    {
        return $message;
    }

References $message.

formatNamesForOutput()

ilMail::formatNamesForOutput

(

string

$recipients

)

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

                                                            : string
    {
        $recipients = trim($recipients);
        if ($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 (is_int($usrId) && $usrId > 0) {
                $pp = ilObjUser::_lookupPref($usrId, 'public_profile');
                if ($pp === 'g' || ($pp === 'y' && !$this->actor->isAnonymous())) {
                    $user = $this->getUserInstanceById($usrId);
                    if ($user) {
                        $names[] = $user->getFullname() . ' [' . $recipient . ']';
                        continue;
                    }
                }
            }
 
            $names[] = $recipient;
        }
 
        return implode(', ', $names);
    }

References ilObjUser\_lookupId(), ilObjUser\_lookupPref(), getUserInstanceById(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getCountRecipient()

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

protected

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

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

getCountRecipients()

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

protected

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

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

getEmailRecipients()

ilMail::getEmailRecipients ( string  $recipients )

protected

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

                                                             : string
    {
        $addresses = new ilMailOnlyExternalAddressList(
            new ilMailAddressListImpl($this->parseAddresses($recipients)),
            self::ILIAS_HOST,
            $this->usrIdByLoginCallable
        );
 
        $emailRecipients = array_map(static function (ilMailAddress $address): string {
            return (string) $address;
        }, $addresses->value());
 
        return implode(',', $emailRecipients);
    }

getMail()

ilMail::getMail

(

int

$mailId

)

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

                                        : ?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;
    }

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

Here is the call graph for this function:

getMailObjectReferenceId()

ilMail::getMailObjectReferenceId

(

)

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

                                              : int
    {
        return $this->mail_obj_ref_id;
    }

References $mail_obj_ref_id.

getMailOptionsByUserId()

ilMail::getMailOptionsByUserId ( int  $usrId )

protected

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

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

getMailsOfFolder()

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

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

                                                                          : array
    {
        $mails = [];
 
        $query =
            "SELECT sender_id, m_subject, mail_id, m_status, send_time, import_name " .
            "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']) && $filter['status'] !== '') {
            $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);
    }

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

Referenced by deleteMailsOfFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

getNewDraftId()

ilMail::getNewDraftId

(

int

$folderId

)

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

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

getNextMail()

ilMail::getNextMail

(

int

$mailId

)

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

                                            : ?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;
    }

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

Here is the call graph for this function:

getPreviousMail()

ilMail::getPreviousMail

(

int

$mailId

)

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

                                                : ?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;
    }

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

Here is the call graph for this function:

getSalutation()

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

static

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

                                                                                       : string
    {
        global $DIC;
 
        $lang = ($a_language instanceof ilLanguage) ? $a_language : $DIC->language();
        $lang->loadLanguageModule('mail');
 
        $gender = ilObjUser::_lookupGender($a_usr_id);
        $gender = $gender ?: 'n';
        $name = ilObjUser::_lookupName($a_usr_id);
 
        if ($name['firstname'] === '') {
            return $lang->txt('mail_salutation_anonymous') . ',';
        }
 
        return
            $lang->txt('mail_salutation_' . $gender) . ' ' .
            ($name['title'] ? $name['title'] . ' ' : '') .
            ($name['firstname'] ? $name['firstname'] . ' ' : '') .
            $name['lastname'] . ',';
    }

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

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilBuddySystemNotification\send(), ilMailSummaryNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilRegistrationMailNotification\send(), ilSessionMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveInSentbox()

ilMail::getSaveInSentbox

(

)

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

                                      : bool
    {
        return $this->save_in_sentbox;
    }

References $save_in_sentbox.

getSubjectSentFolderId()

ilMail::getSubjectSentFolderId ( )

private

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

                                             : int
    {
        $send_folder_id = 0;
        if (!$this->isSystemMail()) {
            $send_folder_id = $this->mailbox->getSentFolder();
        }
 
        return $send_folder_id;
    }

getUserIds()

ilMail::getUserIds ( array  $recipients )

protected

Parameters

string[]

$recipients

Returns

int[]

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

                                                    : array
    {
        $parsed_usr_ids = [];
 
        $joined_recipients = implode(',', array_filter(array_map('trim', $recipients)));
 
        $addresses = $this->parseAddresses($joined_recipients);
        foreach ($addresses as $address) {
            $address_type = $this->mailAddressTypeFactory->getByPrefix($address);
            $parsed_usr_ids[] = $address_type->resolve();
        }
 
        return array_unique(array_merge(...$parsed_usr_ids));
    }

getUserInstanceById()

ilMail::getUserInstanceById ( int  $usrId )

protected

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

                                                      : ?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];
    }

References Vendor\Package\$e.

Referenced by formatNamesForOutput().

Here is the caller graph for this function:

isSystemMail()

ilMail::isSystemMail ( )

protected

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

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

References ANONYMOUS_USER_ID.

markRead()

ilMail::markRead

(

array

$mailIds

)

Parameters

int[]

$mailIds

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

                                            : 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);
    }

References $query.

markUnread()

ilMail::markUnread

(

array

$mailIds

)

Parameters

int[]

$mailIds

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

                                              : void
    {
        $values = [];
        $types = [];
 
        $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);
    }

References $query.

moveMailsToFolder()

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

Parameters

int[]	$mailIds
int	$folderId

Returns

bool

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

                                                                    : 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;
    }

References $query.

parseAddresses()

ilMail::parseAddresses ( string  $addresses )

protected

Explode recipient string, allowed separators are ',' ';' ' '.

Parameters

string

$addresses

Returns

ilMailAddress[]

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

                                                        : array
    {
        if ($addresses !== '') {
            $this->logger->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }
 
        $parser = $this->mailAddressParserFactory->getParser($addresses);
        $parsedAddresses = $parser->parse();
 
        if ($addresses !== '') {
            $this->logger->debug(sprintf(
                "Parsed addresses: %s",
                implode(',', array_map(static function (ilMailAddress $address): string {
                    return (string) $address;
                }, $parsedAddresses))
            ));
        }
 
        return $parsedAddresses;
    }

References ILIAS\Repository\logger().

Referenced by existsRecipient().

Here is the call graph for this function:

Here is the caller graph for this function:

persistToStage()

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

Parameters

int	$a_user_id
string[]	$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
string | null	$a_tpl_context_id
array | null	$a_tpl_ctx_params

Returns

bool

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

     : bool {
        $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_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', (int) $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', json_encode((array) $a_tpl_ctx_params, JSON_THROW_ON_ERROR)],
            ]
        );
 
        $this->retrieveFromStage();
 
        return true;
    }

readMailObjectReferenceId()

ilMail::readMailObjectReferenceId ( )

protected

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

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

References ilMailGlobalServices\getMailObjectRefId().

Referenced by __construct().

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

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

     : 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. ' . $e->getMessage());
        }
 
        return $message;
    }

References $context, and ilMailTemplateContextService\getTemplateContextById().

Here is the call graph for this function:

retrieveFromStage()

ilMail::retrieveFromStage

(

)

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

                                       : 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));
        if (!is_array($this->mail_data)) {
            $this->persistToStage($this->user_id, [], '', '', '', '', '', false);
        }
 
        return $this->mail_data;
    }

References $res.

saveAttachments()

ilMail::saveAttachments

(

array

$attachments

)

Parameters

string[]

$attachments

Definition at line 1345 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

Parameters

string[]	$attachment
string	$to
string	$cc
string	$bcc
string	$subject
string	$message

Returns

int

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

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

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
int[]	$usrIds
string	$subject
string	$message
string[]	$attachments
int	$sentMailId
bool	$usePlaceholders

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

     : 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;
                    }
 
                    $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($user->getId());
            $recipientInboxId = $mbox->getInboxFolder();
 
            $internalMailId = $this->sendInternalMail(
                $recipientInboxId,
                $this->user_id,
                $attachments,
                $to,
                $cc,
                '',
                'unread',
                $subject,
                $individualMessage,
                $user->getId()
            );
 
            if (count($attachments) > 0) {
                $this->mfile->assignAttachmentsToDirectory($internalMailId, $sentMailId);
            }
        }
 
        $this->delegateExternalEmails(
            $subject,
            $message,
            $attachments,
            $usePlaceholders,
            $usrIdToExternalEmailAddressesMap,
            $usrIdToMessageMap
        );
    }

References $message, ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, and ILIAS\Repository\logger().

Here is the call graph for this function:

sendInternalMail()

ilMail::sendInternalMail ( int  $folderId, int  $senderUsrId, array  $attachments, string  $to, string  $cc, string  $bcc, string  $status, string  $subject, string  $message, int  $usrId = 0, bool  $usePlaceholders = false, ?string  $templateContextId = null, array  $templateContextParameters = []  )

private

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

     : int {
        $usrId = $usrId ?: $this->user_id;
 
        if ($usePlaceholders) {
            $message = $this->replacePlaceholders($message, $usrId);
        }
        $message = $this->formatLinebreakMessage($message);
        $message = str_ireplace(["<br />", "<br>", "<br/>"], "\n", $message);
 
        $nextId = $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', $senderUsrId],
            'attachments' => ['clob', serialize($attachments)],
            'send_time' => ['timestamp', date('Y-m-d H:i:s')],
            'rcp_to' => ['clob', $to],
            'rcp_cc' => ['clob', $cc],
            'rcp_bcc' => ['clob', $bcc],
            'm_status' => ['text', $status],
            'm_subject' => ['text', $subject],
            'm_message' => ['clob', $message],
            'tpl_ctx_id' => ['text', $templateContextId],
            'tpl_ctx_params' => ['blob', json_encode($templateContextParameters, JSON_THROW_ON_ERROR)],
        ]);
 
        $sender_equals_reveiver = $usrId === $this->mailbox->getUsrId();
        $is_sent_folder_of_sender = false;
        if ($sender_equals_reveiver) {
            $current_folder_id = $this->getSubjectSentFolderId();
            $is_sent_folder_of_sender = $folderId === $current_folder_id;
        }
 
        $raise_event = !$sender_equals_reveiver || !$is_sent_folder_of_sender;
 
        if ($raise_event) {
            $this->eventHandler->raise('Services/Mail', 'sentInternalMail', [
                'id' => $nextId,
                'subject' => $subject,
                'body' => (string) $message,
                'from_usr_id' => $senderUsrId,
                'to_usr_id' => $usrId,
                'rcp_to' => $to,
                'rcp_cc' => $cc,
                'rcp_bcc' => $bcc,
            ]);
        }
 
        return $nextId;
    }

References $message.

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

Parameters

string	$to
string	$cc
string	$bcc
string	$subject
string	$message
string[]	$attachments
bool	$usePlaceholders

Returns

ilMailError[]

See also

ilMail::enqueue()

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

     : 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);
 
        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]);
        }
 
        if ($this->isSystemMail()) {
            $random = new ilRandom();
            if ($random->int(0, 50) === 2) {
                (new ilMailAttachmentStageCleanup(
                    $this->logger,
                    $this->mfile
                ))->run();
            }
        }
 
        return array_values($errors);
    }

sendMimeMail()

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

private

Parameters

string	$to
string	$cc
string	$bcc
string	$subject
string	$message
string[]	$attachments

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

     : void {
        $mailer = new ilMimeMail();
        $mailer->From($this->senderFactory->getSenderByUsrId($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();
    }

setMailOptionsByUserIdMap()

ilMail::setMailOptionsByUserIdMap

(

array

$mailOptionsByUsrIdMap

)

Parameters

ilMailOptions[]

$mailOptionsByUsrIdMap

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

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

setSaveInSentbox()

ilMail::setSaveInSentbox

(

bool

$saveInSentbox

)

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

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

Referenced by __construct().

Here is the caller graph for this function:

setUserInstanceById()

ilMail::setUserInstanceById

(

array

$userInstanceByIdMap

)

Parameters

array<int,ilObjUser>

$userInstanceByIdMap

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

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

updateDraft()

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

Parameters

int	$a_folder_id
string[]	$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
bool	$a_use_placeholders
string | null	$a_tpl_context_id
array	$a_tpl_context_params

Returns

int

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

     : int {
        $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')],
                'rcp_to' => ['clob', $a_rcp_to],
                'rcp_cc' => ['clob', $a_rcp_cc],
                'rcp_bcc' => ['clob', $a_rcp_bcc],
                'm_status' => ['text', 'read'],
                'm_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', (int) $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', json_encode($a_tpl_context_params, JSON_THROW_ON_ERROR)],
            ],
            [
                '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[]

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

                                                                           : 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 [];
    }

References Vendor\Package\$e, and $errors.

withContextId()

ilMail::withContextId

(

string

$contextId

)

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

                                                    : self
    {
        $clone = clone $this;
 
        $clone->contextId = $contextId;
 
        return $clone;
    }

References $contextId.

withContextParameters()

ilMail::withContextParameters

(

array

$parameters

)

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

                                                            : self
    {
        $clone = clone $this;
 
        $clone->contextParameters = $parameters;
 
        return $clone;
    }

Field Documentation

$actor

ilObjUser ilMail::$actor

protected

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

Referenced by __construct().

$appendInstallationSignature

bool ilMail::$appendInstallationSignature = false

protected

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

$contextId

string ilMail::$contextId = null

protected

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

Referenced by withContextId().

$contextParameters

array ilMail::$contextParameters = []

protected

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

$db

ilDBInterface ilMail::$db

protected

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

Referenced by __construct().

$eventHandler

ilAppEventHandler ilMail::$eventHandler

private

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

Referenced by __construct().

$lng

ilLanguage ilMail::$lng

protected

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

$logger

ilLogger ilMail::$logger

protected

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

Referenced by __construct().

$mail_data

array ilMail::$mail_data = []

protected

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

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

$mail_obj_ref_id

int ilMail::$mail_obj_ref_id = null

protected

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

Referenced by getMailObjectReferenceId().

$mail_options

ilMailOptions ilMail::$mail_options

protected

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

$mailAddressParserFactory

ilMailRfc822AddressParserFactory ilMail::$mailAddressParserFactory

private

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

Referenced by __construct().

$mailAddressTypeFactory

ilMailAddressTypeFactory ilMail::$mailAddressTypeFactory

private

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

Referenced by __construct().

$mailbox

ilMailbox ilMail::$mailbox

protected

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

$mailOptionsByUsrIdMap

array ilMail::$mailOptionsByUsrIdMap = []

protected

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

$maxRecipientCharacterLength

int ilMail::$maxRecipientCharacterLength = 998

protected

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

$mfile

ilFileDataMail ilMail::$mfile

protected

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

$save_in_sentbox

bool ilMail::$save_in_sentbox

protected

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

Referenced by getSaveInSentbox().

$senderFactory

ilMailMimeSenderFactory ilMail::$senderFactory

protected

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

Referenced by __construct().

$table_mail

string ilMail::$table_mail

protected

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

$table_mail_saved

string ilMail::$table_mail_saved

protected

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

$user_id

int ilMail::$user_id

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

$userInstancesByIdMap

array ilMail::$userInstancesByIdMap = []

protected

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

$usrIdByLoginCallable

ilMail::$usrIdByLoginCallable

protected

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

Referenced by __construct().

ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

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

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

PROP_CONTEXT_SUBJECT_PREFIX

const ilMail::PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix'

Definition at line 30 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