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

Collaboration diagram for ilMailOptions:

Public Member Functions
	__construct ($a_user_id, ilMailTransportSettings $mailTransportSettings=null)

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

	updateOptions ()

	getLinebreak ()

	getSignature ()

	getIncomingType ()

	setLinebreak ($linebreak)

	setSignature ($signature)

	setIncomingType ($incoming_type)

	setCronjobNotification ($cronjob_notification)

	getCronjobNotification ()

	getMailAddressOption ()

	setMailAddressOption ($mail_address_option)

Static Public Member Functions
static	getExternalEmailsByUser (ilObjUser $user, ilMailOptions $mail_options=null)

static	getExternalEmailsByUserId ($user_id, ilMailOptions $mail_options=null)

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

Static Protected Member Functions
static	lookupNotificationSetting ($usr_id)

static	lookupExternalEmails (ilObjUser $user, ilMailOptions $mail_options)

Protected Attributes
	$ilias

	$db

	$user_id

	$settings

	$table_mail_options = 'mail_options'

	$linebreak = self::DEFAULT_LINE_BREAK

	$signature

	$cronjob_notification = 0

	$incoming_type = self::INCOMING_LOCAL

	$mail_address_option = self::FIRST_EMAIL

Private Attributes
	$mailTransportSettings

Detailed Description

Class ilMailOptions this class handles user mails.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilMailOptions::__construct	(		$a_user_id,
		ilMailTransportSettings	$mailTransportSettings = `null`
	)

Parameters

int	$a_user_id
ilMailTransportSettings \| null	$mailTransportSettings

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

References $DIC, $mailTransportSettings, read(), and settings().

     {
         global $DIC;
 
         $this->user_id = $a_user_id;
 
         $this->db = $DIC->database();
         $this->settings = $DIC->settings();
 
         if ($mailTransportSettings === null) {
             $mailTransportSettings = new ilMailTransportSettings($this);
         }
         $this->mailTransportSettings = $mailTransportSettings;
 
         $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 70 of file class.ilMailOptions.php.

References settings().

     {
         $this->incoming_type = self::INCOMING_LOCAL;
         if (strlen($this->settings->get('mail_incoming_mail', '')) > 0) {
             $this->incoming_type =  (int) $this->settings->get('mail_incoming_mail');
         }
 
         $this->mail_address_option = self::FIRST_EMAIL;
         if (strlen($this->settings->get('mail_address_option', '')) > 0) {
             $this->mail_address_option = (int) $this->settings->get('mail_address_option');
         }
 
         $this->linebreak = self::DEFAULT_LINE_BREAK;
         $this->cronjob_notification = 0;
         $this->signature = null;
 
         $this->db->replace(
             $this->table_mail_options,
             [
                 'user_id' => ['integer', $this->user_id],
             ],
             [
                 'linebreak' => ['integer', $this->linebreak],
                 'signature' => ['text', $this->signature],
                 'incoming_type' => ['integer', $this->incoming_type],
                 'mail_address_option' => ['integer', $this->mail_address_option],
                 'cronjob_notification' => ['integer', $this->cronjob_notification]
             ]
         );
     }

Here is the call graph for this function:

◆ getCronjobNotification()

ilMailOptions::getCronjobNotification ( )

Returns: int

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

References $cronjob_notification.

Referenced by updateOptions().

     {
         return $this->cronjob_notification;
     }

Here is the caller graph for this function:

◆ getExternalEmailsByUser()

static ilMailOptions::getExternalEmailsByUser	(	ilObjUser	$user,
		ilMailOptions	$mail_options = `null`
	)

static

Parameters

ilObjUser	$user
ilMailOptions	$mail_options

Returns: string[]

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

References ilObject\getId().

Referenced by ilMail\distributeMail(), and ilObjUserGUI\showUpperIcon().

     {
         if (!($mail_options instanceof ilMailOptions)) {
             $mail_options = new self($user->getId());
         }
 
         return self::lookupExternalEmails($user, $mail_options);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExternalEmailsByUserId()

static ilMailOptions::getExternalEmailsByUserId	(		$user_id,
		ilMailOptions	$mail_options = `null`
	)

static

Parameters

int	$user_id
ilMailOptions \| NULL	$mail_options

Returns: string[]

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

References $user_id.

Referenced by ilMailSummaryNotification\__construct().

     {
         return self::getExternalEmailsByUser(new ilObjUser($user_id), $mail_options);
     }

Here is the caller graph for this function:

◆ getIncomingType()

ilMailOptions::getIncomingType ( )

Returns: int

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

References $incoming_type.

Referenced by updateOptions().

     {
         return $this->incoming_type;
     }

Here is the caller graph for this function:

◆ getLinebreak()

ilMailOptions::getLinebreak ( )

Returns: string

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

References $linebreak.

Referenced by updateOptions().

     {
         return $this->linebreak;
     }

Here is the caller graph for this function:

◆ getMailAddressOption()

ilMailOptions::getMailAddressOption ( )

Returns: int

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

References $mail_address_option.

Referenced by lookupExternalEmails(), and updateOptions().

     {
         return $this->mail_address_option;
     }

Here is the caller graph for this function:

◆ getSignature()

ilMailOptions::getSignature ( )

Returns: string

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

References $signature.

Referenced by updateOptions().

     {
         return $this->signature;
     }

Here is the caller graph for this function:

◆ lookupExternalEmails()

static ilMailOptions::lookupExternalEmails	(	ilObjUser	$user,
		ilMailOptions	$mail_options
	)

staticprotected

Parameters

ilObjUser	$user
ilMailOptions	$mail_options

Returns: string[]

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

References ilObjUser\getEmail(), getMailAddressOption(), and ilObjUser\getSecondEmail().

     {
         $emailAddresses = array();
 
         switch ($mail_options->getMailAddressOption()) {
             case self::SECOND_EMAIL:
                 if (strlen($user->getSecondEmail())) {
                     $emailAddresses[] = $user->getSecondEmail();
                 } elseif (strlen($user->getEmail())) {
                     // fallback, use first email address
                     $emailAddresses[] = $user->getEmail();
                 }
                 break;
             
             case self::BOTH_EMAIL:
                 if (strlen($user->getEmail())) {
                     $emailAddresses[] = $user->getEmail();
                 }
                 if (strlen($user->getSecondEmail())) {
                     $emailAddresses[] = $user->getSecondEmail();
                 }
                 break;
             
             case self::FIRST_EMAIL:
             default:
                 if (strlen($user->getEmail())) {
                     $emailAddresses[] = $user->getEmail();
                 } elseif (strlen($user->getSecondEmail())) {
                     // fallback, use first email address
                     $emailAddresses[] = $user->getSecondEmail();
                 }
                 break;
         }
         
         return $emailAddresses;
     }

Here is the call graph for this function:

◆ lookupNotificationSetting()

static ilMailOptions::lookupNotificationSetting ( $usr_id )

staticprotected

Parameters

int $usr_id

Returns: int

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

References $DIC, $query, and $row.

     {
         global $DIC;
 
         $query = "SELECT cronjob_notification FROM mail_options WHERE user_id = " . $DIC->database()->quote($usr_id, 'integer');
         $row = $DIC->database()->fetchAssoc($DIC->database()->query($query));
         return (int) $row['cronjob_notification'];
     }

◆ read()

ilMailOptions::read ( )

protected

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

References $res, and $row.

Referenced by __construct().

     {
         $res = $this->db->queryF(
             '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 
                          LEFT JOIN usr_data ON mail_options.user_id = usr_data.usr_id
                          WHERE mail_options.user_id = %s',
             array('integer'),
             array($this->user_id)
         );
         $row = $this->db->fetchObject($res);
 
         if ($row !== null) {
             $this->cronjob_notification = (int) $row->cronjob_notification;
             $this->signature = $row->signature;
             $this->linebreak = (int) $row->linebreak;
             $this->incoming_type = (int) $row->incoming_type;
             $this->mail_address_option = (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->mail_address_option,
                     FILTER_VALIDATE_INT,
                     ['options' => ['min_range' => self::FIRST_EMAIL, 'max_range' => self::BOTH_EMAIL]]
                 ) === false
             ) {
                 $this->mail_address_option = self::FIRST_EMAIL;
             }
 
             $firstMailAddress = (string) $row->email;
             $secondMailAddress = (string) $row->second_email;
 
             $this->mailTransportSettings->adjust($firstMailAddress, $secondMailAddress);
         }
     }

Here is the caller graph for this function:

◆ setCronjobNotification()

ilMailOptions::setCronjobNotification ( $cronjob_notification )

Returns: int

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

References $cronjob_notification.

     {
         $this->cronjob_notification = $cronjob_notification;
     }

◆ setIncomingType()

ilMailOptions::setIncomingType ( $incoming_type )

Parameters

int $incoming_type

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

References $incoming_type.

     {
         $this->incoming_type = $incoming_type;
     }

◆ setLinebreak()

ilMailOptions::setLinebreak ( $linebreak )

Parameters

int $linebreak

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

References $linebreak.

     {
         $this->linebreak = $linebreak;
     }

◆ setMailAddressOption()

ilMailOptions::setMailAddressOption ( $mail_address_option )

Parameters

int $mail_address_option

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

References $mail_address_option.

     {
         $this->mail_address_option = $mail_address_option;
     }

◆ setSignature()

ilMailOptions::setSignature ( $signature )

Parameters

string $signature

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

References $signature.

     {
         $this->signature = $signature;
     }

◆ updateOptions()

ilMailOptions::updateOptions ( )

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

References $data, getCronjobNotification(), getIncomingType(), getLinebreak(), getMailAddressOption(), getSignature(), and settings().

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

Here is the call graph for this function:

Field Documentation

◆ $cronjob_notification

ilMailOptions::$cronjob_notification = 0

protected

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

Referenced by getCronjobNotification(), and setCronjobNotification().

◆ $db

ilMailOptions::$db

protected

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

◆ $ilias

ilMailOptions::$ilias

protected

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

◆ $incoming_type

ilMailOptions::$incoming_type = self::INCOMING_LOCAL

protected

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

Referenced by getIncomingType(), and setIncomingType().

◆ $linebreak

ilMailOptions::$linebreak = self::DEFAULT_LINE_BREAK

protected

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

Referenced by getLinebreak(), and setLinebreak().

◆ $mail_address_option

ilMailOptions::$mail_address_option = self::FIRST_EMAIL

protected

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

Referenced by getMailAddressOption(), and setMailAddressOption().

◆ $mailTransportSettings

ilMailOptions::$mailTransportSettings

private

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

Referenced by __construct().

◆ $settings

ilMailOptions::$settings

protected

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

◆ $signature

ilMailOptions::$signature

protected

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

Referenced by getSignature(), and setSignature().

◆ $table_mail_options

ilMailOptions::$table_mail_options = 'mail_options'

protected

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

◆ $user_id

ilMailOptions::$user_id

protected

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

Referenced by getExternalEmailsByUserId().

◆ BOTH_EMAIL

const ilMailOptions::BOTH_EMAIL = 5

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

Referenced by ilIncomingMailInputGUI\addSubOptions().

◆ DEFAULT_LINE_BREAK

const ilMailOptions::DEFAULT_LINE_BREAK = 60

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

◆ FIRST_EMAIL

const ilMailOptions::FIRST_EMAIL = 3

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

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

◆ INCOMING_BOTH

const ilMailOptions::INCOMING_BOTH = 2

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

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

◆ INCOMING_EMAIL

const ilMailOptions::INCOMING_EMAIL = 1

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

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

◆ INCOMING_LOCAL

const ilMailOptions::INCOMING_LOCAL = 0

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

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

◆ SECOND_EMAIL

const ilMailOptions::SECOND_EMAIL = 4

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

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

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

Services/Mail/classes/class.ilMailOptions.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createMailOptionsEntry()

◆ getCronjobNotification()

◆ getExternalEmailsByUser()

◆ getExternalEmailsByUserId()

◆ getIncomingType()

◆ getLinebreak()

◆ getMailAddressOption()

◆ getSignature()

◆ lookupExternalEmails()

◆ lookupNotificationSetting()

◆ read()

◆ setCronjobNotification()

◆ setIncomingType()

◆ setLinebreak()

◆ setMailAddressOption()

◆ setSignature()

◆ updateOptions()

Field Documentation

◆ $cronjob_notification

◆ $db

◆ $ilias

◆ $incoming_type

◆ $linebreak

◆ $mail_address_option

◆ $mailTransportSettings

◆ $settings

◆ $signature

◆ $table_mail_options

◆ $user_id

◆ BOTH_EMAIL

◆ DEFAULT_LINE_BREAK

◆ FIRST_EMAIL

◆ INCOMING_BOTH

◆ INCOMING_EMAIL

◆ INCOMING_LOCAL

◆ SECOND_EMAIL