Class ilMailOptions this class handles user mails. More...

Collaboration diagram for ilMailOptions:

Public Member Functions
	__construct (int $usrId, ilMailTransportSettings $mailTransportSettings=null, ilSetting $settings=null, ilDBInterface $db=null)

	createMailOptionsEntry ()
	create entry in table_mail_options for a new user this method should only be called from createUser() More...

	mayModifyIndividualTransportSettings ()

	maySeeIndividualTransportSettings ()

	mayManageInvididualSettings ()

	updateOptions ()

	getLinebreak ()

	getSignature ()

	getIncomingType ()

	setLinebreak (int $linebreak)

	setSignature (string $signature)

	setIncomingType (int $incomingType)

	setIsCronJobNotificationStatus (bool $isCronJobNotificationEnabled)

	isCronJobNotificationEnabled ()

	getEmailAddressMode ()

	setEmailAddressMode (int $emailAddressMode)

	getExternalEmailAddresses ()

Data Fields
const	INCOMING_LOCAL = 0

const	INCOMING_EMAIL = 1

const	INCOMING_BOTH = 2

const	FIRST_EMAIL = 3

const	SECOND_EMAIL = 4

const	BOTH_EMAIL = 5

const	DEFAULT_LINE_BREAK = 60

Protected Member Functions
	read ()

Protected Attributes
ILIAS	$ilias

ilDBInterface	$db

int	$usrId = 0

ilSetting	$settings

string	$table_mail_options = 'mail_options'

int	$linebreak = 0

string	$signature = ''

bool	$isCronJobNotificationEnabled = false

int	$incomingType = self::INCOMING_LOCAL

int	$default_incoming_type = self::INCOMING_LOCAL

int	$emailAddressMode = self::FIRST_EMAIL

int	$default_email_address_mode = self::FIRST_EMAIL

ilMailTransportSettings	$mailTransportSettings

string	$firstEmailAddress = ''

string	$secondEmailAddress = ''

Static Private Member Functions
static	lookupNotificationSetting (int $usrId)

Detailed Description

Class ilMailOptions this class handles user mails.

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

Definition at line 26 of file class.ilMailOptions.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailOptions::__construct	(	int	$usrId,
		ilMailTransportSettings	$mailTransportSettings = `null`,
		ilSetting	$settings = `null`,
		ilDBInterface	$db = `null`
	)

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

