ilMail Class Reference

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

Public Member Functions
	__construct (private int $a_user_id, private ?ilMailAddressTypeFactory $mail_address_type_factory=null, private ?ilMailRfc822AddressParserFactory $mail_address_parser_factory=null, private ?ilAppEventHandler $event_handler=null, private ?ilLogger $logger=null, private ?ilDBInterface $db=null, private ?ilLanguage $lng=null, private ?ilFileDataMail $mail_file_data=null, protected ?ilMailOptions $mail_options=null, private ?ilMailbox $mailbox=null, private ?ilMailMimeSenderFactory $sender_factory=null, private ?Closure $usr_id_by_login_callable=null, private ?AutoresponderService $auto_responder_service=null, private ?int $mail_admin_node_ref_id=null, private ?int $mail_obj_ref_id=null, private ?ilObjUser $actor=null, private ?ilMailTemplatePlaceholderResolver $placeholder_resolver=null, private ?ilMailTemplatePlaceholderToEmptyResolver $placeholder_to_empty_resolver=null, ?Conductor $legal_documents=null)
	autoresponder ()
	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 (MailDeliveryData $mail_data)
	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	_getIliasMailerName ()
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 Attributes
array	$mail_data = []

Private Member Functions
	isSystemMail ()
	readMailObjectReferenceId ()
	fetchMailData (?array $row)
	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=[])
	replacePlaceholders (string $message, int $usrId=0)
	replacePlaceholdersEmpty (string $message)
	distributeMail (MailDeliveryData $mail_data)
	sendMailWithReplacedPlaceholder (MailDeliveryData $mail_data, array $to_usr_ids)
	sendMailWithReplacedEmptyPlaceholder (MailDeliveryData $mail_data, array $recipients,)
	sendMailWithoutReplacedPlaceholder (MailDeliveryData $mail_data, array $to_usr_ids, array $cc_bcc_recipients)
	sendChanneledMails (MailDeliveryData $mail_data, array $recipients, string $message)
	delegateExternalEmails (string $subject, array $attachments, string $message, array $usrIdToExternalEmailAddressesMap)
	getUserIds (array $recipients)
	checkMail (string $to, string $cc, string $bcc, string $subject)
	checkRecipients (string $recipients)
	getSubjectSentFolderId ()
	saveInSentbox (array $attachment, string $to, string $cc, string $bcc, string $subject, string $message)
	sendMimeMail (string $to, string $cc, string $bcc, string $subject, string $message, array $attachments)
	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)
	createRecipient (int $user_id)

Private Attributes
string	$table_mail
string	$table_mail_saved
bool	$save_in_sentbox
bool	$append_installation_signature = false
string	$context_id = null
array	$context_parameters = []
array	$mail_options_by_usr_id_map = []
array	$user_instances_by_id_map = []
int	$max_recipient_character_length = 998
readonly Conductor	$legal_documents

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

Constructor & Destructor Documentation

__construct()

ilMail::__construct	(	private int	$a_user_id,
		private ?ilMailAddressTypeFactory	$mail_address_type_factory = null,
		private ?ilMailRfc822AddressParserFactory	$mail_address_parser_factory = null,
		private ?ilAppEventHandler	$event_handler = null,
		private ?ilLogger	$logger = null,
		private ?ilDBInterface	$db = null,
		private ?ilLanguage	$lng = null,
		private ?ilFileDataMail	$mail_file_data = null,
		protected ?ilMailOptions	$mail_options = null,
		private ?ilMailbox	$mailbox = null,
		private ?ilMailMimeSenderFactory	$sender_factory = null,
		private ?Closure	$usr_id_by_login_callable = null,
		private ?AutoresponderService	$auto_responder_service = null,
		private ?int	$mail_admin_node_ref_id = null,
		private ?int	$mail_obj_ref_id = null,
		private ?ilObjUser	$actor = null,
		private ?ilMailTemplatePlaceholderResolver	$placeholder_resolver = null,
		private ?ilMailTemplatePlaceholderToEmptyResolver	$placeholder_to_empty_resolver = null,
		?Conductor	$legal_documents = null
	)

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

