ilMail Class Reference

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

Public Member Functions
	__construct ( $a_user_id, ilMailAddressTypeFactory $mailAddressTypeFactory=null, ilMailRfc822AddressParserFactory $mailAddressParserFactory=null, \ilAppEventHandler $eventHandler=null)
	withContextId (string $contextId)
	withContextParameters (array $parameters)
	__get ($name)
	Magic interceptor method __get Used to include files / instantiate objects at runtime. More...
	existsRecipient (string $newRecipient, string $existingRecipients)
	enableSOAP ($a_status)
	Define if external mails should be sent using SOAP client or not. More...
	isSOAPEnabled ()
	setSaveInSentbox ($a_save_in_sentbox)
	getSaveInSentbox ()
	getMailObjectReferenceId ()
	formatNamesForOutput ($a_recipients)
	Prepends the fullname of each ILIAS login name (if user has a public profile) found in the passed string and brackets the ILIAS login name afterwards. More...
	getPreviousMail ($a_mail_id)
	getNextMail ($a_mail_id)
	getMailsOfFolder ($a_folder_id, $filter=array())
	countMailsOfFolder ($a_folder_id)
	deleteMailsOfFolder ($a_folder_id)
	getMail ($a_mail_id)
	markRead (array $a_mail_ids)
	markUnread (array $a_mail_ids)
	moveMailsToFolder (array $mailIds, int $folderId)
	deleteMails (array $mailIds)
	getNewDraftId ($usrId, $folderId)
	updateDraft ( $a_folder_id, $a_attachments, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_type, $a_m_email, $a_m_subject, $a_m_message, $a_draft_id=0, $a_use_placeholders=0, $a_tpl_context_id=null, $a_tpl_context_params=array())
	savePostData ( $a_user_id, $a_attachments, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_type, $a_m_email, $a_m_subject, $a_m_message, $a_use_placeholders, $a_tpl_context_id=null, $a_tpl_ctx_params=array())
	save post data in table public More...
	getSavedData ()
	sendMail ($a_rcp_to, $a_rcp_cc, $a_rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $a_type, $a_use_placeholders=0)
	Should be used to send notifcations over the internal or external mail channel. More...
	validateRecipients (string $to, string $cc, string $bcc)
	saveAttachments ($a_attachments)
	appendInstallationSignature ($a_flag=null)
	Setter/Getter for appending the installation signarue. More...
	formatLinebreakMessage ($a_message)

Static Public Member Functions
static	_getAutoGeneratedMessageString (ilLanguage $lang=null)
	Get auto generated info string. More...
static	_getInstallationSignature ()
static	getSubjectPrefix ()
	Get text that will be prepended to auto generated mails. More...
static	getSalutation ($a_usr_id, ilLanguage $a_language=null)

Data Fields
const	ILIAS_HOST = 'ilias'
const	MAIL_SUBJECT_PREFIX = '[ILIAS]'
	$user_id

Protected Member Functions
	isSystemMail ()
	readMailObjectReferenceId ()
	Read and set the mail object ref id (administration node) More...
	fetchMailData ($a_row)
	replacePlaceholders ($a_message, $a_user_id=0, $replace_empty=true)
	distributeMail ($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_subject, $a_message, $a_attachments, $sent_mail_id, $a_type, $a_action, $a_use_placeholders=0)
	getUserIds (array $recipients)
	checkMail (string $to, string $cc, string $bcc, string $subject)
	checkRecipients (string $recipients)
	Check if recipients are valid. More...
	saveInSentbox ($a_attachment, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_type, $a_m_subject, $a_m_message)
	Stores a message in the sent bod of the current user. More...
	parseAddresses ($addresses)
	Explode recipient string, allowed separators are ',' ';' ' ' Returns an array with recipient ilMailAddress instances. More...
	getCountRecipient (string $recipients, $onlyExternalAddresses=true)
	getCountRecipients (string $toRecipients, string $ccRecipients, string $bccRecipients, $onlyExternalAddresses=true)
	getEmailRecipients (string $recipients)

Static Protected Member Functions
static	getCachedUserInstance ($a_usr_id)

Protected Attributes
	$lng
	$db
	$mfile
	$mail_options
	$mailbox
	$table_mail
	$table_mail_saved
	$mail_data = array()
	$mail_obj_ref_id
	$save_in_sentbox
	$soap_enabled = true
	$appendInstallationSignature = false
	$properties = array()
	$contextId = null
	$contextParameters = []

Static Protected Attributes
static	$userInstances = array()

Private Member Functions
	sendInternalMail ( $a_folder_id, $a_sender_id, $a_attachments, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_status, $a_m_type, $a_m_email, $a_m_subject, $a_m_message, $a_user_id=0, $a_use_placeholders=0, $a_tpl_context_id=null, $a_tpl_context_params=array())
	save mail in folder private More...

