ilMail Class Reference

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

Inheritance diagram for ilMail:

Collaboration diagram for ilMail:

Public Member Functions
	existsRecipient ($a_recipient, $a_existing_recipients)
	enableSOAP ($a_status)
	Define if external mails should be sent using SOAP client or not. More...
	setSaveInSentbox ($a_save_in_sentbox)
	getSaveInSentbox ()
	getMailObjectReferenceId ()
	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 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 public More...
	getSavedData ()
	validateRecipients ($a_rcp_to, $a_rcp_cc, $a_rcp_bc)
	sendMimeMail ($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject, $a_m_message, $a_attachments, $a_no_soap=false)
	Send mime mail using class.ilMimeMail.php. More...
	saveAttachments ($a_attachments)
	appendInstallationSignature ($a_flag=null)
	Setter/Getter for appending the installation signarue. More...

Data Fields
const	ILIAS_HOST = 'ilias'
	$user_id

Protected Member Functions
	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 ($a_recipients)
	checkMail ($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject, $a_m_message, $a_type)
	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()

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 #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.

Member Function Documentation

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

References $appendInstallationSignature, $ilSetting, $lang, $lng, ilUtil\_getHttpPath(), ilObjUser\_lookupGender(), and ilObjUser\_lookupName().

Referenced by getSavedData().

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

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

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,   $a_m_message,   $a_type  )

protected

Parameters

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

Returns

string array message

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

References $errors, and array.

Referenced by getSavedData().

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

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

References $errors, array, ilMailAddressTypeFactory\getByPrefix(), and parseAddresses().

