configuration email and test PHPMAILER. More...

Collaboration diagram for Noalyss\Mail_Parameter:

Public Member Functions
	__construct (protected \Database $cn, protected $name)

	__get ($key)
	get the value in the array $a_value thkx the key

	__set ($key, $value)
	set the value in the array $a_value thkx the key

	from_get ()
	retrieve information from GET

	from_post ()
	retrieve information from POST

	get ($key)

	input ()
	display a form to input the parameter

	load ()
	load from the database

	save ()
	save into the database

	set ($key, $value)

Static Public Member Functions
static	Factory (\Database $cnx, $reply_to="", $blind_copy="")

Data Fields
const	PARAMETER

Protected Attributes
	$a_value
	$a_value array of PARAMETER=>Value

Detailed Description

configuration email and test PHPMAILER.

Property :

$cn Database conx
$name name of the SMTP conx
$a_value array
- smtp_user' username

'smtp_password' password

'smtp_host' host
'smtp_port' port
'smtp_replyto' email address to reply
'smtp_from' email address sender
'smtp_auth' smtp authorisation (always 1)
'smtp_type' smtp
'smtp_secure' kind of encryption PHPMailer::ENCRYPTION_STARTTLS, or PHPMailer::ENCRYPTION_SMTPS.
'smtp_auth_type'SMTP authentication type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2.

Definition at line 69 of file mail_parameter.class.php.

Constructor & Destructor Documentation

◆ __construct()

Noalyss\Mail_Parameter::__construct	(	protected \Database	$cn,
		protected	$name )

Definition at line 89 of file mail_parameter.class.php.

    {
        
        $this->load();
    }

References $cn, $name, and load().

Here is the call graph for this function:

Member Function Documentation

◆ __get()

Noalyss\Mail_Parameter::__get ( $key )

get the value in the array $a_value thkx the key

Parameters

$key	(string) key must be in Mail_Parameter::PARAMETER
$value	(string) value

Returns: a string or null if not found

Exceptions

Exception if the key doesn't exist

Definition at line 122 of file mail_parameter.class.php.

    {
        if (in_array($key, Mail_Parameter::PARAMETER) == false)
        {
            throw new \Exception("MP79 : unknown $key");
        }
        if (isset($this->a_value[$key]))
        {
            return $this->a_value[$key];
        }
        return null;
    }

References PARAMETER.

◆ __set()

Noalyss\Mail_Parameter::__set	(		$key,
			$value )

set the value in the array $a_value thkx the key

Parameters

$key	(string) key must be in Mail_Parameter::PARAMETER
$value	(string) value

Returns: Mail_Parameter

Exceptions

Exception if the key doesn't exist

Definition at line 105 of file mail_parameter.class.php.

    {
        if (in_array($key, Mail_Parameter::PARAMETER) == false)
        {
            throw new \Exception("MP72 : unknown $key");
        }
        $this->a_value[$key] = $value;
        return $this;
    }

References $value, and PARAMETER.

◆ Factory()

static Noalyss\Mail_Parameter::Factory	(	\Database	$cnx,
			$reply_to = "",
			$blind_copy = "" )

static

Definition at line 238 of file mail_parameter.class.php.

    {
        $mail_parameter=new Mail_Parameter($cnx,MAIL_SETTING_NOALYSS);
        if ( $mail_parameter->smtp_type=="sendmail") {
            return new \Sendmail($mail_parameter->smtp_replyto,$mail_parameter->smtp_replyto);
        } elseif ($mail_parameter->smtp_type=="smtp") {
            $phpmail= new SMTPMail($mail_parameter);
            return $phpmail;
        }
        
        throw new \Exception("MP212 MAIL NOT CONFIGURED",212);
        
    }

References elseif, and MAIL_SETTING_NOALYSS.

◆ from_get()

Noalyss\Mail_Parameter::from_get ( )

retrieve information from GET