Private Attributes
	$eventHandler
	$mailAddressTypeFactory
	$mailAddressParserFactory

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMail::__construct	(		$a_user_id,
		ilMailAddressTypeFactory	$mailAddressTypeFactory = null,
		ilMailRfc822AddressParserFactory	$mailAddressParserFactory = null,
		\ilAppEventHandler	$eventHandler = null
	)

Parameters

integer	$a_user_id
ilMailAddressTypeFactory | null	$mailAddressTypeFactory
ilMailRfc822AddressParserFactory | null	$mailAddressParserFactory
ilAppEventHandler | null	$eventHandler

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

References $DIC, $eventHandler, $mailAddressParserFactory, $mailAddressTypeFactory, readMailObjectReferenceId(), and setSaveInSentbox().

      {
        global $DIC;

        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
        require_once 'Services/Mail/classes/class.ilMailOptions.php';

        if ($mailAddressTypeFactory === null) {
            $mailAddressTypeFactory = new ilMailAddressTypeFactory();
        }

        if ($mailAddressParserFactory === null) {
            $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
        }

        if ($eventHandler === null) {
            $eventHandler = $DIC->event();
        }

        $this->mailAddressParserFactory = $mailAddressParserFactory;
        $this->mailAddressTypeFactory = $mailAddressTypeFactory;
        $this->eventHandler = $eventHandler;

        $this->lng = $DIC->language();
        $this->db = $DIC->database();

        $this->lng->loadLanguageModule('mail');

        $this->table_mail = 'mail';
        $this->table_mail_saved = 'mail_saved';

        $this->user_id = $a_user_id;

        $this->mfile = new ilFileDataMail($this->user_id);
        $this->mail_options = new ilMailOptions($a_user_id);
        $this->mailbox = new ilMailbox($this->user_id);

        $this->setSaveInSentbox(false);
        $this->readMailObjectReferenceId();
    }

Here is the call graph for this function:

Member Function Documentation

__get()

ilMail::__get

(

$name

)

Magic interceptor method __get Used to include files / instantiate objects at runtime.

Parameters

string

$name

The name of the class property

Returns

ilMailingLists

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

References $DIC, and $name.

    {
        global $DIC;

        if (isset($this->properties[$name])) {
            return $this->properties[$name];
        }

        if ($name == 'mlists') {
            if (is_object($DIC->user())) {
                require_once 'Services/Contact/classes/class.ilMailingLists.php';
                $this->properties[$name] = new ilMailingLists($DIC->user());
                return $this->properties[$name];
            }
        }
    }

_getAutoGeneratedMessageString()

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

static

Get auto generated info string.

Parameters

ilLanguage

$lang

Returns

