Collaboration diagram for ilMailOptions:

Public Member Functions
	__construct (protected int $usr_id, ?ilMailTransportSettings $mail_transport_settings=null, ?ClockInterface $clock_service=null, ?ilSetting $settings=null, ?ilDBInterface $db=null, ?Settings $user_settings=null)

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

	mayModifyIndividualTransportSetting ()

	mayModifyNewMailNotificationSetting ()

	mayManageInvididualSettings ()

	updateOptions ()

	getSignature ()

	getIncomingType ()

	setSignature (string $signature)

	setIncomingType (int $incoming_type)

	setIsCronJobNotificationStatus (bool $is_cron_notification_enabled)

	isCronJobNotificationEnabled ()

	getEmailAddressMode ()

	getStoredEmailAddressMode ()

	setEmailAddressmode (int $email_address_mode)

	getUsrId ()

	getExternalEmailAddresses ()

	setAbsenceAutoresponderBody (string $absence_auto_responder_body)

	getAbsenceAutoresponderBody ()

	setAbsenceStatus (bool $absence_status)

	getAbsenceStatus ()

	setAbsentFrom (int $absent_from)

	getAbsentFrom ()

	setAbsentUntil (int $absent_until)

	getAbsentUntil ()

	setAbsenceAutoresponderSubject (string $absence_auto_responder_subject)

	getAbsenceAutoresponderSubject ()

	isAbsent ()

Data Fields
final const int	INCOMING_LOCAL = 0

final const int	INCOMING_EMAIL = 1

final const int	INCOMING_BOTH = 2

final const int	FIRST_EMAIL = 3

final const int	SECOND_EMAIL = 4

final const int	BOTH_EMAIL = 5

final const bool	ABSENCE_STATUS_PRESENT = false

final const bool	ABSENCE_STATUS_ABSENT = true

Protected Member Functions
	read ()

Protected Attributes
ILIAS	$ilias

ilDBInterface	$db

ilSetting	$settings

Settings	$user_settings

string	$table_mail_options = 'mail_options'

string	$signature = ''

bool	$is_cron_notification_enabled = false

int	$incoming_type = self::INCOMING_LOCAL

int	$default_incoming_type = self::INCOMING_LOCAL

int	$email_address_mode = self::FIRST_EMAIL

int	$default_email_address_mode = self::FIRST_EMAIL

int	$stored_email_address_mode = null

ilMailTransportSettings	$mail_transport_settings

string	$first_mail_address = ''

string	$second_mail_address = ''

bool	$absence_status = self::ABSENCE_STATUS_PRESENT

int	$absent_from = 0

int	$absent_until = 0

string	$absence_auto_responder_body = ''

string	$absence_auto_responder_subject = ''

ClockInterface	$clock_service

Static Private Member Functions
static	lookupNotificationSetting (int $usr_id)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMailOptions::__construct	(	protected int	$usr_id,
		?ilMailTransportSettings	$mail_transport_settings = `null`,
		?ClockInterface	$clock_service = `null`,
		?ilSetting	$settings = `null`,
		?ilDBInterface	$db = `null`,
		?Settings	$user_settings = `null`
	)

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

      {
        global $DIC;
        $this->db = $db ?? $DIC->database();
        $this->settings = $settings ?? $DIC->settings();
        $this->mail_transport_settings = $mail_transport_settings ?? new ilMailTransportSettings($this);
        $this->clock_service = $clock_service ?? (new DataFactory())->clock()->utc();
        $this->user_settings = $user_settings ?? $DIC['user']->getSettings();
 
        $this->incoming_type = 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->incoming_type = $this->default_incoming_type;
        }
 
        $this->email_address_mode = 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->email_address_mode = $this->default_email_address_mode;
        }
 
        $this->is_cron_notification_enabled = false;
        $this->signature = '';
 
        $this->read();
    }

References $clock_service, $db, $default_email_address_mode, $default_incoming_type, $DIC, $mail_transport_settings, $user_settings, FIRST_EMAIL, INCOMING_LOCAL, ILIAS\Repository\int(), read(), and ILIAS\Repository\settings().

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 99 of file class.ilMailOptions.php.

                                            : void
    {
        $this->stored_email_address_mode = $this->default_email_address_mode;
 
        $this->db->replace(
            $this->table_mail_options,
            [
                'user_id' => ['integer', $this->usr_id],
            ],
            [
                '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->is_cron_notification_enabled]
            ]
        );
    }