References $DIC, $lng, ilObjUser\_lookupId(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), readMailObjectReferenceId(), and setSaveInSentbox().

      {
        global $DIC;
        $this->logger = $logger ?? ilLoggerFactory::getLogger('mail');
        $this->mail_address_type_factory = $mail_address_type_factory ?? new ilMailAddressTypeFactory(null, $logger);
        $this->mail_address_parser_factory = $mail_address_parser_factory ?? new ilMailRfc822AddressParserFactory();
        $this->event_handler = $event_handler ?? $DIC->event();
        $this->db = $db ?? $DIC->database();
        $this->lng = $lng ?? $DIC->language();
        $this->actor = $actor ?? $DIC->user();
        $this->mail_file_data = $mail_file_data ?? new ilFileDataMail($a_user_id);
        $this->mail_options = $mail_options ?? new ilMailOptions($a_user_id);
        $this->mailbox = $mailbox ?? new ilMailbox($a_user_id);

        $this->sender_factory = $sender_factory ?? $DIC->mail()->mime()->senderFactory();
        $this->usr_id_by_login_callable = $usr_id_by_login_callable ?? static function (string $login): int {
            return (int) ilObjUser::_lookupId($login);
        };
        $this->auto_responder_service = $auto_responder_service ?? $DIC->mail()->autoresponder();
        $this->user_id = $a_user_id;
        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);
        $this->placeholder_resolver = $placeholder_resolver ?? $DIC->mail()->placeholderResolver();
        $this->placeholder_to_empty_resolver = $placeholder_to_empty_resolver ?? $DIC->mail()->placeholderToEmptyResolver();
        $this->legal_documents = $legal_documents ?? $DIC['legalDocuments'];
    }

Here is the call graph for this function:

Member Function Documentation

_getAutoGeneratedMessageString()

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

static

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

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

Referenced by ilSystemNotification\compose(), ilUserCronCheckAccounts\run(), ilMailSummaryNotification\send(), ilECSObjectSettings\sendNewContentNotification(), ilRemoteObjectBase\sendNewContentNotification(), and ilECSAppEventListener\sendNotification().

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

_getIliasMailerName()

static ilMail::_getIliasMailerName ( )

static

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

References $DIC.

Referenced by ilMailBoxQuery\_getMailBoxListData(), ilMailFolderGUI\confirmDeleteMails(), ilMailFolderTableGUI\fetchTableData(), ilPDMailBlockGUI\getListItemForData(), ilPDMailGUI\getPDMailHTML(), ilMailFolderGUI\printMail(), ilMailSummaryNotification\send(), and ilMailTest\testGetIliasMailerName().

                                                : string
    {
        global $DIC;
        $senderFactory = $DIC->mail()->mime()->senderFactory();

        return $senderFactory->system()->getFromName();
    }

Here is the caller graph for this function:

_getInstallationSignature()

static ilMail::_getInstallationSignature ( )

static

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

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