string;

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

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

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

    {
        global $DIC;

        if (!($lang instanceof ilLanguage)) {
            require_once 'Services/Language/classes/class.ilLanguageFactory.php';
            $lang = ilLanguageFactory::_getLanguage();
        }

        $lang->loadLanguageModule('mail');

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

Here is the call graph for this function:

Here is the caller graph for this function:

_getInstallationSignature()

static ilMail::_getInstallationSignature ( )

static

Returns

string The installation mail signature

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

References $DIC, and ilUtil\_getHttpPath().

Referenced by ilRegistrationMimeMailNotification\__construct(), ilMailSummaryNotification\__construct(), ilForumMailNotification\addLinkToMail(), ilSystemNotification\compose(), ilTimingsCronReminder\fillObjectListForMailBody(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilMailCronOrphanedMailsNotification\send(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), and ilObjSurveyGUI\sendUserResultsMail().

    {
        global $DIC;

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

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

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

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

        return $signature;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendInstallationSignature()

ilMail::appendInstallationSignature

(

$a_flag = null

)

Setter/Getter for appending the installation signarue.

Parameters

mixed

boolean or nothing

Returns

mixed boolean if called without passing any params, otherwise $this

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

References $appendInstallationSignature.

Referenced by sendMail().

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

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

Here is the caller graph for this function:

checkMail()

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

protected

Parameters

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

Returns

[] An array of errors determined on validation

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

References $errors.

Referenced by sendMail().

                                                                                       : array
    {
        $errors = [];

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

        return $errors;
    }

Here is the caller graph for this function:

checkRecipients()

ilMail::checkRecipients ( string  $recipients )

protected

Check if recipients are valid.

Parameters

string

$recipients

Returns

[] An array of errors determined on validation

Exceptions

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

References $errors, and parseAddresses().

Referenced by validateRecipients().

                                                           : array
    {
        $errors = [];

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

        return $errors;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

countMailsOfFolder()

ilMail::countMailsOfFolder

(

$a_folder_id

)

Parameters

int

$a_folder_id

Returns

int

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

References $res.

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

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

deleteMails()

ilMail::deleteMails

(

array

$mailIds

)

Parameters

int[]

$mailIds

Returns

bool

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

References $id.

Referenced by deleteMailsOfFolder(), and sendMail().

    {
        $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",
                array('integer', 'integer'),
                array($this->user_id, $id)
            );
            $this->mfile->deassignAttachmentFromDirectory($id);
        }

        return true;
    }

Here is the caller graph for this function:

deleteMailsOfFolder()

ilMail::deleteMailsOfFolder

(

$a_folder_id

)

Parameters

int

$a_folder_id

id of folder

Returns

bool

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

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

    {
        if ($a_folder_id) {
            $mails = $this->getMailsOfFolder($a_folder_id);
            foreach ((array) $mails as $mail_data) {
                $this->deleteMails(array($mail_data['mail_id']));
            }

            return true;
        }

        return false;
    }

Here is the call graph for this function:

distributeMail()

ilMail::distributeMail (   $a_rcp_to,   $a_rcp_cc,   $a_rcp_bcc,   $a_subject,   $a_message,   $a_attachments,   $sent_mail_id,   $a_type,   $a_action,   $a_use_placeholders = 0  )

protected

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
string	$a_subject
string	$a_message
array	$a_attachments
integer	$sent_mail_id
array	$a_type
array	$a_action
array | int	$a_use_placeholders

Returns

bool

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

References $a_type, $email, $id, formatLinebreakMessage(), ilMailOptions\getExternalEmailsByUser(), ilLoggerFactory\getLogger(), getUserIds(), ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, replacePlaceholders(), sendInternalMail(), and ilStr\strLen().

Referenced by sendMail().

    {
        require_once 'Services/Mail/classes/class.ilMailbox.php';
        require_once 'Services/User/classes/class.ilObjUser.php';

        $mbox = new ilMailbox();
        if (!$a_use_placeholders) {
            $rcp_ids = $this->getUserIds(array($a_rcp_to, $a_rcp_cc, $a_rcp_bcc));

            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed TO/CC/BCC user ids from given recipients: %s",
                implode(', ', $rcp_ids)
            ));

            $as_email = array();

            foreach ($rcp_ids as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user = self::getCachedUserInstance($id);
                $user_is_active = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                    ilLoggerFactory::getLogger('mail')->debug(sprintf(
                        "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                        $id,
                        var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                        var_export(!$tmp_user->checkTimeLimit(), 1)
                    ));
                    continue;
                }

                if ($user_is_active) {
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $newEmailAddresses = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
                        $as_email = array_unique(array_merge($newEmailAddresses, $as_email));

                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $a_message,
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            $to = array();
            $bcc = array();
            
            $as_email = array_values(array_unique($as_email));
            if (count($as_email) == 1) {
                $to[] = $as_email[0];
            } else {
                foreach ($as_email as $email) {
                    $bcc[] = $email;
                }
            }

            if (count($to) > 0) {
                $this->sendMimeMail(implode(',', $to), '', implode(',', $bcc), $a_subject, $this->formatLinebreakMessage($a_message), $a_attachments);
            } elseif (count($bcc) > 0) {
                $remainingAddresses = '';
                $maxRecipientCharacterLength = 998;
                foreach ($bcc as $emailAddress) {
                    $sep = '';
                    if (strlen($remainingAddresses) > 0) {
                        $sep = ',';
                    }
    
                    $recipientsLineLength = ilStr::strLen($remainingAddresses) + ilStr::strLen($sep . $emailAddress);
                    if ($recipientsLineLength >= $maxRecipientCharacterLength) {
                        $this->sendMimeMail(
                            '',
                            '',
                            $remainingAddresses,
                            $a_subject,
                            $this->formatLinebreakMessage($a_message),
                            $a_attachments
                        );
    
                        $remainingAddresses = '';
                        $sep = '';
                    }
    
                    $remainingAddresses .= ($sep . $emailAddress);
                }
    
                if ('' !== $remainingAddresses) {
                    $this->sendMimeMail(
                        '',
                        '',
                        $remainingAddresses,
                        $a_subject,
                        $this->formatLinebreakMessage($a_message),
                        $a_attachments
                    );
                }
            }
        } else {
            $rcp_ids_replace = $this->getUserIds(array($a_rcp_to));
            $rcp_ids_no_replace = $this->getUserIds(array($a_rcp_cc, $a_rcp_bcc));

            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed TO user ids from given recipients for serial letter notification: %s",
                implode(', ', $rcp_ids_replace)
            ));
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed CC/BCC user ids from given recipients for serial letter notification: %s",
                implode(', ', $rcp_ids_no_replace)
            ));

            $as_email = array();
            $id_to_message_map = array();

            foreach ($rcp_ids_replace as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user = self::getCachedUserInstance($id);
                $user_is_active = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                    ilLoggerFactory::getLogger('mail')->debug(sprintf(
                        "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                        $id,
                        var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                        var_export(!$tmp_user->checkTimeLimit(), 1)
                    ));
                    continue;
                }

                $id_to_message_map[$id] = $this->replacePlaceholders($a_message, $id);

                if ($user_is_active) {
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $as_email[$tmp_user->getId()] = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
    
                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $as_email[$tmp_user->getId()])
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $as_email[$tmp_user->getId()])
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $id_to_message_map[$id],
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            if (count($as_email)) {
                foreach ($as_email as $id => $emails) {
                    if (0 == count($emails)) {
                        continue;
                    }

                    $toEmailAddresses = implode(',', $emails);
                    $this->sendMimeMail($toEmailAddresses, '', '', $a_subject, $this->formatLinebreakMessage($id_to_message_map[$id]), $a_attachments);
                }
            }

            $as_email = array();

            $cc_and_bcc_message = $this->replacePlaceholders($a_message, 0, false);

            foreach ($rcp_ids_no_replace as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user = self::getCachedUserInstance($id);
                $user_is_active = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if ($user_is_active) {
                    if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                        ilLoggerFactory::getLogger('mail')->debug(sprintf(
                            "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                            $id,
                            var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                            var_export(!$tmp_user->checkTimeLimit(), 1)
                        ));
                        continue;
                    }
                    
                    
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $newEmailAddresses = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
                        $as_email = array_unique(array_merge($newEmailAddresses, $as_email));

                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $cc_and_bcc_message,
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            if (count($as_email)) {
                $this->sendMimeMail('', '', implode(',', $as_email), $a_subject, $this->formatLinebreakMessage($cc_and_bcc_message), $a_attachments);
            }
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enableSOAP()

ilMail::enableSOAP

(

$a_status

)

Define if external mails should be sent using SOAP client or not.

The autogenerated mails in new user registration sets this value to false, since there is no valid session.

Parameters

bool

$a_status

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

    {
        $this->soap_enabled = (bool) $a_status;
    }

existsRecipient()

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

Parameters

string	$newRecipient
string	$existingRecipients

Returns

bool

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

References $list, and parseAddresses().

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

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

        $diffedAddresses = $list->value();

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

Here is the call graph for this function:

fetchMailData()

ilMail::fetchMailData (   $a_row )

protected

Parameters

array|null

Returns

array|null

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

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

    {
        if (!is_array($a_row) || empty($a_row)) {
            return null;
        }

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

        return $a_row;
    }

Here is the caller graph for this function:

formatLinebreakMessage()

ilMail::formatLinebreakMessage

(

$a_message

)

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

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

    {
        return $a_message;
    }

Here is the caller graph for this function:

formatNamesForOutput()

ilMail::formatNamesForOutput

(

$a_recipients

)

Prepends the fullname of each ILIAS login name (if user has a public profile) found in the passed string and brackets the ILIAS login name afterwards.

Parameters

string

$a_recipients

A string containing to, cc or bcc recipients

Returns

string

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

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

    {
        global $DIC;

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

        $names = array();

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

            $names[] = $recipient;
        }

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

Here is the call graph for this function:

getCachedUserInstance()

static ilMail::getCachedUserInstance (   $a_usr_id )

staticprotected

Parameters

int

$a_usr_id

Returns

ilObjUser

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

    {
        if (isset(self::$userInstances[$a_usr_id])) {
            return self::$userInstances[$a_usr_id];
        }

        self::$userInstances[$a_usr_id] = new ilObjUser($a_usr_id);
        return self::$userInstances[$a_usr_id];
    }

getCountRecipient()

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

protected

Parameters

string	$recipients
bool	$onlyExternalAddresses

Returns

int

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCountRecipients()

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

protected

Parameters

string	$toRecipients
string	$ccRecipients
	$bccRecipients
bool	$onlyExternalAddresses

Returns

int

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

References getCountRecipient().

Referenced by sendMail().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getEmailRecipients()

ilMail::getEmailRecipients ( string  $recipients )

protected

Parameters

string

$recipients

Returns

string

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

References parseAddresses().

Referenced by sendMail().

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMail()

ilMail::getMail

(

$a_mail_id

)

Parameters

int

$a_mail_id

Returns

array

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

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

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

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

        return $this->mail_data;
    }

