ilMailOptions Class Reference

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() @access private More...
	getLinebreak ()
	get linebreak of user @access public More...
	getSignature ()
	get signature of user @access 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 @access public

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

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

References $ilias, and 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.

    {
        global $ilDB, $ilSetting;
                
            $incomingMail = $ilSetting->get('mail_incoming_mail', IL_MAIL_BOTH);
            $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;
    }

References $ilDB, $ilSetting, and IL_MAIL_BOTH.

getCronjobNotification()

ilMailOptions::getCronjobNotification

(

)

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

        {
                return $this->cronjob_notification;
        }

References $cronjob_notification.

getIncomingType()

ilMailOptions::getIncomingType

(

)

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

        {
                return $this->incoming_type;
        }

References $incoming_type.

getLinebreak()

ilMailOptions::getLinebreak

(

)

get linebreak of user @access public

Returns

array mails

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

        {
                return $this->linebreak;
        }

References $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() @access private

Returns

boolean

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

        {
                global $ilDB;
 
                $res = $ilDB->queryf('
                        SELECT * FROM '.$this->table_mail_options.'
                        WHERE user_id = %s',
                        array('integer'), array($this->user_id));
                
                $row = $res->fetchRow(DB_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;
        }

References $ilDB, $LOCAL, $res, $row, ilObjUser\_lookupEmail(), and DB_FETCHMODE_OBJECT.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getSignature()

ilMailOptions::getSignature

(

)

get signature of user @access public

Returns

array mails

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

        {
                return $this->signature;
        }

References $signature.

setCronjobNotification()

ilMailOptions::setCronjobNotification

(

)

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

        {
                return $this->cronjob_notification;
        }

References $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