Referenced by ilObjUserGUI\__sendProfileMail(), ilForumMailNotification\addLinkToMail(), ilSystemNotification\compose(), ilForumMailEventNotificationSender\createAttachmentLinkText(), ilTimingsCronReminder\fillObjectListForMailBody(), ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ilMailSummaryNotification\send(), ILIAS\Wiki\Notification\NotificationGUI\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), ilWikiUtil\sendNotification(), and ilObjSurveyGUI\sendUserResultsMail().

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

        $placeholders = [
            'INSTALLATION_NAME' => $DIC['ilClientIniFile']->readVariable('client', 'name'),
            'INSTALLATION_DESC' => $DIC['ilClientIniFile']->readVariable('client', 'description'),
            'ILIAS_URL' => $clientUrl,
        ];

        $signature = $DIC->mail()->mustacheFactory()->getBasicEngine()->render($signature, $placeholders);

        if (!preg_match('/^[\n\r]+/', (string) $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 1369 of file class.ilMail.php.

References $append_installation_signature.

Referenced by enqueue().

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

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

Here is the caller graph for this function:

autoresponder()

ilMail::autoresponder

(

)

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

                                   : AutoresponderService
    {
        return $this->auto_responder_service;
    }

checkMail()

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

private

Returns

ilMailError[]

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

References ilStr\strLen().

Referenced by enqueue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkRecipients()

ilMail::checkRecipients ( string  $recipients )

private

Returns

ilMailError[]

Exceptions

ilMailException

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

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

Referenced by validateRecipients().

                                                        : array
    {
        $errors = [];

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

        return array_merge(...$errors);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

countMailsOfFolder()

ilMail::countMailsOfFolder

(

int

$folderId

)

Definition at line 268 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);
    }

createRecipient()

ilMail::createRecipient ( int  $user_id )

private

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

References getMailOptionsByUserId(), and getUserInstanceById().

Referenced by distributeMail(), sendMailWithoutReplacedPlaceholder(), and sendMailWithReplacedPlaceholder().

                                                  : Recipient
    {
        return new Recipient(
            $user_id,
            $this->getUserInstanceById($user_id),
            $this->getMailOptionsByUserId($user_id),
            $this->legal_documents
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delegateExternalEmails()

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

private

Parameters

string[]	$attachments
array<int,string[]>	$usrIdToExternalEmailAddressesMap

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

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

Referenced by sendChanneledMails().

     : void {
        if (1 === count($usrIdToExternalEmailAddressesMap)) {
            $usrIdToExternalEmailAddressesMap = array_values($usrIdToExternalEmailAddressesMap);
            $firstAddresses = current($usrIdToExternalEmailAddressesMap);

            $this->sendMimeMail(
                implode(',', $firstAddresses),
                '',
                '',
                $subject,
                $message,
                $attachments
            );
        } elseif (count($usrIdToExternalEmailAddressesMap) > 1) {
            $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->max_recipient_character_length) {
                    $this->sendMimeMail(
                        '',
                        '',
                        $remainingAddresses,
                        $subject,
                        $message,
                        $attachments
                    );

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

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

            if ('' !== $remainingAddresses) {
                $this->sendMimeMail(
                    '',
                    '',
                    $remainingAddresses,
                    $subject,
                    $message,
                    $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 379 of file class.ilMail.php.

References $id.

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->mail_file_data->deassignAttachmentFromDirectory($id);
        }
    }

Here is the caller graph for this function:

deleteMailsOfFolder()

ilMail::deleteMailsOfFolder

(

int

$folderId

)

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

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

private

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

References createRecipient(), MailDeliveryData\getBcc(), MailDeliveryData\getCc(), MailDeliveryData\getTo(), getUserIds(), MailDeliveryData\isUsePlaceholder(), ILIAS\Repository\logger(), sendMailWithoutReplacedPlaceholder(), sendMailWithReplacedEmptyPlaceholder(), and sendMailWithReplacedPlaceholder().

Referenced by sendMail().

                                                                : bool
    {
        $this->auto_responder_service->emptyAutoresponderData();
        $to_usr_ids = $this->getUserIds([$mail_data->getTo()]);
        $this->logger->debug(sprintf(
            "Parsed TO user ids from given recipients for serial letter notification: %s",
            implode(', ', $to_usr_ids)
        ));

        $other_usr_ids = $this->getUserIds([$mail_data->getCc(), $mail_data->getBcc()]);
        $cc_bcc_recipients = array_map(
            $this->createRecipient(...),
            $other_usr_ids
        );
        $this->logger->debug(sprintf(
            "Parsed CC/BCC user ids from given recipients for serial letter notification: %s",
            implode(', ', $other_usr_ids)
        ));

        if ($mail_data->isUsePlaceholder()) {
            $this->sendMailWithReplacedPlaceholder($mail_data, $to_usr_ids);
            $this->sendMailWithReplacedEmptyPlaceholder($mail_data, $cc_bcc_recipients);
        } else {
            $this->sendMailWithoutReplacedPlaceholder($mail_data, $to_usr_ids, $cc_bcc_recipients);
        }

        $this->auto_responder_service->disableAutoresponder();
        $this->auto_responder_service->handleAutoresponderMails($this->user_id);

        return true;
    }

Here is the call graph for this function:

Here is the caller 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_attachment

Returns

ilMailError[]

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

References $DIC, appendInstallationSignature(), checkMail(), ilContext\CONTEXT_CRON, getCountRecipients(), getSaveInSentbox(), ilContext\getType(), isSystemMail(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), sendMail(), and validateRecipients().

     : array {
        global $DIC;

        $sanitizeMb4Encoding = new Utf8Mb4Sanitizer();
        $a_m_subject = $sanitizeMb4Encoding->transform($a_m_subject);
        $a_m_message = $sanitizeMb4Encoding->transform($a_m_message);

        $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->mail_file_data->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 ($errors !== []) {
            return $errors;
        }

        $errors = $this->validateRecipients($a_rcp_to, $a_rcp_cc, $a_rcp_bcc);
        if ($errors !== []) {
            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) {
            $mail_data = new MailDeliveryData(
                $rcp_to,
                $rcp_cc,
                $rcp_bcc,
                $a_m_subject,
                $a_m_message,
                $a_attachment,
                $a_use_placeholders
            );
            return $this->sendMail($mail_data);
        }

        $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->context_id,
            serialize(array_merge(
                $this->context_parameters,
                [
                    'auto_responder' => $this->auto_responder_service->isAutoresponderEnabled()
                ]
            ))
        ]);
        $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 [];
    }

Here is the call graph for this function:

existsRecipient()

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

Definition at line 134 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 $diffedAddresses === [];
    }

Here is the call graph for this function:

fetchMailData()

ilMail::fetchMailData ( ?array  $row )

private

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

References ILIAS\Repository\int().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

formatLinebreakMessage()

ilMail::formatLinebreakMessage

(

string

$message

)

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

References $message.

                                                           : string
    {
        return $message;
    }

formatNamesForOutput()

ilMail::formatNamesForOutput

(

string

$recipients

)

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

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

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

Here is the call graph for this function:

getCountRecipient()

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

private

Definition at line 1298 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->usr_id_by_login_callable
            );
        }

        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, bool  $onlyExternalAddresses = true  )