References $default_email_address_mode.

◆ getAbsenceAutoresponderBody()

ilMailOptions::getAbsenceAutoresponderBody ( )

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

                                                 : string
    {
        return $this->absence_auto_responder_body;
    }

References $absence_auto_responder_body.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ getAbsenceAutoresponderSubject()

ilMailOptions::getAbsenceAutoresponderSubject ( )

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

                                                    : string
    {
        return $this->absence_auto_responder_subject;
    }

References $absence_auto_responder_subject.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ getAbsenceStatus()

ilMailOptions::getAbsenceStatus ( )

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

                                      : bool
    {
        return $this->absence_status;
    }

References $absence_status.

Referenced by isAbsent(), and updateOptions().

Here is the caller graph for this function:

◆ getAbsentFrom()

ilMailOptions::getAbsentFrom ( )

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

                                   : int
    {
        return $this->absent_from;
    }

References $absent_from.

Referenced by isAbsent(), and updateOptions().

Here is the caller graph for this function:

◆ getAbsentUntil()

ilMailOptions::getAbsentUntil ( )

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

                                    : int
    {
        return $this->absent_until;
    }

References $absent_until.

Referenced by isAbsent(), and updateOptions().

Here is the caller graph for this function:

◆ getEmailAddressMode()

ilMailOptions::getEmailAddressMode ( )

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

                                         : int
    {
        return $this->email_address_mode;
    }

References $email_address_mode.

Referenced by getExternalEmailAddresses(), and updateOptions().

Here is the caller graph for this function:

◆ getExternalEmailAddresses()

ilMailOptions::getExternalEmailAddresses ( )

Returns: string[]

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

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

References $first_mail_address, $second_mail_address, BOTH_EMAIL, FIRST_EMAIL, getEmailAddressMode(), and SECOND_EMAIL.

Here is the call graph for this function:

◆ getIncomingType()

ilMailOptions::getIncomingType ( )

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

                                     : int
    {
        return $this->incoming_type;
    }

References $incoming_type.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ getSignature()

ilMailOptions::getSignature ( )

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

                                  : string
    {
        return $this->signature;
    }

References $signature.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ getStoredEmailAddressMode()

ilMailOptions::getStoredEmailAddressMode ( )

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

                                               : ?int
    {
        return $this->stored_email_address_mode;
    }

References $stored_email_address_mode.

◆ getUsrId()

ilMailOptions::getUsrId ( )

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

                              : int
    {
        return $this->usr_id;
    }

◆ isAbsent()

ilMailOptions::isAbsent ( )

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

                              : bool
    {
        return
            $this->getAbsenceStatus() &&
            $this->getAbsentFrom() &&
            $this->getAbsentUntil() &&
            $this->getAbsentFrom() <= $this->clock_service->now()->getTimestamp() &&
            $this->getAbsentUntil() >= $this->clock_service->now()->getTimestamp();
    }

References getAbsenceStatus(), getAbsentFrom(), and getAbsentUntil().

Here is the call graph for this function:

◆ isCronJobNotificationEnabled()

ilMailOptions::isCronJobNotificationEnabled ( )

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

                                                  : bool
    {
        return $this->is_cron_notification_enabled;
    }

References $is_cron_notification_enabled.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ lookupNotificationSetting()

static ilMailOptions::lookupNotificationSetting ( int $usr_id )

staticprivate

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

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

References $DIC.

Referenced by updateOptions().

Here is the caller graph for this function:

◆ mayManageInvididualSettings()

ilMailOptions::mayManageInvididualSettings ( )

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

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

References ILIAS\Repository\settings().