Referenced by validateRecipients().

        {
                $errors = array();

                try
                {
                        require_once 'Services/Mail/classes/Address/Type/class.ilMailAddressTypeFactory.php';
                        $recipients = $this->parseAddresses($a_recipients);
                        foreach($recipients as $recipient)
                        {
                                $address_type = ilMailAddressTypeFactory::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;
        }

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

References $res, and array.

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

$a_mail_ids

)

Parameters

array

$a_mail_ids

Returns

bool

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

References array.

Referenced by deleteMailsOfFolder(), and getSavedData().

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

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

References $mail_data, array, 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 764 of file class.ilMail.php.

References $a_type, array, ilLoggerFactory\getLogger(), getUserIds(), replacePlaceholders(), sendInternalMail(), and sendMimeMail().

Referenced by getSavedData().

        {
                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(trim($a_rcp_to) . ',' . trim($a_rcp_cc) . ',' . trim($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)
                                {
                                        continue;
                                }

                                if($user_is_active)
                                {
                                        if(!$user_can_read_internal_mails || $tmp_mail_options->getIncomingType() == $this->mail_options->EMAIL)
                                        {
                                                $as_email[] = $tmp_user->getEmail();
                                                continue;
                                        }

                                        if($tmp_mail_options->getIncomingType() == $this->mail_options->BOTH)
                                        {
                                                $as_email[] = $tmp_user->getEmail();
                                        }
                                }

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

                        $to  = array();
                        $bcc = array();

                        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, $a_message, $a_attachments);
                        }
                }
                else
                {
                        $rcp_ids_replace    = $this->getUserIds(trim($a_rcp_to));
                        $rcp_ids_no_replace = $this->getUserIds(trim($a_rcp_cc).','.trim($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)
                                {
                                        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() == $this->mail_options->EMAIL)
                                        {
                                                $as_email[$tmp_user->getId()] = $tmp_user->getEmail();
                                                continue;
                                        }

                                        if($tmp_mail_options->getIncomingType() == $this->mail_options->BOTH)
                                        {
                                                $as_email[$tmp_user->getId()] = $tmp_user->getEmail();
                                        }
                                }

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

                        if(count($as_email))
                        {
                                foreach($as_email as $id => $email)
                                {
                                        $this->sendMimeMail($email, '', '', $a_subject, $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)
                                        {
                                                continue;
                                        }

                                        if(!$user_can_read_internal_mails || $tmp_mail_options->getIncomingType() == $this->mail_options->EMAIL)
                                        {
                                                $as_email[] = $tmp_user->getEmail();
                                                continue;
                                        }

                                        if($tmp_mail_options->getIncomingType() == $this->mail_options->BOTH)
                                        {
                                                $as_email[] = $tmp_user->getEmail();
                                        }
                                }

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

                        if(count($as_email))
                        {
                                $this->sendMimeMail('', '', implode(',', $as_email), $a_subject, $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 213 of file class.ilMail.php.

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

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

Here is the call graph for this function:

existsRecipient()

ilMail::existsRecipient	(		$a_recipient,
			$a_existing_recipients
	)

Parameters

string	$a_recipient
string	$a_existing_recipients

Returns

bool

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

References parseAddresses().

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

Here is the call graph for this function:

fetchMailData()

ilMail::fetchMailData (   $a_row )

protected

Parameters

array|null

Returns

array|null

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

References array.

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:

getCachedUserInstance()

static ilMail::getCachedUserInstance (   $a_usr_id )

staticprotected

Parameters

int

$a_usr_id

Returns

ilObjUser

Definition at line 1714 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 (   $a_recipients,   $a_only_email = true  )

protected

Parameters

string	$a_recipients
bool	$a_only_email

Returns

int

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

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

Referenced by getCountRecipients().

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

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

References getCountRecipient().

Referenced by getSavedData().

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

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

References $ilSetting, $lang, ilUtil\_getHttpPath(), ilLanguageFactory\_getLanguage(), ilObjUser\_lookupId(), array, and parseAddresses().

Referenced by getSavedData().

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

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

References $mail_data, $res, array, 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 267 of file class.ilMail.php.

References $ilUser, $mail_obj_ref_id, $names, ilObjUser\_lookupId(), ilObjUser\_lookupPref(), and array.

        {
                return $this->mail_obj_ref_id;
        }

Here is the call graph for this function:

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

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

Referenced by deleteMailsOfFolder(), 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.

References array.

        {
                $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 338 of file class.ilMail.php.

References $mail_data, $res, array, 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 316 of file class.ilMail.php.

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

getSavedData()

ilMail::getSavedData

(

)

Returns

array

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

References $a_type, $errors, $mail_data, $res, appendInstallationSignature(), array, checkMail(), deleteMails(), distributeMail(), fetchMailData(), getCountRecipients(), getEmailRecipients(), ilLoggerFactory\getLogger(), getSaveInSentbox(), replacePlaceholders(), saveInSentbox(), sendMimeMail(), and validateRecipients().

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

References $save_in_sentbox.

Referenced by getSavedData().

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

Here is the caller graph for this function:

getUserIds()

ilMail::getUserIds (   $a_recipients )

protected

Parameters

string

$a_recipients

recipients seperated by ','

Returns

int[]

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

References array, ilMailAddressTypeFactory\getByPrefix(), and parseAddresses().

Referenced by distributeMail().

        {
                $usr_ids = array();

                require_once 'Services/Mail/classes/Address/Type/class.ilMailAddressTypeFactory.php';  
                $recipients = $this->parseAddresses($a_recipients);
                foreach($recipients as $recipient)
                {
                        $address_type = ilMailAddressTypeFactory::getByPrefix($recipient);
                        $usr_ids = array_merge($usr_ids, $address_type->resolve());
                }

                return array_unique($usr_ids);
        }

Here is the call graph for this function:

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

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

        {
                $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 488 of file class.ilMail.php.

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

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

Parameters

array	$a_mail_ids
int	$a_folder_id

Returns

bool

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

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

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

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

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

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

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

                require_once 'Services/Mail/classes/Address/Parser/class.ilMailRfc822AddressParserFactory.php';
                $parser = ilMailRfc822AddressParserFactory::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;
        }

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

References ilMailGlobalServices\getMailObjectRefId().

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

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

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

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

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

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

References array.

        {
                $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
string	$a_type
string	$a_m_subject
string	$a_m_message

Returns

int mail id

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

References $_SERVER, $a_type, $ilSetting, $ilUser, $user_id, array, ilUtil\is_email(), and sendInternalMail().

Referenced by getSavedData().

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

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

References array, and getSavedData().

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

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 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
string	$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 664 of file class.ilMail.php.

References $user_id, array, date, replacePlaceholders(), and time.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

sendMimeMail()

ilMail::sendMimeMail	(		$a_rcp_to,
			$a_rcp_cc,
			$a_rcp_bcc,
			$a_m_subject,
			$a_m_message,
			$a_attachments,
			$a_no_soap = false
	)

Send mime mail using class.ilMimeMail.php.

All external mails are send to SOAP::sendMail (if enabled) starting a kind of background process

Parameters

string	$a_rcp_to
string	$a_rcp_cc
string	$a_rcp_bcc
string	$a_m_subject
string	$a_m_message
array	$a_attachments
bool	$a_no_soap

Returns

array of saved data

Deprecated:

Should not be called from consumers, please use sendMail()

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

References $_COOKIE, and array.

Referenced by distributeMail(), and getSavedData().

        {
                require_once 'Services/Mail/classes/class.ilMimeMail.php';

                $a_m_subject = self::getSubjectPrefix() . ' ' . $a_m_subject;
                $sender      = $this->getMimeMailSender();

                // #10854
                if($this->isSOAPEnabled() && !$a_no_soap)
                {
                        require_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
                        $soap_client = new ilSoapClient();
                        $soap_client->setResponseTimeout(5);
                        $soap_client->enableWSDL(true);
                        $soap_client->init();

                        $attachments   = array();
                        $a_attachments = $a_attachments ? $a_attachments : array();
                        foreach($a_attachments as $attachment)
                        {
                                $attachments[] = $this->mfile->getAbsolutePath($attachment);
                        }

                        // mjansen: switched separator from "," to "#:#" because of mantis bug #6039
                        $attachments = implode('#:#', $attachments);
                        // mjansen: use "#:#" as leading delimiter
                        if(strlen($attachments))
                        {
                                $attachments = "#:#" . $attachments;
                        }

                        $soap_client->call('sendMail', array(
                                session_id() . '::' . $_COOKIE['ilClientId'],
                                $a_rcp_to,
                                $a_rcp_cc,
                                $a_rcp_bcc,
                                is_array($sender) ? implode('#:#', $sender) : $sender,
                                $a_m_subject,
                                $a_m_message,
                                $attachments
                        ));

                        return true;
                }
                else
                {
                        // send direct
                        include_once "Services/Mail/classes/class.ilMimeMail.php";

                        $mmail = new ilMimeMail();
                        $mmail->autoCheck(false);
                        $mmail->From($sender);
                        $mmail->To($a_rcp_to);
                        $mmail->Subject($a_m_subject);
                        $mmail->Body($a_m_message);

                        if($a_rcp_cc)
                        {
                                $mmail->Cc($a_rcp_cc);
                        }

                        if($a_rcp_bcc)
                        {
                                $mmail->Bcc($a_rcp_bcc);
                        }

                        if(is_array($a_attachments))
                        {
                                foreach($a_attachments as $attachment)
                                {
                                        $mmail->Attach($this->mfile->getAbsolutePath($attachment), '', 'inline', $attachment);
                                }
                        }

                        $mmail->Send();
                }
        }

Here is the caller graph for this function:

setSaveInSentbox()

ilMail::setSaveInSentbox

(

$a_save_in_sentbox

)

Parameters

bool

$a_save_in_sentbox

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

Referenced by 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.

References array, date, and time.

        {
                $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	(		$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 1247 of file class.ilMail.php.

References $errors, array, and checkRecipients().

Referenced by getSavedData().

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

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

Referenced by appendInstallationSignature().

$db

ilMail::$db

protected

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

$lng

ilMail::$lng

protected

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

Referenced by appendInstallationSignature().

$mail_data

ilMail::$mail_data = array()

protected

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

Referenced by getMailObjectReferenceId().

$mail_options

ilMail::$mail_options

protected

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

$mail_to_global_roles

ilMail::$mail_to_global_roles = 0

protected

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

$mfile

ilMail::$mfile

protected

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

$properties

ilMail::$properties = array()

protected

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

$save_in_sentbox

ilMail::$save_in_sentbox

protected

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

Referenced by getSaveInSentbox().

$soap_enabled

ilMail::$soap_enabled = true

protected

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

Referenced by enableSOAP().

$table_mail

ilMail::$table_mail

protected

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

$table_mail_saved

ilMail::$table_mail_saved

protected

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

$user_id

ilMail::$user_id

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

Referenced by saveInSentbox(), and sendInternalMail().

$userInstances

ilMail::$userInstances = array()

staticprotected

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

ILIAS_HOST

const ilMail::ILIAS_HOST = 'ilias'

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

Referenced by ilMailAddressTypeFactory\getByPrefix(), ilMailRoleAddressType\getRoleIdsByAddress(), ilUtil\is_email(), ilMailImapRfc822AddressParser\parseAddressString(), ilMailPearRfc822WrapperAddressParser\parseAddressString(), and ilMailLoginOrEmailAddressAddressType\resolve().

---

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

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