Here is the call graph for this function:

getMailObjectReferenceId()

ilMail::getMailObjectReferenceId

(

)

Returns

int

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

References $mail_obj_ref_id.

    {
        return $this->mail_obj_ref_id;
    }

getMailsOfFolder()

ilMail::getMailsOfFolder	(		$a_folder_id,
			$filter = array()
	)

Parameters

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

Returns

array

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

References Sabre\VObject\$output, $query, $res, $row, and fetchMailData().

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

    {
        $output = array();

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

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

        if (isset($filter['type']) && strlen($filter['type']) > 0) {
            $query .= ' AND ' . $this->db->like('m_type', 'text', '%%:"' . $filter['type'] . '"%%', false);
        }

        $query .= " ORDER BY send_time DESC";

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

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

        return $output;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewDraftId()

ilMail::getNewDraftId	(		$usrId,
			$folderId
	)

Parameters

int	$usrId
int	$folderId

Returns

int

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

    {
        $next_id = $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, array(
            'mail_id' => array('integer', $next_id),
            'user_id' => array('integer', $usrId),
            'folder_id' => array('integer', $folderId),
            'sender_id' => array('integer', $usrId)
        ));

        return $next_id;
    }

getNextMail()

ilMail::getNextMail

(

$a_mail_id

)

Parameters

int

$a_mail_id

Returns

array

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

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

    {
        $this->db->setLimit(1);

        $res = $this->db->queryF(
            "
                        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",
            array('integer', 'integer'),
            array($this->user_id, $a_mail_id)
        );

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

        return $this->mail_data;
    }

Here is the call graph for this function:

getPreviousMail()

ilMail::getPreviousMail

(

$a_mail_id

)

Parameters

int

$a_mail_id

Returns

array

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

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

    {
        $this->db->setLimit(1);

        $res = $this->db->queryF(
            "
                        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",
            array('integer', 'integer'),
            array($this->user_id, $a_mail_id)
        );

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

        return $this->mail_data;
    }

Here is the call graph for this function:

getSalutation()

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

static

Parameters

int	$a_usr_id
	$a_language	ilLanguage|null

Returns

string

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

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

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

    {
        global $DIC;

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSavedData()

ilMail::getSavedData

(

)

Returns

array

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

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

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

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

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

        return $this->mail_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveInSentbox()

ilMail::getSaveInSentbox

(

)

Returns

bool

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

References $save_in_sentbox.

Referenced by sendMail().

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

Here is the caller graph for this function:

getSubjectPrefix()

static ilMail::getSubjectPrefix ( )

static

Get text that will be prepended to auto generated mails.

Returns

string subject prefix

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

References $DIC.

Referenced by ilMimeMail\Subject().

    {
        global $DIC;

        $subjectPrefix = $DIC->settings()->get('mail_subject_prefix');
        if (false === $subjectPrefix) {
            $subjectPrefix = self::MAIL_SUBJECT_PREFIX;
        }

        return $subjectPrefix;
    }

Here is the caller graph for this function:

getUserIds()

ilMail::getUserIds ( array  $recipients )

protected

Parameters

string[]

$recipients

Returns

int[]

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

References parseAddresses().

Referenced by distributeMail().

                                                     : array
    {
        $usrIds = array();

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

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

        return array_unique($usrIds);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSOAPEnabled()

ilMail::isSOAPEnabled

(

)

Returns

bool

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

References $DIC, $soap_enabled, ilContext\CONTEXT_CRON, and ilContext\getType().

Referenced by saveInSentbox().

    {
        global $DIC;

        if (!extension_loaded('curl') || !$DIC->settings()->get('soap_user_administration')) {
            return false;
        }

        if (ilContext::getType() == ilContext::CONTEXT_CRON) {
            return false;
        }

        return (bool) $this->soap_enabled;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSystemMail()

ilMail::isSystemMail ( )

protected

Returns

bool

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

Referenced by sendMail().

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

Here is the caller graph for this function:

markRead()

ilMail::markRead

(

array

$a_mail_ids

)

Parameters

array

$a_mail_ids

Returns

bool

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

References $data, $in, and $query.

    {
        $data = array();
        $data_types = array();

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

        if (count($a_mail_ids) > 0) {
            $in = 'mail_id IN (';
            $counter = 0;
            foreach ($a_mail_ids as $a_mail_id) {
                array_push($data, $a_mail_id);
                array_push($data_types, 'integer');

                if ($counter > 0) {
                    $in .= ',';
                }
                $in .= '%s';
                ++$counter;
            }
            $in .= ')';

            $query .= ' AND ' . $in;
        }

        $this->db->manipulateF($query, $data_types, $data);

        return true;
    }

markUnread()

ilMail::markUnread

(

array

$a_mail_ids

)

Parameters

array

$a_mail_ids

Returns

bool

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

References $data, $in, and $query.

    {
        $data = array();
        $data_types = array();

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

        if (count($a_mail_ids) > 0) {
            $in = 'mail_id IN (';
            $counter = 0;
            foreach ($a_mail_ids as $a_mail_id) {
                array_push($data, $a_mail_id);
                array_push($data_types, 'integer');

                if ($counter > 0) {
                    $in .= ',';
                }
                $in .= '%s';
                ++$counter;
            }
            $in .= ')';

            $query .= ' AND ' . $in;
        }

        $this->db->manipulateF($query, $data_types, $data);

        return true;
    }

moveMailsToFolder()

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

Parameters

	int[]	$mailIds
int	$folderId

Returns

bool

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

References $in, $query, and $values.

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

        $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($dataTypes, 'integer', 'integer', 'integer');
        array_push($values, $folderId, $this->user_id, $this->user_id);

        $in = 'mail_id IN (';
        $counter = 0;
        foreach ($mailIds as $mailId) {
            array_push($values, $mailId);
            array_push($dataTypes, 'integer');

            if ($counter > 0) {
                $in .= ',';
            }
            $in .= '%s';
            ++$counter;
        }
        $in .= ')';

        $query .= ' AND ' . $in;

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

        return $affectedRows > 0;
    }

parseAddresses()

ilMail::parseAddresses (   $addresses )

protected

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

Parameters

string

$addresses

Returns

ilMailAddress[] An array with objects of type ilMailAddress

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

References $parser, and ilLoggerFactory\getLogger().

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

    {
        if (strlen($addresses) > 0) {
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }

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

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

        return $parsedAddresses;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readMailObjectReferenceId()

ilMail::readMailObjectReferenceId ( )

protected

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

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

References ilMailGlobalServices\getMailObjectRefId().

Referenced by __construct().

    {
        require_once 'Services/Mail/classes/class.ilMailGlobalServices.php';
        $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 (   $a_message,   $a_user_id = 0,   $replace_empty = true  )

protected

Parameters

string	$a_message
int	$a_user_id
boolean	$replace_empty

Returns

string

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

References $context, $user, ilLoggerFactory\getLogger(), and ilMailTemplateContextService\getTemplateContextById().

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

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

            $user = $a_user_id > 0 ? self::getCachedUserInstance($a_user_id) : null;

            $processor = new ilMailTemplatePlaceholderResolver($context, $a_message);
            $a_message = $processor->resolve($user, $this->contextParameters, $replace_empty);
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
        }

        return $a_message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAttachments()

ilMail::saveAttachments

(

$a_attachments

)

Parameters

array

$a_attachments

An array of attachments

Returns

bool

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

    {
        $this->db->update(
            $this->table_mail_saved,
            array(
                'attachments' => array('clob', serialize($a_attachments))
            ),
            array(
                'user_id' => array('integer', $this->user_id)
            )
        );

        return true;
    }

saveInSentbox()

ilMail::saveInSentbox (   $a_attachment,   $a_rcp_to,   $a_rcp_cc,   $a_rcp_bcc,   $a_type,   $a_m_subject,   $a_m_message  )

protected

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

Parameters

array	$a_attachment
string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
array	$a_type
string	$a_m_subject
string	$a_m_message

Returns

int mail id

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

References $_COOKIE, $a_type, $GLOBALS, $user_id, isSOAPEnabled(), and sendInternalMail().

Referenced by sendMail().

    {
        return $this->sendInternalMail(
            $this->mailbox->getSentFolder(),
            $this->user_id,
            $a_attachment,
            $a_rcp_to,
            $a_rcp_cc,
            $a_rcp_bcc,
            'read',
            $a_type,
            0,
            $a_m_subject,
            $a_m_message,
            $this->user_id,
            0
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePostData()

ilMail::savePostData	(		$a_user_id,
			$a_attachments,
			$a_rcp_to,
			$a_rcp_cc,
			$a_rcp_bcc,
			$a_m_type,
			$a_m_email,
			$a_m_subject,
			$a_m_message,
			$a_use_placeholders,
			$a_tpl_context_id = null,
			$a_tpl_ctx_params = array()
	)

save post data in table public

Parameters

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

Returns

bool

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

References getSavedData().

Referenced by ilObjUserFolderGUI\mailObject().

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

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

        $this->getSavedData();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendInternalMail()

ilMail::sendInternalMail (   $a_folder_id,   $a_sender_id,   $a_attachments,   $a_rcp_to,   $a_rcp_cc,   $a_rcp_bcc,   $a_status,   $a_m_type,   $a_m_email,   $a_m_subject,   $a_m_message,   $a_user_id = 0,   $a_use_placeholders = 0,   $a_tpl_context_id = null,   $a_tpl_context_params = array()  )

private

save mail in folder private

Parameters

integer	$a_folder_id
integer	$a_sender_id
array	$a_attachments
string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
string	$a_status
array	$a_m_type
integer	$a_m_email
string	$a_m_subject
string	$a_m_message
integer	$a_user_id
integer	$a_use_placeholders
string | null	$a_tpl_context_id
array | null	$a_tpl_context_params

Returns

integer mail_id

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

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

Referenced by distributeMail(), and saveInSentbox().

      {
        $a_user_id = $a_user_id ? $a_user_id : $this->user_id;

        if ($a_use_placeholders) {
            $a_m_message = $this->replacePlaceholders($a_m_message, $a_user_id);
        }
        $a_m_message = $this->formatLinebreakMessage($a_m_message);

        if (!$a_user_id) {
            $a_user_id = '0';
        }
        if (!$a_folder_id) {
            $a_folder_id = '0';
        }
        if (!$a_sender_id) {
            $a_sender_id = null;
        }
        if (!$a_attachments) {
            $a_attachments = null;
        }
        if (!$a_rcp_to) {
            $a_rcp_to = null;
        }
        if (!$a_rcp_cc) {
            $a_rcp_cc = null;
        }
        if (!$a_rcp_bcc) {
            $a_rcp_bcc = null;
        }
        if (!$a_status) {
            $a_status = null;
        }
        if (!$a_m_type) {
            $a_m_type = null;
        }
        if (!$a_m_email) {
            $a_m_email = null;
        }
        if (!$a_m_subject) {
            $a_m_subject = null;
        }
        if (!$a_m_message) {
            $a_m_message = null;
        }

        $nextId = $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, array(
            'mail_id' => array('integer', $nextId),
            'user_id' => array('integer', $a_user_id),
            'folder_id' => array('integer', $a_folder_id),
            'sender_id' => array('integer', $a_sender_id),
            'attachments' => array('clob', serialize($a_attachments)),
            'send_time' => array('timestamp', date('Y-m-d H:i:s', time())),
            'rcp_to' => array('clob', $a_rcp_to),
            'rcp_cc' => array('clob', $a_rcp_cc),
            'rcp_bcc' => array('clob', $a_rcp_bcc),
            'm_status' => array('text', $a_status),
            'm_type' => array('text', serialize($a_m_type)),
            'm_email' => array('integer', $a_m_email),
            'm_subject' => array('text', $a_m_subject),
            'm_message' => array('clob', $a_m_message),
            'tpl_ctx_id' => array('text', $a_tpl_context_id),
            'tpl_ctx_params' => array('blob', @json_encode((array) $a_tpl_context_params))
        ));

        $raiseEvent = (int) $a_user_id !== (int) $this->mailbox->getUserId();
        if (!$raiseEvent) {
            $raiseEvent = (int) $a_folder_id !== (int) $this->mailbox->getSentFolder();
        }

        if ($raiseEvent) {
            $this->eventHandler->raise('Services/Mail', 'sentInternalMail', [
                'id' => (int) $nextId,
                'subject' => (string) $a_m_subject,
                'body' => (string) $a_m_message,
                'from_usr_id' => (int) $a_sender_id,
                'to_usr_id' => (int) $a_user_id,
                'rcp_to' => (string) $a_rcp_to,
                'rcp_cc' => (string) $a_rcp_cc,
                'rcp_bcc' => (string) $a_rcp_bcc,
                'type' => (array) $a_m_type,
            ]);
        }

        return $nextId;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMail()

ilMail::sendMail	(		$a_rcp_to,
			$a_rcp_cc,
			$a_rcp_bc,
			$a_m_subject,
			$a_m_message,
			$a_attachment,
			$a_type,
			$a_use_placeholders = 0
	)

Should be used to send notifcations over the internal or external mail channel.

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bc
string	$a_m_subject
string	$a_m_message
array	$a_attachment
array	$a_type	(normal and/or system and/or email)
bool | int	$a_use_placeholders

Returns

[]

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

References $a_type, $DIC, $errors, appendInstallationSignature(), checkMail(), deleteMails(), distributeMail(), formatLinebreakMessage(), getCountRecipients(), getEmailRecipients(), ilLoggerFactory\getLogger(), getSaveInSentbox(), isSystemMail(), replacePlaceholders(), saveInSentbox(), and validateRecipients().

                                                                                                                                           : array
    {
        global $DIC;

        ilLoggerFactory::getLogger('mail')->debug(
            "New mail system task:" .
            " To: " . $a_rcp_to .
            " | CC: " . $a_rcp_cc .
            " | BCC: " . $a_rcp_bc .
            " | Subject: " . $a_m_subject
        );

        if (in_array('system', $a_type)) {
            $a_type = array('system');
        }

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

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

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

        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bc = $a_rcp_bc;

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

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

        $numberOfExternalAddresses = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bc, true);

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

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

        $sent_id = $this->saveInSentbox($a_attachment, $a_rcp_to, $a_rcp_cc, $a_rcp_bc, $a_type, $a_m_subject, $a_m_message);

        if ($a_attachment) {
            $this->mfile->assignAttachmentsToDirectory($sent_id, $sent_id);
            $this->mfile->saveFiles($sent_id, $a_attachment);
        }

        if ($numberOfExternalAddresses > 0) {
            $externalMailRecipientsTo = $this->getEmailRecipients($rcp_to);
            $externalMailRecipientsCc = $this->getEmailRecipients($rcp_cc);
            $externalMailRecipientsBcc = $this->getEmailRecipients($rcp_bc);

            ilLoggerFactory::getLogger('mail')->debug(
                "Parsed external email addresses from given recipients:" .
                " To: " . $externalMailRecipientsTo .
                " | CC: " . $externalMailRecipientsCc .
                " | BCC: " . $externalMailRecipientsBcc .
                " | Subject: " . $a_m_subject
            );

            $this->sendMimeMail(
                $externalMailRecipientsTo,
                $externalMailRecipientsCc,
                $externalMailRecipientsBcc,
                $a_m_subject,
                $this->formatLinebreakMessage($a_use_placeholders ? $this->replacePlaceholders($a_m_message, 0, false) : $a_m_message),
                $a_attachment,
                0
            );
        } else {
            ilLoggerFactory::getLogger('mail')->debug('No external email addresses given in recipient string');
        }

        if (in_array('system', $a_type) && !$this->distributeMail($rcp_to, $rcp_cc, $rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $sent_id, $a_type, 'system', $a_use_placeholders)) {
            return [new \ilMailError('mail_send_error')];
        }

        if (in_array('normal', $a_type) && !$this->distributeMail($rcp_to, $rcp_cc, $rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $sent_id, $a_type, 'normal', $a_use_placeholders)) {
            return [new \ilMailError('mail_send_error')];
        }

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

        return [];
    }

Here is the call graph for this function:

setSaveInSentbox()

ilMail::setSaveInSentbox

(

$a_save_in_sentbox

)

Parameters

bool

$a_save_in_sentbox

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

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

    {
        $this->save_in_sentbox = (bool) $a_save_in_sentbox;
    }

Here is the caller graph for this function:

updateDraft()

ilMail::updateDraft	(		$a_folder_id,
			$a_attachments,
			$a_rcp_to,
			$a_rcp_cc,
			$a_rcp_bcc,
			$a_m_type,
			$a_m_email,
			$a_m_subject,
			$a_m_message,
			$a_draft_id = 0,
			$a_use_placeholders = 0,
			$a_tpl_context_id = null,
			$a_tpl_context_params = array()
	)

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

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

[] An array of errors determined on validation

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

References $errors, and checkRecipients().

Referenced by sendMail().

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

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

        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withContextId()

ilMail::withContextId

(

string

$contextId

)

Parameters

string

$contextId

Returns

ilMail

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

References $contextId.

                                                     : self
    {
        $clone = clone $this;

        $clone->contextId = $contextId;

        return $clone;
    }

withContextParameters()

ilMail::withContextParameters

(

array

$parameters

)

Parameters

array

$parameters

Returns

ilMail

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

                                                             : self
    {
        $clone = clone $this;

        $clone->contextParameters = $parameters;

        return $clone;
    }

Field Documentation

$appendInstallationSignature

ilMail::$appendInstallationSignature = false

protected

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

Referenced by appendInstallationSignature().

$contextId

ilMail::$contextId = null

protected

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

Referenced by withContextId().

$contextParameters

ilMail::$contextParameters = []

protected

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

$db

ilMail::$db

protected

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

$eventHandler

ilMail::$eventHandler

private

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

Referenced by __construct().

$lng

ilMail::$lng

protected

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

$mail_data

ilMail::$mail_data = array()

protected

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

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

$mail_obj_ref_id

ilMail::$mail_obj_ref_id

protected

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

Referenced by getMailObjectReferenceId().

$mail_options

ilMail::$mail_options

protected

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

$mailAddressParserFactory

ilMail::$mailAddressParserFactory

private

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

Referenced by __construct().

$mailAddressTypeFactory

ilMail::$mailAddressTypeFactory

private

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

Referenced by __construct().

$mailbox

ilMail::$mailbox

protected

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

$mfile

ilMail::$mfile

protected

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

$properties

ilMail::$properties = array()

protected

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

$save_in_sentbox

ilMail::$save_in_sentbox

protected

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

Referenced by getSaveInSentbox().

$soap_enabled

ilMail::$soap_enabled = true

protected

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

Referenced by isSOAPEnabled().

$table_mail

ilMail::$table_mail

protected

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

$table_mail_saved

ilMail::$table_mail_saved

protected

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

$user_id

ilMail::$user_id

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

Referenced by saveInSentbox(), and sendInternalMail().

$userInstances

ilMail::$userInstances = array()

staticprotected

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

ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

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

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

MAIL_SUBJECT_PREFIX

const ilMail::MAIL_SUBJECT_PREFIX = '[ILIAS]'

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

Referenced by ilObjMailGUI\populateExternalSettingsForm().

---

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

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