ilMailOptions Class Reference

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
	$signature
	$cronjob_notification
	$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 82 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 103 of file class.ilMailOptions.php.

References $mail_address_option, array, and settings().

    {
        $incomingMail        = strlen($this->settings->get('mail_incoming_mail'))  ? (int) $this->settings->get('mail_incoming_mail') : self::INCOMING_LOCAL;
        $mail_address_option = strlen($this->settings->get('mail_address_option')) ? (int) $this->settings->get('mail_address_option') : self::FIRST_EMAIL;

        $this->db->replace(
            $this->table_mail_options,
            array(
                'user_id'              => array('integer', $this->user_id),
            ),
            array(
                'linebreak'            => array('integer', (int) self::DEFAULT_LINE_BREAK),
                'signature'            => array('text', null),
                'incoming_type'        => array('integer', $incomingMail),
                'mail_address_option'  => array('integer', $mail_address_option),
                'cronjob_notification' => array('integer', 0)
            )
        );
    }

Here is the call graph for this function:

getCronjobNotification()

ilMailOptions::getCronjobNotification

(

)

Returns

int

Definition at line 239 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 320 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 334 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 199 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 183 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 247 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 191 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 278 of file class.ilMailOptions.php.

References array, 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 264 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 123 of file class.ilMailOptions.php.

References $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

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 = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);

        $this->cronjob_notification = $row->cronjob_notification;
        $this->signature            = $row->signature;
        $this->linebreak            = $row->linebreak;
        $this->incoming_type        = $row->incoming_type;
        $this->mail_address_option  = (int) $row->mail_address_option >= 3 ? $row->mail_address_option : self::FIRST_EMAIL;

        $firstMailAddress  = $row->email;

        $secondMailAddress = $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 231 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 223 of file class.ilMailOptions.php.

References $incoming_type.

    {
        $this->incoming_type = $incoming_type;
    }

setLinebreak()

ilMailOptions::setLinebreak

(

$linebreak

)

Parameters

int

$linebreak

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

References $linebreak.

    {
        $this->linebreak = $linebreak;
    }

setMailAddressOption()

ilMailOptions::setMailAddressOption

(

$mail_address_option

)

Parameters

int

$mail_address_option

Definition at line 255 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 215 of file class.ilMailOptions.php.

References $signature.

    {
        $this->signature = $signature;
    }

updateOptions()

ilMailOptions::updateOptions

(

)

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

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

    {
        $data = array(
            'signature'           => array('text', $this->getSignature()),
            'linebreak'           => array('integer', (int) $this->getLinebreak()),
            'incoming_type'       => array('integer', $this->getIncomingType()),
            'mail_address_option' => array('integer', $this->getMailAddressOption())
        );

        if ($this->settings->get('mail_notification')) {
            $data['cronjob_notification']  = array('integer', (int) $this->getCronjobNotification());
        } else {
            $data['cronjob_notification']  = array('integer', (int) self::lookupNotificationSetting($this->user_id));
        }

        return $this->db->replace(
            $this->table_mail_options,
            array(
                'user_id' => array('integer', $this->user_id)
            ),
            $data
        );
    }

Here is the call graph for this function:

Field Documentation

$cronjob_notification

ilMailOptions::$cronjob_notification

protected

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

Referenced by getCronjobNotification(), and setCronjobNotification().

$db

ilMailOptions::$db

protected

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

$ilias

ilMailOptions::$ilias

protected

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

$incoming_type

ilMailOptions::$incoming_type = self::INCOMING_LOCAL

protected

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

Referenced by getIncomingType(), and setIncomingType().

$linebreak

ilMailOptions::$linebreak

protected

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

Referenced by getLinebreak(), and setLinebreak().

$mail_address_option

ilMailOptions::$mail_address_option = self::FIRST_EMAIL

protected

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

Referenced by createMailOptionsEntry(), getMailAddressOption(), and setMailAddressOption().

$mailTransportSettings

ilMailOptions::$mailTransportSettings

private

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

Referenced by __construct().

$settings

ilMailOptions::$settings

protected

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

$signature

ilMailOptions::$signature

protected

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

Referenced by getSignature(), and setSignature().

$table_mail_options

ilMailOptions::$table_mail_options = 'mail_options'

protected

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

$user_id

ilMailOptions::$user_id

protected

Definition at line 35 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(), ilMailLoginOrEmailAddressAddressType\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