References $default_email_address_mode, $default_incoming_type, $DIC, $usrId, ILIAS\Repository\int(), isCronJobNotificationEnabled(), read(), and ILIAS\Repository\settings().

       {
         global $DIC;
         $this->usrId = $usrId;
         $this->db = $db ?? $DIC->database();
         $this->settings = $settings ?? $DIC->settings();
         $this->mailTransportSettings = $mailTransportSettings ?? new ilMailTransportSettings($this);
 
         $this->incomingType = self::INCOMING_LOCAL;
         $default_incoming_type = $this->settings->get('mail_incoming_mail', '');
         if ($default_incoming_type !== '') {
             $this->default_incoming_type = (int) $default_incoming_type;
             $this->incomingType = $this->default_incoming_type;
         }
 
         $this->emailAddressMode = self::FIRST_EMAIL;
         $default_email_address_mode = $this->settings->get('mail_address_option', '');
         if ($default_email_address_mode !== '') {
             $this->default_email_address_mode = (int) $default_email_address_mode;
             $this->emailAddressMode = $this->default_email_address_mode;
         }
 
         $this->linebreak = self::DEFAULT_LINE_BREAK;
         $this->isCronJobNotificationEnabled = false;
         $this->signature = '';
 
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createMailOptionsEntry()

ilMailOptions::createMailOptionsEntry ( )

create entry in table_mail_options for a new user this method should only be called from createUser()

Definition at line 88 of file class.ilMailOptions.php.

References isCronJobNotificationEnabled().

                                             : void
     {
         $this->db->replace(
             $this->table_mail_options,
             [
                 'user_id' => ['integer', $this->usrId],
             ],
             [
                 'linebreak' => ['integer', $this->linebreak],
                 'signature' => ['text', $this->signature],
                 'incoming_type' => ['integer', $this->default_incoming_type],
                 'mail_address_option' => ['integer', $this->default_email_address_mode],
                 'cronjob_notification' => ['integer', (int) $this->isCronJobNotificationEnabled]
             ]
         );
     }

Here is the call graph for this function:

◆ getEmailAddressMode()

ilMailOptions::getEmailAddressMode ( )

Definition at line 241 of file class.ilMailOptions.php.

References $emailAddressMode.

Referenced by getExternalEmailAddresses(), and updateOptions().

                                          : int
     {
         return $this->emailAddressMode;
     }

Here is the caller graph for this function:

◆ getExternalEmailAddresses()

ilMailOptions::getExternalEmailAddresses ( )

Returns: string[]

Definition at line 267 of file class.ilMailOptions.php.

References $firstEmailAddress, $secondEmailAddress, and getEmailAddressMode().

                                                : array
     {
         $emailAddresses = [];
 
         switch ($this->getEmailAddressMode()) {
             case self::SECOND_EMAIL:
                 if ($this->secondEmailAddress !== '') {
                     $emailAddresses[] = $this->secondEmailAddress;
                 } elseif ($this->firstEmailAddress !== '') {
                     // fallback, use first email address
                     $emailAddresses[] = $this->firstEmailAddress;
                 }
                 break;
 
             case self::BOTH_EMAIL:
                 if ($this->firstEmailAddress !== '') {
                     $emailAddresses[] = $this->firstEmailAddress;
                 }
                 if ($this->secondEmailAddress !== '') {
                     $emailAddresses[] = $this->secondEmailAddress;
                 }
                 break;
 
             case self::FIRST_EMAIL:
             default:
                 if ($this->firstEmailAddress !== '') {
                     $emailAddresses[] = $this->firstEmailAddress;
                 } elseif ($this->secondEmailAddress !== '') {
                     // fallback, use first email address
                     $emailAddresses[] = $this->secondEmailAddress;
                 }
                 break;
         }
 
         return $emailAddresses;
     }

Here is the call graph for this function:

◆ getIncomingType()

ilMailOptions::getIncomingType ( )

Definition at line 211 of file class.ilMailOptions.php.

References $incomingType.

Referenced by updateOptions().

                                      : int
     {
         return $this->incomingType;
     }

Here is the caller graph for this function:

◆ getLinebreak()

ilMailOptions::getLinebreak ( )

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

References $linebreak.

Referenced by updateOptions().

                                   : int
     {
         return $this->linebreak;
     }

Here is the caller graph for this function:

◆ getSignature()

ilMailOptions::getSignature ( )

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

References $signature.

Referenced by updateOptions().

                                   : string
     {
         return $this->signature;
     }

Here is the caller graph for this function:

◆ isCronJobNotificationEnabled()

ilMailOptions::isCronJobNotificationEnabled ( )

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

References $isCronJobNotificationEnabled.

Referenced by __construct(), createMailOptionsEntry(), read(), setIsCronJobNotificationStatus(), and updateOptions().

                                                   : bool
     {
         return $this->isCronJobNotificationEnabled;
     }

Here is the caller graph for this function:

◆ lookupNotificationSetting()

static ilMailOptions::lookupNotificationSetting ( int $usrId )

staticprivate

Definition at line 251 of file class.ilMailOptions.php.

References $DIC.

Referenced by updateOptions().

                                                                  : int
     {
         global $DIC;
 
         $row = $DIC->database()->fetchAssoc($DIC->database()->queryF(
             'SELECT cronjob_notification FROM mail_options WHERE user_id = %s',
             ['integer'],
             [$usrId]
         ));
 
         return (int) $row['cronjob_notification'];
     }

Here is the caller graph for this function:

◆ mayManageInvididualSettings()

ilMailOptions::mayManageInvididualSettings ( )

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

References ILIAS\Repository\settings().

Referenced by mayModifyIndividualTransportSettings(), and read().

                                                  : bool
     {
         return $this->settings->get('show_mail_settings') === '1';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayModifyIndividualTransportSettings()

ilMailOptions::mayModifyIndividualTransportSettings ( )

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

References mayManageInvididualSettings(), maySeeIndividualTransportSettings(), and ILIAS\Repository\settings().

Referenced by read().

                                                           : bool
     {
         return (
             $this->mayManageInvididualSettings() &&
             $this->maySeeIndividualTransportSettings() &&
             $this->settings->get('usr_settings_disable_mail_incoming_mail') !== '1'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maySeeIndividualTransportSettings()

ilMailOptions::maySeeIndividualTransportSettings ( )

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

References ILIAS\Repository\settings().

Referenced by mayModifyIndividualTransportSettings().

                                                        : bool
     {
         return $this->settings->get('usr_settings_hide_mail_incoming_mail') !== '1';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilMailOptions::read ( )

protected

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

References $query, $res, ILIAS\Repository\int(), isCronJobNotificationEnabled(), mayManageInvididualSettings(), and mayModifyIndividualTransportSettings().

Referenced by __construct().

                              : void
     {
         $query = implode(' ', [
             'SELECT mail_options.cronjob_notification,',
             'mail_options.signature, mail_options.linebreak, mail_options.incoming_type,',
             'mail_options.mail_address_option, usr_data.email, usr_data.second_email',
             'FROM mail_options',
             'INNER JOIN usr_data ON mail_options.user_id = usr_data.usr_id',
             'WHERE mail_options.user_id = %s',
         ]);
         $res = $this->db->queryF(
             $query,
             ['integer'],
             [$this->usrId]
         );
         $row = $this->db->fetchObject($res);
         if ($row === null) {
             $this->mailTransportSettings->adjust($this->firstEmailAddress, $this->secondEmailAddress, false);
             return;
         }
 
         $this->firstEmailAddress = (string) $row->email;
         $this->secondEmailAddress = (string) $row->second_email;
         if ($this->mayManageInvididualSettings()) {
             $this->signature = (string) $row->signature;
             $this->linebreak = (int) $row->linebreak;
             $this->isCronJobNotificationEnabled = (bool) $row->cronjob_notification;
         }
 
         if ($this->mayModifyIndividualTransportSettings()) {
             $this->incomingType = (int) $row->incoming_type;
             $this->emailAddressMode = (int) $row->mail_address_option;
 
             if (false === filter_var(
                 $this->incomingType,
                 FILTER_VALIDATE_INT,
                 ['options' => ['min_range' => self::INCOMING_LOCAL, 'max_range' => self::INCOMING_BOTH]]
             )) {
                 $this->incomingType = self::INCOMING_LOCAL;
             }
 
             if (false === filter_var(
                 $this->emailAddressMode,
                 FILTER_VALIDATE_INT,
                 ['options' => ['min_range' => self::FIRST_EMAIL, 'max_range' => self::BOTH_EMAIL]]
             )) {
                 $this->emailAddressMode = self::FIRST_EMAIL;
             }
         }
 
         $this->mailTransportSettings->adjust($this->firstEmailAddress, $this->secondEmailAddress);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEmailAddressMode()

ilMailOptions::setEmailAddressMode ( int $emailAddressMode )

Definition at line 246 of file class.ilMailOptions.php.

References $emailAddressMode.

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

◆ setIncomingType()

ilMailOptions::setIncomingType ( int $incomingType )

Definition at line 226 of file class.ilMailOptions.php.

References $incomingType.

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

◆ setIsCronJobNotificationStatus()

ilMailOptions::setIsCronJobNotificationStatus ( bool $isCronJobNotificationEnabled )

Definition at line 231 of file class.ilMailOptions.php.

References $isCronJobNotificationEnabled, and isCronJobNotificationEnabled().

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

Here is the call graph for this function:

◆ setLinebreak()

ilMailOptions::setLinebreak ( int $linebreak )

Definition at line 216 of file class.ilMailOptions.php.

References $linebreak.

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

◆ setSignature()

ilMailOptions::setSignature ( string $signature )

Definition at line 221 of file class.ilMailOptions.php.

References $signature.

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

◆ updateOptions()

ilMailOptions::updateOptions ( )

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

References $data, getEmailAddressMode(), getIncomingType(), getLinebreak(), getSignature(), ILIAS\Repository\int(), isCronJobNotificationEnabled(), lookupNotificationSetting(), and ILIAS\Repository\settings().

                                    : int
     {
         $data = [
             'signature' => ['text', $this->getSignature()],
             'linebreak' => ['integer', $this->getLinebreak()],
             'incoming_type' => ['integer', $this->getIncomingType()],
             'mail_address_option' => ['integer', $this->getEmailAddressMode()],
         ];
 
         if ($this->settings->get('mail_notification', '0')) {
             $data['cronjob_notification'] = ['integer', (int) $this->isCronJobNotificationEnabled()];
         } else {
             $data['cronjob_notification'] = ['integer', $this->lookupNotificationSetting($this->usrId)];
         }
 
         return $this->db->replace(
             $this->table_mail_options,
             [
                 'user_id' => ['integer', $this->usrId],
             ],
             $data
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilMailOptions::$db

protected

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

◆ $default_email_address_mode

int ilMailOptions::$default_email_address_mode = self::FIRST_EMAIL

protected

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

Referenced by __construct().

◆ $default_incoming_type

int ilMailOptions::$default_incoming_type = self::INCOMING_LOCAL

protected

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

Referenced by __construct().

◆ $emailAddressMode

int ilMailOptions::$emailAddressMode = self::FIRST_EMAIL

protected

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

Referenced by getEmailAddressMode(), and setEmailAddressMode().

◆ $firstEmailAddress

string ilMailOptions::$firstEmailAddress = ''

protected

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

Referenced by getExternalEmailAddresses().

◆ $ilias

ILIAS ilMailOptions::$ilias

protected

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

◆ $incomingType

int ilMailOptions::$incomingType = self::INCOMING_LOCAL

protected

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

Referenced by getIncomingType(), and setIncomingType().

◆ $isCronJobNotificationEnabled

bool ilMailOptions::$isCronJobNotificationEnabled = false

protected

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

Referenced by isCronJobNotificationEnabled(), and setIsCronJobNotificationStatus().

◆ $linebreak

int ilMailOptions::$linebreak = 0

protected

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

Referenced by getLinebreak(), and setLinebreak().

◆ $mailTransportSettings

ilMailTransportSettings ilMailOptions::$mailTransportSettings

protected

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

◆ $secondEmailAddress

string ilMailOptions::$secondEmailAddress = ''

protected

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

Referenced by getExternalEmailAddresses().

◆ $settings

ilSetting ilMailOptions::$settings

protected

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

◆ $signature

string ilMailOptions::$signature = ''

protected

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

Referenced by getSignature(), and setSignature().

◆ $table_mail_options

string ilMailOptions::$table_mail_options = 'mail_options'

protected

Definition at line 39 of file class.ilMailOptions.php.

◆ $usrId

int ilMailOptions::$usrId = 0

protected

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

Referenced by __construct().

◆ BOTH_EMAIL

const ilMailOptions::BOTH_EMAIL = 5

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), and ilMailAppEventListener\handle().

◆ DEFAULT_LINE_BREAK

const ilMailOptions::DEFAULT_LINE_BREAK = 60

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

Referenced by ilMailOptionsTest\testConstructor().

◆ FIRST_EMAIL

const ilMailOptions::FIRST_EMAIL = 3

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ilMailAppEventListener\handle(), ilObjMailGUI\populateGeneralSettingsForm(), and ilObjMailGUI\saveObject().

◆ INCOMING_BOTH

const ilMailOptions::INCOMING_BOTH = 2

Definition at line 30 of file class.ilMailOptions.php.

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), and ilMail\sendChanneledMails().

◆ INCOMING_EMAIL

const ilMailOptions::INCOMING_EMAIL = 1

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), ilMail\sendChanneledMails(), and ilMailTest\testExternalMailDeliveryToLocalRecipientsWorksAsExpected().

◆ INCOMING_LOCAL

const ilMailOptions::INCOMING_LOCAL = 0

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ilMailAddressTypeHelperImpl\receivesInternalMailsOnly(), ilAuthProviderECS\resetMailOptions(), and ilMailOptionsTest\testConstructor().

◆ SECOND_EMAIL

const ilMailOptions::SECOND_EMAIL = 4

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), and ilMailAppEventListener\handle().

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

Services/Mail/classes/class.ilMailOptions.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createMailOptionsEntry()

◆ getEmailAddressMode()

◆ getExternalEmailAddresses()

◆ getIncomingType()

◆ getLinebreak()

◆ getSignature()

◆ isCronJobNotificationEnabled()

◆ lookupNotificationSetting()

◆ mayManageInvididualSettings()

◆ mayModifyIndividualTransportSettings()

◆ maySeeIndividualTransportSettings()

◆ read()

◆ setEmailAddressMode()

◆ setIncomingType()

◆ setIsCronJobNotificationStatus()

◆ setLinebreak()

◆ setSignature()

◆ updateOptions()

Field Documentation

◆ $db

◆ $default_email_address_mode

◆ $default_incoming_type

◆ $emailAddressMode

◆ $firstEmailAddress

◆ $ilias

◆ $incomingType

◆ $isCronJobNotificationEnabled

◆ $linebreak

◆ $mailTransportSettings

◆ $secondEmailAddress

◆ $settings

◆ $signature

◆ $table_mail_options

◆ $usrId

◆ BOTH_EMAIL

◆ DEFAULT_LINE_BREAK

◆ FIRST_EMAIL

◆ INCOMING_BOTH

◆ INCOMING_EMAIL

◆ INCOMING_LOCAL

◆ SECOND_EMAIL