Referenced by mayModifyIndividualTransportSetting(), mayModifyNewMailNotificationSetting(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayModifyIndividualTransportSetting()

ilMailOptions::mayModifyIndividualTransportSetting ( )

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

                                                         : bool
    {
        return $this->mayManageInvididualSettings()
            && $this->user_settings->settingAvailableToUser(IncomingMail::class);
    }

References mayManageInvididualSettings().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayModifyNewMailNotificationSetting()

ilMailOptions::mayModifyNewMailNotificationSetting ( )

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

                                                         : bool
    {
        return $this->mayManageInvididualSettings()
            && $this->user_settings->settingAvailableToUser(NewMailNotification::class);
    }

References mayManageInvididualSettings().

Here is the call graph for this function:

◆ read()

ilMailOptions::read ( )

protected

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

                             : void
    {
        $query = 'SELECT mail_options.cronjob_notification,
                                        mail_options.signature,
 
                                        mail_options.incoming_type,
                                        mail_options.mail_address_option,
                                        mail_options.absence_status,
                                        mail_options.absent_from,
                                        mail_options.absent_until,
                                        mail_options.absence_ar_subject,
                                        mail_options.absence_ar_body,
                                        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->usr_id]
        );
        $row = $this->db->fetchObject($res);
        if ($row === null) {
            $this->mail_transport_settings->adjust($this->first_mail_address, $this->second_mail_address, false);
            return;
        }
 
        $this->first_mail_address = (string) $row->email;
        $this->second_mail_address = (string) $row->second_email;
        $this->stored_email_address_mode = (int) $row->mail_address_option;
 
        if ($this->mayManageInvididualSettings()) {
            $this->is_cron_notification_enabled = (bool) $row->cronjob_notification;
            $this->signature = (string) $row->signature;
            $this->setAbsenceStatus((bool) $row->absence_status);
            $this->setAbsentFrom((int) $row->absent_from);
            $this->setAbsentUntil((int) $row->absent_until);
            $this->setAbsenceAutoresponderSubject($row->absence_ar_subject ?? '');
            $this->setAbsenceAutoresponderBody($row->absence_ar_body ?? '');
        }
 
        if ($this->mayModifyIndividualTransportSetting()) {
            $this->incoming_type = (int) $row->incoming_type;
            $this->email_address_mode = (int) $row->mail_address_option;
 
            if (filter_var(
                $this->incoming_type,
                FILTER_VALIDATE_INT,
                ['options' => ['min_range' => self::INCOMING_LOCAL, 'max_range' => self::INCOMING_BOTH]]
            ) === false) {
                $this->incoming_type = self::INCOMING_LOCAL;
            }
 
            if (filter_var(
                $this->email_address_mode,
                FILTER_VALIDATE_INT,
                ['options' => ['min_range' => self::FIRST_EMAIL, 'max_range' => self::BOTH_EMAIL]]
            ) === false) {
                $this->email_address_mode = self::FIRST_EMAIL;
            }
        }
 
        $this->mail_transport_settings->adjust($this->first_mail_address, $this->second_mail_address);
    }

References $res, FIRST_EMAIL, if, INCOMING_LOCAL, ILIAS\Repository\int(), mayManageInvididualSettings(), mayModifyIndividualTransportSetting(), setAbsenceAutoresponderBody(), setAbsenceAutoresponderSubject(), setAbsenceStatus(), setAbsentFrom(), and setAbsentUntil().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAbsenceAutoresponderBody()

ilMailOptions::setAbsenceAutoresponderBody ( string $absence_auto_responder_body )

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

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

References $absence_auto_responder_body.

Referenced by read().

Here is the caller graph for this function:

◆ setAbsenceAutoresponderSubject()

ilMailOptions::setAbsenceAutoresponderSubject ( string $absence_auto_responder_subject )

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

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

References $absence_auto_responder_subject.

Referenced by read().

Here is the caller graph for this function:

◆ setAbsenceStatus()

ilMailOptions::setAbsenceStatus ( bool $absence_status )

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

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

References $absence_status.

Referenced by read().

Here is the caller graph for this function:

◆ setAbsentFrom()

ilMailOptions::setAbsentFrom ( int $absent_from )

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

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

References $absent_from.

Referenced by read().

Here is the caller graph for this function:

◆ setAbsentUntil()

ilMailOptions::setAbsentUntil ( int $absent_until )

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

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

References $absent_until.

Referenced by read().

Here is the caller graph for this function:

◆ setEmailAddressmode()

ilMailOptions::setEmailAddressmode ( int $email_address_mode )

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

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

References $email_address_mode.

◆ setIncomingType()

ilMailOptions::setIncomingType ( int $incoming_type )

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

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

References $incoming_type.

◆ setIsCronJobNotificationStatus()

ilMailOptions::setIsCronJobNotificationStatus ( bool $is_cron_notification_enabled )

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

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

References $is_cron_notification_enabled.

◆ setSignature()

ilMailOptions::setSignature ( string $signature )

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

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

References $signature.

◆ updateOptions()