private

Definition at line 1312 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 )

private

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

References parseAddresses().

Referenced by sendMail().

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

        $emailRecipients = array_map(static function (ilMailAddress $address): string {
            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

)

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

(

)

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

                                              : int
    {
        return $this->mail_obj_ref_id;
    }

getMailOptionsByUserId()

ilMail::getMailOptionsByUserId ( int  $usrId )

private

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

Referenced by createRecipient(), and sendChanneledMails().

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

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

Here is the caller graph for this function:

getMailsOfFolder()

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

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

References $res, and fetchMailData().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getNewDraftId()

ilMail::getNewDraftId

(

int

$folderId

)

Definition at line 442 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 216 of file class.ilMail.php.

References $mail_data, $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

)

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

References $mail_data, $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 ( int  $a_usr_id, ?ilLanguage  $a_language = null  )

static

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

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

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilForumMailNotification\createMail(), ilForumMailEventNotificationSender\createMailBodyText(), ilChatroom\getSessions(), ilUserCronCheckAccounts\run(), ilRegistrationMailNotification\send(), ILIAS\Portfolio\Notification\SharedNotification\send(), ilMailSummaryNotification\send(), ilLMMailNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilDataCollectionMailNotification\send(), ilBuddySystemNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilCalendarMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilCourseMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), ilExerciseMailNotification\sendExerciseNotification(), ilTestMailNotification\sendSimpleNotification(), and ilObjSurveyGUI\sendUserResultsMail().

                                                                                       : 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'] . ',';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveInSentbox()

ilMail::getSaveInSentbox

(

)

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

References $save_in_sentbox.

Referenced by enqueue(), and sendMail().

                                      : bool
    {
        return $this->save_in_sentbox;
    }

Here is the caller graph for this function:

getSubjectSentFolderId()

ilMail::getSubjectSentFolderId ( )

private

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

References isSystemMail().

Referenced by saveInSentbox(), and sendInternalMail().

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

        return $send_folder_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserIds()

ilMail::getUserIds ( array  $recipients )

private

Parameters

string[]

$recipients

Returns

int[]

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

References parseAddresses().

Referenced by distributeMail().

                                                  : 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->mail_address_type_factory->getByPrefix($address);
            $parsed_usr_ids[] = $address_type->resolve();
        }

        return array_unique(array_merge(...$parsed_usr_ids));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserInstanceById()

ilMail::getUserInstanceById ( int  $usrId )

private

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

References Vendor\Package\$e.

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

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

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

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

Here is the caller graph for this function:

isSystemMail()

ilMail::isSystemMail ( )

private

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

References ANONYMOUS_USER_ID.

Referenced by enqueue(), getSubjectSentFolderId(), sendChanneledMails(), and sendMail().

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