Definition at line 205 of file mail_parameter.class.php.

    {
        $http = new \HttpInput();
        $this->smtp_user = $http->get('smtp_user');
        $this->smtp_password = $http->get('smtp_password');
        $this->smtp_host = $http->get('smtp_host');
        $this->smtp_port = $http->get('smtp_port');
        $this->smtp_replyto = $http->get('smtp_replyto');
        $this->smtp_from = $http->get('smtp_from');
        $this->smtp_type= $http->get('smtp_type');
        $this->smtp_secure = $http->get('smtp_secure');
        $this->smtp_auth_type = $http->get('smtp_auth_type');
        $this->smtp_auth=1;
        
    }

References $http.

◆ from_post()

Noalyss\Mail_Parameter::from_post ( )

retrieve information from POST

Definition at line 223 of file mail_parameter.class.php.

    {
        $http = new \HttpInput();
        $this->smtp_user = $http->post('smtp_user');
        $this->smtp_password = $http->post('smtp_password');
        $this->smtp_host = $http->post('smtp_host');
        $this->smtp_port = $http->post('smtp_port');
        $this->smtp_replyto = $http->post('smtp_replyto');
        $this->smtp_from = $http->post('smtp_from');
        $this->smtp_type= $http->post('smtp_type');
        $this->smtp_secure = $http->post('smtp_secure');
        $this->smtp_auth_type = $http->post('smtp_auth_type');
        $this->smtp_auth=1;
        
    }

References $http.

◆ get()

Noalyss\Mail_Parameter::get ( $key )

Definition at line 182 of file mail_parameter.class.php.

    {
        return $this->$key;
    }

◆ input()

Noalyss\Mail_Parameter::input ( )

display a form to input the parameter

Definition at line 197 of file mail_parameter.class.php.

    {
        
        include NOALYSS_TEMPLATE . "/mail_parameter-input.php";
    }

◆ load()

Noalyss\Mail_Parameter::load ( )

load from the database

Definition at line 165 of file mail_parameter.class.php.

    {
        $a_value = array_column(
                $this->cn->get_array("select pe_parameter , pe_value from 
                        public.parm_mail_server 
                        where 
                        pe_name=$1"
                        , [$this->name])
                , "pe_value","pe_parameter"
        );
        
        foreach (self::PARAMETER as $key)
        {
            $this->a_value[$key] = $a_value[$key] ?? "";
        }
    }

References $a_value, and cn.

Referenced by __construct().

◆ save()

Noalyss\Mail_Parameter::save ( )

save into the database

Definition at line 138 of file mail_parameter.class.php.

    {
        foreach (self::PARAMETER as $key)
        {
            $id = $this->cn->get_value("select pe_id from parm_mail_server 
                where pe_parameter=$1
                and pe_name=$2",
                    [$key, $this->name]);
            if ($id == "")
            {
                $record = new \Parm_Mail_Server_SQL($this->cn);
                $record->set("pe_name", $this->name);
                $record->set("pe_parameter", $key);
                $record->set("pe_value", $this->a_value[$key]);
                $record->insert();
            } else
            {
                $record = new \Parm_Mail_Server_SQL($this->cn, $id);
                $record->set("pe_value", $this->a_value[$key]);
                $record->update();
            }
        }
    }

References $id, cn, and name.

◆ set()

Noalyss\Mail_Parameter::set	(		$key,
			$value )

Definition at line 187 of file mail_parameter.class.php.

                              : Mail_Parameter
    {
        $this->$key = $value;
        return $this;
    }

References $value.

Field Documentation

◆ $a_value

Noalyss\Mail_Parameter::$a_value

protected

$a_value array of PARAMETER=>Value

Definition at line 85 of file mail_parameter.class.php.

Referenced by load().

◆ PARAMETER

const Noalyss\Mail_Parameter::PARAMETER

Initial value:

= [
        'smtp_user'
        , 'smtp_password'
        , 'smtp_host'
        , 'smtp_port'
        , 'smtp_replyto'
        , 'smtp_from'
        , 'smtp_auth'
        , 'smtp_type'
        , 'smtp_secure'
        , 'smtp_auth_type'
    ]

Definition at line 72 of file mail_parameter.class.php.

Referenced by __get(), and __set().

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

include/lib/mail_parameter.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes