This class handles base functions for mail handling. More...

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

Public Member Functions
	__construct ( $a_user_id, ilMailAddressTypeFactory $mailAddressTypeFactory=null, ilMailRfc822AddressParserFactory $mailAddressParserFactory=null)

	__get ($name)
	Magic interceptor method __get Used to include files / instantiate objects at runtime. More...

	existsRecipient ($a_recipient, $a_existing_recipients)

	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 $a_mail_ids, $a_folder_id)

	deleteMails (array $a_mail_ids)

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

	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 @access private More...

	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 @access 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 ($a_rcp_to, $a_rcp_cc, $a_rcp_bc)

	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 $a_recipients)

	checkMail ($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject)

	checkRecipients ($a_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 ($a_recipients, $a_only_email=true)

	getCountRecipients ($a_to, $a_cc, $a_bcc, $a_only_email=true)

	getEmailRecipients ($a_recipients)

Static Protected Member Functions
static	getCachedUserInstance ($a_usr_id)

Protected Attributes
	$lng

	$db

	$mfile

	$mail_options

	$table_mail

	$table_mail_saved

	$mail_data = array()

	$mail_obj_ref_id

	$save_in_sentbox

	$soap_enabled = true

	$mail_to_global_roles = 0

	$appendInstallationSignature = false

	$properties = array()

Static Protected Attributes
static	$userInstances = array()

Private Attributes
	$mailAddressTypeFactory

	$mailAddressParserFactory

Detailed Description

This class handles base functions for mail handling.

RFC 822 compliant email addresses

ILIAS is enabled to use standards compliant email addresses. The class supports RFC 822 compliant address lists as specified in http://www.ietf.org/rfc/rfc0822.txt

Examples: The following mailbox addresses work for sending an email to the user with the login john.doe and email address jd@ma.nosp@m.il.c.nosp@m.om. The user is member of the course "French Course". The member role of the course object has the name "il_crs_member_998" and the object ID "1000".

john.doe John Doe <john.doe> john.doe@ilias #member@[French Course] #il_crs_member_998 #il_role_1000 jd@ma.nosp@m.il.c.nosp@m.om John Doe jd@ma.nosp@m.il.c.nosp@m.om

Syntax Rules: The following excerpt from chapter 6.1 "Syntax" of RFC 822 is relevant for the semantics described below:

addr-spec = local-part [ "@", domain ]

Semantics: User account mailbox address:

The local-part denotes the login of an ILIAS user account.
The domain denotes the current ILIAS client.
The local-part must not start with a "#" character
The domain must be omitted or must have the value "ilias"

Role object mailbox address:

The local part denotes the title of an ILIAS role.
The domain denotes the title of an ILIAS object.
The local-part must start with a "#" character.
If the domain is omitted, the title "ilias" is assumed.
If the local-part starts with "#il_role_" its remaining characters directly specify the object id of the role. For example "#il_role_1234 identifies the role with object id "1234". - If the object title identifies an object that is an ILIAS role, then the local-part is ignored. - If the object title identifies an object that is not an ILIAS role, then the local-part is used to identify a local role for that object. - The local-part can be a substring of the role name. For example, "#member" can be used instead of "#il_crs_member_1234". External Email address: - The local-part must not start with a "#" character - The domain must be specified and it must not have the value "ilias"

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilMail::__construct	(		$a_user_id,
		ilMailAddressTypeFactory	$mailAddressTypeFactory = `null`,
		ilMailRfc822AddressParserFactory	$mailAddressParserFactory = `null`
	)

Parameters

integer	$a_user_id
ilMailAddressTypeFactory \| null	$mailAddressTypeFactory
ilMailRfc822AddressParserFactory \| null	$mailAddressParserFactory

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

      {
        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();
        }
 
        $this->mailAddressParserFactory = $mailAddressParserFactory;
        $this->mailAddressTypeFactory = $mailAddressTypeFactory;
 
        $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->setSaveInSentbox(false);
        $this->readMailObjectReferenceId();
    }

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

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

    {
        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];
            }
        }
    }

References $DIC, and $name.

◆ _getAutoGeneratedMessageString()

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

static

Get auto generated info string.

Parameters

ilLanguage $lang

Returns: string;

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

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

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

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

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

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

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

Referenced by ilSystemNotification\compose(), ilForumMailNotification\send(), ilMailCronOrphanedMailsNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), sendMail(), and ilObjSurveyGUI\sendUserResultsMail().

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

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

References $appendInstallationSignature, and appendInstallationSignature().

Referenced by appendInstallationSignature(), and sendMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkMail()

ilMail::checkMail	(	$a_rcp_to,
		$a_rcp_cc,
		$a_rcp_bcc,
		$a_m_subject
	)

protected

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
string	$a_m_subject

Returns: array message

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

    {
        $errors =  array();
        foreach (array(
            $a_m_subject => array('mail_add_subject'),
            $a_rcp_to    => array('mail_add_recipient')
        ) as $string => $e) {
            if (strlen($string) === 0) {
                $errors[] = $e;
            }
        }
 
        return $errors;
    }

References $errors.

Referenced by sendMail().

Here is the caller graph for this function:

◆ checkRecipients()

ilMail::checkRecipients ( $a_recipients )

protected

Check if recipients are valid.

Parameters

string	$a_recipients	string with login names or group names (start with #)
string	$a_type

Returns: array Returns an empty array, if all recipients are okay. Returns an array with invalid recipients, if some are not okay.

Exceptions

ilMailException

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

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

References $errors, and parseAddresses().

Referenced by validateRecipients().

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

    {
        $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);
    }

References $res.

◆ deleteMails()

ilMail::deleteMails ( array $a_mail_ids )

Parameters

array $a_mail_ids

Returns: bool

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

    {
        foreach ($a_mail_ids 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;
    }

References $id.

Referenced by deleteMailsOfFolder(), and sendMail().

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

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

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

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

    {
        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 || count($bcc) > 0) {
                $this->sendMimeMail(implode(',', $to), '', implode(',', $bcc), $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;
    }

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

Referenced by sendMail().

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

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

◆ existsRecipient()

ilMail::existsRecipient	(	$a_recipient,
		$a_existing_recipients
	)

Parameters

string	$a_recipient
string	$a_existing_recipients

Returns: bool

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

    {
        $recipients = $this->parseAddresses($a_existing_recipients);
        foreach ($recipients as $rcp) {
            if (substr($rcp->getMailbox(), 0, 1) != '#') {
                if (trim($rcp->getMailbox()) == trim($a_recipient) || trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            } elseif (substr($rcp->getMailbox(), 0, 7) == '#il_ml_') {
                if (trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            } else {
                if (trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            }
        }
 
        return false;
    }

References parseAddresses().

Here is the call graph for this function:

◆ fetchMailData()

ilMail::fetchMailData ( $a_row )

protected

Parameters

array|null

Returns: array|null

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

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

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

Here is the caller graph for this function:

◆ formatLinebreakMessage()

ilMail::formatLinebreakMessage ( $a_message )

Reimplemented in ilFormatMail.

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

    {
        return $a_message;
    }

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

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

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

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

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 1731 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];
    }

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

Here is the caller graph for this function:

◆ getCountRecipient()

ilMail::getCountRecipient	(	$a_recipients,
		$a_only_email = `true`
	)

protected

Parameters

string	$a_recipients
bool	$a_only_email

Returns: int

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

    {
        $counter = 0;
 
        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            if ($a_only_email) {
                // Fixed mantis bug #5875
                if (ilObjUser::_lookupId($recipient->getMailbox() . '@' . $recipient->getHost())) {
                    continue;
                }
 
                // Addresses which aren't on the self::ILIAS_HOST host, and
                // which have a mailbox which does not start with '#',
                // are external e-mail addresses
                if ($recipient->getHost() != self::ILIAS_HOST && substr($recipient->getMailbox(), 0, 1) != '#') {
                    ++$counter;
                }
            } else {
                ++$counter;
            }
        }
 
        return $counter;
    }

References $counter, ilObjUser\_lookupId(), and parseAddresses().

Referenced by getCountRecipients().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCountRecipients()

ilMail::getCountRecipients	(	$a_to,
		$a_cc,
		$a_bcc,
		$a_only_email = `true`
	)

protected

Parameters

string	$a_to
string	$a_cc
string	$a_bcc
bool	$a_only_email

Returns: int

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

    {
        return
            $this->getCountRecipient($a_to, $a_only_email) +
            $this->getCountRecipient($a_cc, $a_only_email) +
            $this->getCountRecipient($a_bcc, $a_only_email);
    }

References getCountRecipient().

Referenced by sendMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmailRecipients()

ilMail::getEmailRecipients ( $a_recipients )

protected

Parameters

string $a_recipients

Returns: string

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

    {
        $rcp = array();
 
        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            if (substr($recipient->getMailbox(), 0, 1) != '#' && $recipient->getHost() != self::ILIAS_HOST) {
                // Fixed mantis bug #5875
                if (ilObjUser::_lookupId($recipient->getMailbox() . '@' . $recipient->getHost())) {
                    continue;
                }
 
                $rcp[] = $recipient->getMailbox() . '@' . $recipient->getHost();
            }
        }
 
        return implode(',', $rcp);
    }

References ilObjUser\_lookupId(), and parseAddresses().

Referenced by sendMail().

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

    {
        $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;
    }

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

Here is the call graph for this function:

◆ getMailObjectReferenceId()

ilMail::getMailObjectReferenceId ( )

Returns: int

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

    {
        return $this->mail_obj_ref_id;
    }

References $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 370 of file class.ilMail.php.

    {
        $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;
    }

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

Referenced by deleteMailsOfFolder().

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

    {
        $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;
    }

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

Here is the call graph for this function:

◆ getPreviousMail()

ilMail::getPreviousMail ( $a_mail_id )

Parameters

int $a_mail_id

Returns: array

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

    {
        $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;
    }

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSavedData()

ilMail::getSavedData ( )

Returns: array

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

    {
        $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;
    }

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

Referenced by savePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSaveInSentbox()

ilMail::getSaveInSentbox ( )

Returns: bool

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

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

References $save_in_sentbox.

Referenced by sendMail().

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

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

References $DIC, and MAIL_SUBJECT_PREFIX.

Referenced by ilMimeMail\Subject().

Here is the caller graph for this function:

◆ getUserIds()

ilMail::getUserIds ( array $a_recipients )

protected

Parameters

string[] $a_recipients

Returns: int[]

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

    {
        $usr_ids = array();
 
        $a_recipients = implode(',', array_filter(array_map('trim', $a_recipients)));
 
        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            $address_type = $this->mailAddressTypeFactory->getByPrefix($recipient);
            $usr_ids = array_merge($usr_ids, $address_type->resolve());
        }
 
        return array_unique($usr_ids);
    }

References parseAddresses().

Referenced by distributeMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSOAPEnabled()

ilMail::isSOAPEnabled ( )

Returns: bool

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

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

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

Here is the call graph for this function:

◆ isSystemMail()

ilMail::isSystemMail ( )

protected

Returns: bool

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

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

Referenced by sendMail().

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

    {
        $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;
    }

References $counter, $data, $in, and $query.

◆ markUnread()

ilMail::markUnread ( array $a_mail_ids )

Parameters

array $a_mail_ids

Returns: bool

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

    {
        $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;
    }

References $counter, $data, $in, and $query.

◆ moveMailsToFolder()

ilMail::moveMailsToFolder	(	array	$a_mail_ids,
			$a_folder_id
	)

Parameters

array	$a_mail_ids
int	$a_folder_id

Returns: bool

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

    {
        $data       = array();
        $data_types = array();
 
        $query = "UPDATE {$this->table_mail} SET folder_id = %s WHERE user_id = %s ";
        array_push($data_types, 'text', 'integer');
        array_push($data, $a_folder_id, $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;
    }

References $counter, $data, $in, and $query.

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

    {
        if (strlen($addresses) > 0) {
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }
 
        $parser = $this->mailAddressParserFactory->getParser($addresses);
        $parsedAddresses = $parser->parse();
 
        if (strlen($addresses) > 0) {
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed addresses: %s",
                implode(',', array_map(function (ilMailAddress $address) {
                    return $address->getMailbox() . '@' . $address->getHost();
                }, $parsedAddresses))
            ));
        }
 
        return $parsedAddresses;
    }

References $parser, ilMailAddress\getHost(), ilLoggerFactory\getLogger(), ilMailAddress\getMailbox(), and sprintf.

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

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

    {
        require_once 'Services/Mail/classes/class.ilMailGlobalServices.php';
        $this->mail_obj_ref_id = ilMailGlobalServices::getMailObjectRefId();
    }

References ilMailGlobalServices\getMailObjectRefId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replacePlaceholders()

ilMail::replacePlaceholders	(	$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 772 of file class.ilMail.php.

    {
        try {
            include_once 'Services/Mail/classes/class.ilMailFormCall.php';
 
            if (ilMailFormCall::getContextId()) {
                require_once 'Services/Mail/classes/class.ilMailTemplateService.php';
                $context = ilMailTemplateService::getTemplateContextById(ilMailFormCall::getContextId());
            } else {
                require_once 'Services/Mail/classes/class.ilMailTemplateGenericContext.php';
                $context = new ilMailTemplateGenericContext();
            }
 
            $user = $a_user_id > 0 ? self::getCachedUserInstance($a_user_id) : null;
 
            require_once 'Services/Mail/classes/class.ilMailTemplatePlaceholderResolver.php';
            $processor = new ilMailTemplatePlaceholderResolver($context, $a_message);
            $a_message = $processor->resolve($user, ilMailFormCall::getContextParameters(), $replace_empty);
        } catch (Exception $e) {
            require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
            ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
        }
 
        return $a_message;
    }

References getCachedUserInstance(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilLoggerFactory\getLogger(), and ilMailTemplateService\getTemplateContextById().

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

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

    {
        require_once 'Services/Mail/classes/class.ilMailbox.php';
 
        $mbox           = new ilMailbox($this->user_id);
        $sent_folder_id = $mbox->getSentFolder();
 
        return $this->sendInternalMail(
            $sent_folder_id,
            $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
        );
    }

References $a_type, and sendInternalMail().

Referenced by sendMail().

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 @access 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 1163 of file class.ilMail.php.

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

References getSavedData().

Here is the call 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()`
	)

save mail in folder @access 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 682 of file class.ilMail.php.

      {
        $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;
        }
 
        $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', $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))
        ));
 
        return $next_id;
    }

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

Referenced by distributeMail(), and saveInSentbox().

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

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

    {
        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
        );
 
        $this->mail_to_global_roles = true;
        if (!$this->isSystemMail()) {
            $this->mail_to_global_roles = $DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'mail_to_global_roles', $this->mail_obj_ref_id);
        }
 
        if (in_array('system', $a_type)) {
            $a_type = array('system');
        }
 
        if ($a_attachment && !$this->mfile->checkFilesExist($a_attachment)) {
            return array(array('mail_attachment_file_not_exist', $a_attachment));
        }
 
        $errors = $this->checkMail($a_rcp_to, $a_rcp_cc, $a_rcp_bc, $a_m_subject);
        if (count($errors) > 0) {
            return $errors;
        }
 
        $errors = $this->validateRecipients($a_rcp_to, $a_rcp_cc, $a_rcp_bc);
        if (count($errors) > 0) {
            return $errors;
        }
 
        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bc = $a_rcp_bc;
 
        $c_emails = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bc, true);
 
        if (
            $c_emails && !$this->isSystemMail() &&
            !$DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'smtp_mail', $this->mail_obj_ref_id)
        ) {
            return array(array('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 ($c_emails) {
            $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 array(array('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 array(array('mail_send_error'));
        }
 
        if (!$this->getSaveInSentbox()) {
            $this->deleteMails(array($sent_id));
        }
 
        return array();
    }

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

Here is the call graph for this function:

◆ setSaveInSentbox()

ilMail::setSaveInSentbox ( $a_save_in_sentbox )

Parameters

bool $a_save_in_sentbox

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

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

Referenced by __construct().

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

References date.

◆ validateRecipients()

ilMail::validateRecipients	(	$a_rcp_to,
		$a_rcp_cc,
		$a_rcp_bc
	)

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bc

Returns: array Returns an empty array if there is no validation issue

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

    {
        try {
            $errors = array();
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_to));
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_cc));
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_bc));
 
            if (count($errors) > 0) {
                return array_merge(array(array('mail_following_rcp_not_valid')), $errors);
            }
        } catch (ilMailException $e) {
            return array(array('mail_generic_rcp_error', $e->getMessage()));
        }
 
        return array();
    }

References $errors, and checkRecipients().

Referenced by sendMail().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $appendInstallationSignature

ilMail::$appendInstallationSignature = false

protected

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

Referenced by appendInstallationSignature().

◆ $db

ilMail::$db

protected

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

◆ $lng

ilMail::$lng

protected

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

◆ $mail_data

ilMail::$mail_data = array()

protected

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

Referenced by getMailObjectReferenceId().

◆ $mail_options

ilMail::$mail_options

protected

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

◆ $mail_to_global_roles

ilMail::$mail_to_global_roles = 0

protected

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

◆ $mailAddressParserFactory

ilMail::$mailAddressParserFactory

private

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

Referenced by __construct().

◆ $mailAddressTypeFactory

ilMail::$mailAddressTypeFactory

private

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

Referenced by __construct().

◆ $mfile

ilMail::$mfile

protected

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

◆ $properties

ilMail::$properties = array()

protected

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

◆ $save_in_sentbox

ilMail::$save_in_sentbox

protected

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

Referenced by getSaveInSentbox().

◆ $soap_enabled

ilMail::$soap_enabled = true

protected

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

Referenced by isSOAPEnabled().

◆ $table_mail

ilMail::$table_mail

protected

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

◆ $table_mail_saved

ilMail::$table_mail_saved

protected

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

◆ $user_id

ilMail::$user_id

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

Referenced by sendInternalMail().

◆ $userInstances

ilMail::$userInstances = array()

staticprotected

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

◆ ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

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

Referenced by ilMailAddressTypeFactory\__construct(), ilUtil\is_email(), ilMailLoginOrEmailAddressAddressType\isValid(), ilMailImapRfc822AddressParser\parseAddressString(), ilMailPearRfc822WrapperAddressParser\parseAddressString(), ilMailLoginOrEmailAddressAddressType\resolve(), and ilMailRoleAddressType\searchRolesByMailboxAddressList().

◆ MAIL_SUBJECT_PREFIX

const ilMail::MAIL_SUBJECT_PREFIX = '[ILIAS]'

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

Referenced by getSubjectPrefix(), and ilObjMailGUI\populateExternalSettingsForm().

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

Services/Mail/classes/class.ilMail.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

RFC 822 compliant email addresses

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ _getAutoGeneratedMessageString()

◆ _getInstallationSignature()

◆ appendInstallationSignature()

◆ checkMail()

◆ checkRecipients()

◆ countMailsOfFolder()

◆ deleteMails()

◆ deleteMailsOfFolder()

◆ distributeMail()

◆ enableSOAP()

◆ existsRecipient()

◆ fetchMailData()

◆ formatLinebreakMessage()

◆ formatNamesForOutput()

◆ getCachedUserInstance()

◆ getCountRecipient()

◆ getCountRecipients()

◆ getEmailRecipients()

◆ getMail()

◆ getMailObjectReferenceId()

◆ getMailsOfFolder()

◆ getNewDraftId()

◆ getNextMail()

◆ getPreviousMail()

◆ getSalutation()

◆ getSavedData()

◆ getSaveInSentbox()

◆ getSubjectPrefix()

◆ getUserIds()

◆ isSOAPEnabled()

◆ isSystemMail()

◆ markRead()

◆ markUnread()

◆ moveMailsToFolder()

◆ parseAddresses()

◆ readMailObjectReferenceId()

◆ replacePlaceholders()

◆ saveAttachments()

◆ saveInSentbox()

◆ savePostData()

◆ sendInternalMail()

◆ sendMail()

◆ setSaveInSentbox()

◆ updateDraft()

◆ validateRecipients()

Field Documentation

◆ $appendInstallationSignature

◆ $db

◆ $lng

◆ $mail_data

◆ $mail_obj_ref_id

◆ $mail_options

◆ $mail_to_global_roles

◆ $mailAddressParserFactory

◆ $mailAddressTypeFactory

◆ $mfile

◆ $properties

◆ $save_in_sentbox

◆ $soap_enabled

◆ $table_mail

◆ $table_mail_saved

◆ $user_id

◆ $userInstances

◆ ILIAS_HOST

◆ MAIL_SUBJECT_PREFIX