ilMailOptions::updateOptions ( )

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

                                   : int
    {
        $data = [
            'signature' => ['text', $this->getSignature()],
            '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', self::lookupNotificationSetting($this->usr_id)];
        }
 
        $data['absence_status'] = ['integer', (int) $this->getAbsenceStatus()];
        $data['absent_from'] = ['integer', $this->getAbsentFrom()];
        $data['absent_until'] = ['integer', $this->getAbsentUntil()];
        $data['absence_ar_subject'] = ['text', $this->getAbsenceAutoresponderSubject()];
        $data['absence_ar_body'] = ['clob', $this->getAbsenceAutoresponderBody()];
 
        $this->stored_email_address_mode = $this->getEmailAddressMode();
 
        return $this->db->replace(
            $this->table_mail_options,
            [
                'user_id' => ['integer', $this->usr_id],
            ],
            $data
        );
    }

References $data, getAbsenceAutoresponderBody(), getAbsenceAutoresponderSubject(), getAbsenceStatus(), getAbsentFrom(), getAbsentUntil(), getEmailAddressMode(), getIncomingType(), getSignature(), ILIAS\Repository\int(), isCronJobNotificationEnabled(), lookupNotificationSetting(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Field Documentation

◆ $absence_auto_responder_body

string ilMailOptions::$absence_auto_responder_body = ''

protected

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

Referenced by getAbsenceAutoresponderBody(), and setAbsenceAutoresponderBody().

◆ $absence_auto_responder_subject

string ilMailOptions::$absence_auto_responder_subject = ''

protected

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

Referenced by getAbsenceAutoresponderSubject(), and setAbsenceAutoresponderSubject().

◆ $absence_status

bool ilMailOptions::$absence_status = self::ABSENCE_STATUS_PRESENT

protected

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

Referenced by getAbsenceStatus(), and setAbsenceStatus().

◆ $absent_from

int ilMailOptions::$absent_from = 0

protected

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

Referenced by getAbsentFrom(), and setAbsentFrom().

◆ $absent_until

int ilMailOptions::$absent_until = 0

protected

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

Referenced by getAbsentUntil(), and setAbsentUntil().

◆ $clock_service

ClockInterface ilMailOptions::$clock_service

protected

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

Referenced by __construct().

◆ $db

ilDBInterface ilMailOptions::$db

protected

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

Referenced by __construct().

◆ $default_email_address_mode

int ilMailOptions::$default_email_address_mode = self::FIRST_EMAIL

protected

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

Referenced by __construct(), and createMailOptionsEntry().

◆ $default_incoming_type

int ilMailOptions::$default_incoming_type = self::INCOMING_LOCAL

protected

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

Referenced by __construct().

◆ $email_address_mode

int ilMailOptions::$email_address_mode = self::FIRST_EMAIL

protected

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

Referenced by getEmailAddressMode(), and setEmailAddressmode().

◆ $first_mail_address

string ilMailOptions::$first_mail_address = ''

protected

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

Referenced by getExternalEmailAddresses().

◆ $ilias

ILIAS ilMailOptions::$ilias

protected

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

◆ $incoming_type

int ilMailOptions::$incoming_type = self::INCOMING_LOCAL

protected

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

Referenced by getIncomingType(), and setIncomingType().

◆ $is_cron_notification_enabled

bool ilMailOptions::$is_cron_notification_enabled = false

protected

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

Referenced by isCronJobNotificationEnabled(), and setIsCronJobNotificationStatus().

◆ $mail_transport_settings

ilMailTransportSettings ilMailOptions::$mail_transport_settings

protected

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

Referenced by __construct().

◆ $second_mail_address

string ilMailOptions::$second_mail_address = ''

protected

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

Referenced by getExternalEmailAddresses().

◆ $settings

ilSetting ilMailOptions::$settings

protected

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

◆ $signature

string ilMailOptions::$signature = ''

protected

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

Referenced by getSignature(), and setSignature().

◆ $stored_email_address_mode

int ilMailOptions::$stored_email_address_mode = null

protected

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

Referenced by getStoredEmailAddressMode().

◆ $table_mail_options

string ilMailOptions::$table_mail_options = 'mail_options'

protected

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

◆ $user_settings

Settings ilMailOptions::$user_settings

protected

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

Referenced by __construct().

◆ ABSENCE_STATUS_ABSENT

final const bool ilMailOptions::ABSENCE_STATUS_ABSENT = true

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

◆ ABSENCE_STATUS_PRESENT

final const bool ilMailOptions::ABSENCE_STATUS_PRESENT = false

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

◆ BOTH_EMAIL

final const int ilMailOptions::BOTH_EMAIL = 5

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

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

◆ FIRST_EMAIL

final const int ilMailOptions::FIRST_EMAIL = 3

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

Referenced by __construct(), ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ILIAS\Mail\UserSettings\IncomingMail\buildTransformation(), getExternalEmailAddresses(), ilMailAppEventListener\handle(), ILIAS\Mail\UserSettings\IncomingMail\persistUserInput(), ilObjMailGUI\populateGeneralSettingsForm(), read(), and ilObjMailGUI\saveObject().

◆ INCOMING_BOTH

final const int ilMailOptions::INCOMING_BOTH = 2

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ILIAS\Mail\UserSettings\IncomingMail\getDefaultValueForDisplay(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), and ILIAS\Mail\Recipient\userWantsToReceiveExternalMails().

◆ INCOMING_EMAIL

final const int ilMailOptions::INCOMING_EMAIL = 1

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ILIAS\Mail\UserSettings\IncomingMail\getDefaultValueForDisplay(), ILIAS\Mail\Recipient\onlyToExternalMailAddress(), ilMailOptionsFormGUI\save(), ilObjMailGUI\saveObject(), ilMailTest\testExternalMailDeliveryWorksAsExpected(), and ILIAS\Mail\Recipient\userWantsToReceiveExternalMails().

◆ INCOMING_LOCAL

final const int ilMailOptions::INCOMING_LOCAL = 0

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

Referenced by __construct(), ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ILIAS\Mail\UserSettings\IncomingMail\getDefaultValueForDisplay(), ILIAS\Mail\UserSettings\IncomingMail\persistUserInput(), read(), ilMailAddressTypeHelperImpl\receivesInternalMailsOnly(), ilAuthProviderECS\resetMailOptions(), and ilMailOptionsTest\testConstructor().

◆ SECOND_EMAIL

final const int ilMailOptions::SECOND_EMAIL = 4

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

Referenced by ilIncomingMailInputGUI\addSubOptions(), ilMailTransportSettings\adjust(), ILIAS\Mail\UserSettings\IncomingMail\buildTransformation(), getExternalEmailAddresses(), and ilMailAppEventListener\handle().

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

components/ILIAS/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()

◆ getAbsenceAutoresponderBody()

◆ getAbsenceAutoresponderSubject()

◆ getAbsenceStatus()

◆ getAbsentFrom()

◆ getAbsentUntil()

◆ getEmailAddressMode()

◆ getExternalEmailAddresses()

◆ getIncomingType()

◆ getSignature()

◆ getStoredEmailAddressMode()

◆ getUsrId()

◆ isAbsent()

◆ isCronJobNotificationEnabled()

◆ lookupNotificationSetting()

◆ mayManageInvididualSettings()

◆ mayModifyIndividualTransportSetting()

◆ mayModifyNewMailNotificationSetting()

◆ read()

◆ setAbsenceAutoresponderBody()

◆ setAbsenceAutoresponderSubject()

◆ setAbsenceStatus()

◆ setAbsentFrom()

◆ setAbsentUntil()

◆ setEmailAddressmode()

◆ setIncomingType()

◆ setIsCronJobNotificationStatus()

◆ setSignature()

◆ updateOptions()

Field Documentation

◆ $absence_auto_responder_body

◆ $absence_auto_responder_subject

◆ $absence_status

◆ $absent_from

◆ $absent_until

◆ $clock_service

◆ $db

◆ $default_email_address_mode

◆ $default_incoming_type

◆ $email_address_mode

◆ $first_mail_address

◆ $ilias

◆ $incoming_type

◆ $is_cron_notification_enabled

◆ $mail_transport_settings

◆ $second_mail_address

◆ $settings

◆ $signature

◆ $stored_email_address_mode

◆ $table_mail_options

◆ $user_settings

◆ ABSENCE_STATUS_ABSENT

◆ ABSENCE_STATUS_PRESENT

◆ BOTH_EMAIL

◆ FIRST_EMAIL

◆ INCOMING_BOTH

◆ INCOMING_EMAIL

◆ INCOMING_LOCAL

◆ SECOND_EMAIL