References $user_id.

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

        $query = "UPDATE $this->table_mail SET m_status = %s WHERE user_id = %s ";
        $types[] = 'text';
        $types[] = 'integer';
        $values[] = 'read';
        $values[] = $this->user_id;

        if ($mailIds !== []) {
            $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 324 of file class.ilMail.php.

References $user_id.

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

        $query = "UPDATE $this->table_mail SET m_status = %s WHERE user_id = %s ";
        $types[] = 'text';
        $types[] = 'integer';
        $values[] = 'unread';
        $values[] = $this->user_id;

        if ($mailIds !== []) {
            $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

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

References $user_id.

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

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

        if ([] === $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";
        $types[] = 'integer';
        $types[] = 'integer';
        $types[] = 'integer';
        $values[] = $folderId;
        $values[] = $this->user_id;
        $values[] = $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 ( string  $addresses )

private

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

Returns

ilMailAddress[]

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

References ILIAS\Repository\logger().

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

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

        $parser = $this->mail_address_parser_factory->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;
    }

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

string[]

$a_attachments

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

References retrieveFromStage().

Referenced by retrieveFromStage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

readMailObjectReferenceId()

ilMail::readMailObjectReferenceId ( )

private

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

References ilMailGlobalServices\getMailObjectRefId().

Referenced by __construct().

                                                : void
    {
        $this->mail_obj_ref_id = 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  )

private

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

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

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

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

            $user = $usrId > 0 ? $this->getUserInstanceById($usrId) : null;
            $message = $this->placeholder_resolver->resolve(
                $context,
                $message,
                $user,
                $this->context_parameters
            );
        } catch (Exception $e) {
            $this->logger->error(sprintf(
                '%s has been called with invalid context: %s / %s',
                __METHOD__,
                $e->getMessage(),
                $e->getTraceAsString()
            ));
        }

        return $message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replacePlaceholdersEmpty()

ilMail::replacePlaceholdersEmpty ( string  $message )

private

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

Referenced by sendMailWithReplacedEmptyPlaceholder().

                                                              : string
    {
        return $this->placeholder_to_empty_resolver->resolve($message);
    }

Here is the caller graph for this function:

retrieveFromStage()

ilMail::retrieveFromStage

(

)

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

saveAttachments()

ilMail::saveAttachments

(

array

$attachments

)

Parameters

string[]

$attachments

Definition at line 1257 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  )

private

Parameters

string[]

$attachment

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

References getSubjectSentFolderId(), and sendInternalMail().

Referenced by sendMail().

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

Here is the call graph for this function:

Here is the caller graph for this function:

sendChanneledMails()

ilMail::sendChanneledMails ( MailDeliveryData  $mail_data, array  $recipients, string  $message  )

private

Parameters

Recipient[]

$recipients

Exceptions

JsonException

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

References $message, delegateExternalEmails(), MailDeliveryData\getAttachments(), MailDeliveryData\getCc(), MailDeliveryData\getInternalMailId(), getMailOptionsByUserId(), MailDeliveryData\getSubject(), MailDeliveryData\getTo(), isSystemMail(), ILIAS\Repository\logger(), and sendInternalMail().

