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

Collaboration diagram for ilMailOptions:

Public Member Functions
	__construct ($a_user_id)
	Constructor setup an mail object. More...

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

	getOptions ()
	get options of user and set variables $signature and $linebreak this method shouldn't bew called from outside use getSignature() and getLinebreak() private More...

	getLinebreak ()
	get linebreak of user public More...

	getSignature ()
	get signature of user public More...

	getIncomingType ()

	setCronjobNotification ()

	getCronjobNotification ()

Data Fields
	$ilias

	$LOCAL = 0

	$EMAIL = 1

	$BOTH = 2

	$linebreak

	$signature

	$incoming_type

	$cronjob_notification

Detailed Description

Class UserMail this class handles user mails.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilMailOptions::__construct ( $a_user_id )

Constructor setup an mail object.

Parameters

int	user_id public

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

References $ilias, and getOptions().

         {
                 global $ilias;
 
                 define("DEFAULT_LINEBREAK",60);
 
                 $this->ilias = $ilias;
                 $this->table_mail_options = 'mail_options';
 
                 $this->user_id = $a_user_id;
                 $this->getOptions();
         }

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

Returns: bool

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

References $ilDB, $ilSetting, array, and IL_MAIL_LOCAL.

     {
         global $ilDB, $ilSetting;
                 
             $incomingMail = $ilSetting->get('mail_incoming_mail') ? $ilSetting->get('mail_incoming_mail'): IL_MAIL_LOCAL;
             $ilDB->insert('mail_options',
                                 array(
                                                 'user_id'              => array('integer', $this->user_id),
                                                 'linebreak'            => array('integer', DEFAULT_LINEBREAK),
                                                 'signature'            => array('text', NULL),
                                                 'incoming_type'        => array('integer', $incomingMail),
                                                 'cronjob_notification' => array('integer', 0)
                                 ));
             
                 return true;
     }

◆ getCronjobNotification()

ilMailOptions::getCronjobNotification ( )

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

References $cronjob_notification, $ilDB, $query, and $row.

         {
                 return $this->cronjob_notification;
         }

◆ getIncomingType()

ilMailOptions::getIncomingType ( )

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

References $incoming_type.

Referenced by ilMailOptionsGUI\setMailOptionsValuesByDB(), and ilPersonalSettingsGUI\setMailOptionsValuesByDB().

         {
                 return $this->incoming_type;
         }

Here is the caller graph for this function:

◆ getLinebreak()

ilMailOptions::getLinebreak ( )

get linebreak of user public

Returns: array mails

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

References $linebreak.

         {
                 return $this->linebreak;
         }

◆ getOptions()

ilMailOptions::getOptions ( )

get options of user and set variables $signature and $linebreak this method shouldn't bew called from outside use getSignature() and getLinebreak() private

Returns: boolean

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

References $data, $ilDB, $ilSetting, $LOCAL, $res, $row, ilObjUser\_lookupEmail(), array, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM '.$this->table_mail_options.'
                         WHERE user_id = %s',
                         array('integer'), array($this->user_id));
                 
                 $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
                 
                 $this->cronjob_notification = stripslashes($row->cronjob_notification);
                 $this->signature = stripslashes($row->signature);
                 $this->linebreak = stripslashes($row->linebreak);
                 $this->incoming_type = $row->incoming_type;
                 
                 if(!strlen(ilObjUser::_lookupEmail($this->user_id)))
                 {
                         $this->incoming_type = $this->LOCAL;
                 }
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSignature()

ilMailOptions::getSignature ( )

get signature of user public

Returns: array mails

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

References $signature.

         {
                 return $this->signature;
         }

◆ setCronjobNotification()

ilMailOptions::setCronjobNotification ( )

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

References $cronjob_notification.

         {
                 return $this->cronjob_notification;
         }

Field Documentation

◆ $BOTH

ilMailOptions::$BOTH = 2

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

◆ $cronjob_notification

ilMailOptions::$cronjob_notification

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

Referenced by getCronjobNotification(), and setCronjobNotification().

◆ $EMAIL

ilMailOptions::$EMAIL = 1

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

◆ $ilias

ilMailOptions::$ilias

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

Referenced by __construct().

◆ $incoming_type

ilMailOptions::$incoming_type

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

Referenced by getIncomingType().

◆ $linebreak

ilMailOptions::$linebreak

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

Referenced by getLinebreak().

◆ $LOCAL

ilMailOptions::$LOCAL = 0

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

Referenced by getOptions().

◆ $signature

ilMailOptions::$signature

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

Referenced by getSignature().

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

Services/Mail/classes/class.ilMailOptions.php

Public Member Functions

Data Fields