Referenced by sendMailWithoutReplacedPlaceholder(), sendMailWithReplacedEmptyPlaceholder(), and sendMailWithReplacedPlaceholder().

     : void {
        $usrIdToExternalEmailAddressesMap = [];

        foreach ($recipients as $recipient) {
            if (!$recipient->isUser()) {
                $this->logger->critical(sprintf(
                    "Skipped recipient with id %s (User not found)",
                    $recipient->getUserId()
                ));
                continue;
            }

            $can_read_internal = $recipient->evaluateInternalMailReadability();
            if ($this->isSystemMail() && !$can_read_internal->isOk()) {
                $this->logger->debug(sprintf(
                    'Skipped recipient with id %s and reason: %s',
                    $recipient->getUserId(),
                    is_string($can_read_internal->error()) ? $can_read_internal->error() : $can_read_internal->error()->getMessage()
                ));
                continue;
            }

            if ($recipient->isUserActive()) {
                if (!$can_read_internal->isOk() || $recipient->userWantsToReceiveExternalMails()) {
                    $emailAddresses = $recipient->getExternalMailAddress();
                    $usrIdToExternalEmailAddressesMap[$recipient->getUserId()] = $emailAddresses;

                    if ($recipient->onlyToExternalMailAddress()) {
                        $this->logger->debug(sprintf(
                            "Recipient with id %s will only receive external emails sent to: %s",
                            $recipient->getUserId(),
                            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",
                        $recipient->getUserId(),
                        implode(', ', $emailAddresses)
                    ));
                } else {
                    $this->logger->debug(sprintf(
                        "Recipient with id %s is does not want to receive external emails",
                        $recipient->getUserId()
                    ));
                }
            } else {
                $this->logger->debug(sprintf(
                    "Recipient with id %s is inactive and will not receive external emails",
                    $recipient->getUserId()
                ));
            }

            $mbox = clone $this->mailbox;
            $mbox->setUsrId($recipient->getUserId());
            $recipientInboxId = $mbox->getInboxFolder();

            $internalMailId = $this->sendInternalMail(
                $recipientInboxId,
                $this->user_id,
                $mail_data->getAttachments(),
                $mail_data->getTo(),
                $mail_data->getCc(),
                '',
                'unread',
                $mail_data->getSubject(),
                $message,
                $recipient->getUserId()
            );

            $mail_receiver_options = $this->getMailOptionsByUserId($this->user_id);

            $this->auto_responder_service->enqueueAutoresponderIfEnabled(
                $recipient->getUserId(),
                $recipient->getMailOptions(),
                $mail_receiver_options,
            );

            if ($mail_data->getAttachments() !== []) {
                $this->mail_file_data->assignAttachmentsToDirectory($internalMailId, $mail_data->getInternalMailId());
            }
        }

        $this->delegateExternalEmails(
            $mail_data->getSubject(),
            $mail_data->getAttachments(),
            $message,
            $usrIdToExternalEmailAddressesMap
        );
    }

Here is the call graph for this function:

Here is the caller 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 495 of file class.ilMail.php.

References $user_id, getSubjectSentFolderId(), and replacePlaceholders().

Referenced by saveInSentbox(), and sendChanneledMails().

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

        if ($usePlaceholders) {
            $message = $this->replacePlaceholders($message, $usrId);
        }
        $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->event_handler->raise('Services/Mail', 'sentInternalMail', [
                'id' => $nextId,
                'subject' => $subject,
                'body' => $message,
                'from_usr_id' => $senderUsrId,
                'to_usr_id' => $usrId,
                'rcp_to' => $to,
                'rcp_cc' => $cc,
                'rcp_bcc' => $bcc,
            ]);
        }

        return $nextId;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMail()

ilMail::sendMail

(

MailDeliveryData

$mail_data

)

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[]

$attachments

Returns

ilMailError[]

See also

ilMail::enqueue()

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

References deleteMails(), distributeMail(), MailDeliveryData\getAttachments(), MailDeliveryData\getBcc(), MailDeliveryData\getCc(), getCountRecipients(), getEmailRecipients(), MailDeliveryData\getMessage(), getSaveInSentbox(), MailDeliveryData\getSubject(), MailDeliveryData\getTo(), isSystemMail(), ILIAS\Repository\logger(), replacePlaceholders(), saveInSentbox(), sendMimeMail(), and MailDeliveryData\withInternalMailId().

Referenced by enqueue().

     : array {
        $internalMessageId = $this->saveInSentbox(
            $mail_data->getAttachments(),
            $mail_data->getTo(),
            $mail_data->getCc(),
            $mail_data->getBcc(),
            $mail_data->getSubject(),
            $mail_data->getMessage()
        );
        $mail_data = $mail_data->withInternalMailId($internalMessageId);

        if ($mail_data->getAttachments() !== []) {
            $this->mail_file_data->assignAttachmentsToDirectory($internalMessageId, $internalMessageId);
            $this->mail_file_data->saveFiles($internalMessageId, $mail_data->getAttachments());
        }

        $numberOfExternalAddresses = $this->getCountRecipients($mail_data->getTo(), $mail_data->getCc(), $mail_data->getBcc());

        if ($numberOfExternalAddresses > 0) {
            $externalMailRecipientsTo = $this->getEmailRecipients($mail_data->getTo());
            $externalMailRecipientsCc = $this->getEmailRecipients($mail_data->getCc());
            $externalMailRecipientsBcc = $this->getEmailRecipients($mail_data->getBcc());

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

            $this->sendMimeMail(
                $externalMailRecipientsTo,
                $externalMailRecipientsCc,
                $externalMailRecipientsBcc,
                $mail_data->getSubject(),
                $mail_data->isUsePlaceholder() ?
                            $this->replacePlaceholders($mail_data->getMessage(), 0) :
                    $mail_data->getMessage(),
                $mail_data->getAttachments()
            );
        } else {
            $this->logger->debug('No external email addresses given in recipient string');
        }

        $errors = [];

        if (!$this->distributeMail($mail_data)) {
            $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->mail_file_data
                ))->run();
            }
        }

        return array_values($errors);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMailWithoutReplacedPlaceholder()

ilMail::sendMailWithoutReplacedPlaceholder ( MailDeliveryData  $mail_data, array  $to_usr_ids, array  $cc_bcc_recipients  )

private

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

References createRecipient(), MailDeliveryData\getMessage(), and sendChanneledMails().

Referenced by distributeMail().

     : void {
        $to_recipients = array_map(
            $this->createRecipient(...),
            $to_usr_ids
        );

        $this->sendChanneledMails(
            $mail_data,
            array_merge($to_recipients, $cc_bcc_recipients),
            $mail_data->getMessage()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMailWithReplacedEmptyPlaceholder()

ilMail::sendMailWithReplacedEmptyPlaceholder ( MailDeliveryData  $mail_data, array  $recipients  )

private

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

References MailDeliveryData\getMessage(), replacePlaceholdersEmpty(), and sendChanneledMails().

Referenced by distributeMail().

     : void {
        $this->sendChanneledMails(
            $mail_data,
            $recipients,
            $this->replacePlaceholdersEmpty($mail_data->getMessage()),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMailWithReplacedPlaceholder()

ilMail::sendMailWithReplacedPlaceholder ( MailDeliveryData  $mail_data, array  $to_usr_ids  )

private

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

References $user_id, createRecipient(), MailDeliveryData\getMessage(), replacePlaceholders(), and sendChanneledMails().

Referenced by distributeMail().

     : void {
        foreach ($to_usr_ids as $user_id) {
            $recipient = $this->createRecipient($user_id);

            $this->sendChanneledMails(
                $mail_data,
                [$recipient],
                $this->replacePlaceholders($mail_data->getMessage(), $user_id),
            );
        }
    }

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, string  $subject, string  $message, array  $attachments  )

private

Parameters

string[]

$attachments

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

Referenced by delegateExternalEmails(), and sendMail().

     : void {
        $mailer = new ilMimeMail();
        $mailer->From($this->sender_factory->getSenderByUsrId($this->user_id));
        $mailer->To($to);
        $mailer->Subject(
            $subject,
            true,
            (string) ($this->context_parameters[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->mail_file_data->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 1463 of file class.ilMail.php.

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

setSaveInSentbox()

ilMail::setSaveInSentbox

(

bool

$saveInSentbox

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

setUserInstanceById()

ilMail::setUserInstanceById

(

array

$userInstanceByIdMap

)

Parameters

array<int,ilObjUser>

$userInstanceByIdMap

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

                                                                   : void
    {
        $this->user_instances_by_id_map = $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

string[]

$a_attachments

Definition at line 458 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
	)

Returns

ilMailError[]

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

References Vendor\Package\$e, 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 ($errors !== []) {
                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

)

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

                                                    : self
    {
        $clone = clone $this;

        $clone->context_id = $contextId;

        return $clone;
    }

withContextParameters()

ilMail::withContextParameters

(

array

$parameters

)

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

                                                            : self
    {
        $clone = clone $this;

        $clone->context_parameters = $parameters;

        return $clone;
    }

Field Documentation

$append_installation_signature

bool ilMail::$append_installation_signature = false

private

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

Referenced by appendInstallationSignature().

$context_id

string ilMail::$context_id = null

private

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

$context_parameters

array ilMail::$context_parameters = []

private

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

$legal_documents

readonly Conductor ilMail::$legal_documents

private

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

$mail_data

array ilMail::$mail_data = []

protected

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

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

$mail_options_by_usr_id_map

array ilMail::$mail_options_by_usr_id_map = []

private

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

$max_recipient_character_length

int ilMail::$max_recipient_character_length = 998

private

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

$save_in_sentbox

bool ilMail::$save_in_sentbox

private

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

Referenced by getSaveInSentbox().

$table_mail

string ilMail::$table_mail

private

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

$table_mail_saved

string ilMail::$table_mail_saved

private

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

$user_id

int ilMail::$user_id

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

Referenced by markRead(), markUnread(), moveMailsToFolder(), sendInternalMail(), and sendMailWithReplacedPlaceholder().

$user_instances_by_id_map

array ilMail::$user_instances_by_id_map = []

private

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

ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

Definition at line 33 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 34 of file class.ilMail.php.

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

---

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

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