Sendmail Class Reference

Send email for Noalyss after checking if it is possible : if cannot be sent if the limit of max email is reached,. More...

Inheritance diagram for Sendmail:

Collaboration diagram for Sendmail:

Public Member Functions
	can_send ()
	Check if email can be sent from a folder.
	get_email_sent (Database $p_repo, $p_dossier_id, $p_date)
	Return the amount of send emails for the date (YYYYMMDD)
	get_max_email (Database $p_repo, $p_dossier_id)
	return max email the folder can send
	increment_mail (Database $p_repo, $p_dossier, $p_date)
	Add $p_amount_email to email sent.
	send ()
	Send the message.
	verify ()
	check if there is a mandatory domain, if yes
Public Member Functions inherited from Sendmail_Core
	__construct ()
	add_file (FileToSend $file)
	Add file to the message.
	add_supplemental_header ()
	Function to override if supplemental header are needed.
	compose ()
	create the message before sending
	mailto ($p_mailto)
	set the recipient
	set_from ($p_from)
	set the from
	set_message ($p_message)
	body of the message (utf8)
	set_subject ($p_subject)

Additional Inherited Members
Protected Attributes inherited from Sendmail_Core
	$afile
	$content
	$from
	$header
	$mailto
	$message
	$subject

Detailed Description

Send email for Noalyss after checking if it is possible : if cannot be sent if the limit of max email is reached,.

See also

sendmail_core

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

Member Function Documentation

can_send()

Sendmail::can_send

(

)

Check if email can be sent from a folder.

Returns

boolean

if send from a dossier , then check limit of this dossier otherwise send true

Compare max value in repo

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

                        {
        /**
         * if send from a dossier , then  check limit of this dossier
         * otherwise send true
         */
        $http=new HttpInput();
        $dossier=$http->request("gDossier","string", -1);
        if ($dossier == -1 ) return true;
 
        /**
         * Compare max value in repo
         */
        $repo =new Database();
        $date=date('Ymd');
        // get max email
        $max_email = $this->get_max_email($repo,$dossier);
        //
        // This folder cannot send email
        if ($max_email == 0 ) return false;
        //
        // This folder has unlimited email
        if ($max_email == -1 ) return true;
 
        // get email sent today from account_repository
        $email_sent = $this->get_email_sent($repo,$dossier , $date);
        //
        if (   $email_sent >= $max_email) return false;
 
        return true;
    }

References $date, $dossier, $http, $repo, get_email_sent(), and get_max_email().

Referenced by send().

Here is the call graph for this function:

get_email_sent()

Sendmail::get_email_sent	(	Database	$p_repo,
			$p_dossier_id,
			$p_date )

Return the amount of send emails for the date (YYYYMMDD)

Parameters

Database	$p_repo
	$p_dossier_id	int
	$p_date	string YYYYMMDD

Definition at line 108 of file sendmail.class.php.

    {
 
        $email_sent = $p_repo->get_value ('select de_sent_email from dossier_sent_email where dos_id = $1 and de_date=$2',
            array($p_dossier_id,$p_date));
        if ($email_sent == "") return 0;
        return $email_sent;
 
 
    }

References $p_date, and DatabaseCore\get_value().

Referenced by can_send(), and increment_mail().

Here is the call graph for this function:

get_max_email()

Sendmail::get_max_email	(	Database	$p_repo,
			$p_dossier_id )

return max email the folder can send

Parameters

$p_repo	Database
$p_dossier_id	int

Definition at line 95 of file sendmail.class.php.

    {
        $max_email = $p_repo->get_value("select dos_email from ac_dossier where dos_id=$1",
            array($p_dossier_id));
        if ($max_email == "") return 0;
        return $max_email;
    }

References DatabaseCore\get_value().

Referenced by can_send().

Here is the call graph for this function:

increment_mail()

Sendmail::increment_mail	(	Database	$p_repo,
			$p_dossier,
			$p_date )

Add $p_amount_email to email sent.

Parameters

$p_repo	Database
$p_dossier	int id of the folder (dossier.dos_id)
$p_date	string (YYYYMMDD)

Definition at line 161 of file sendmail.class.php.

    {
        if ( $p_dossier == -1) return ;
        $email_sent = $this->get_email_sent($p_repo,$p_dossier,$p_date);
        if (  $email_sent == 0 ){
            $p_repo->exec_sql("insert into public.dossier_sent_email(de_sent_email,dos_id,de_date) values($1,$2,$3)",
                array(1,$p_dossier,$p_date));
            return;
        } else {
            // update + sp_emaoun_email
            $p_repo->exec_sql("update dossier_sent_email set de_sent_email=de_sent_email+1 where dos_id=$1 and de_date=$2",
                array($p_dossier,$p_date));
        }
    }

References $p_date, DatabaseCore\exec_sql(), get_email_sent(), and return.

Referenced by send().

Here is the call graph for this function:

send()

Sendmail::send

(

)

Send the message.

Exceptions

Exception

Reimplemented from Sendmail_Core.

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

    {
        if ( $this->can_send() == false )            throw new Exception(_('Email non envoyé'),EMAIL_LIMIT);
 
        if (!mail($this->mailto, $this->subject, $this->content,$this->header))
        {
            throw new Exception('send failed');
        }
        // Increment email amount
        $repo =new Database();
        $date=date('Ymd');
        $http=new HttpInput();
        $dossier=$http->request("gDossier","string", -1);
        $this->increment_mail($repo,$dossier,$date);
    }

References $date, $dossier, $http, $repo, _, can_send(), content, EMAIL_LIMIT, increment_mail(), and Sendmail_Core\mailto().

Here is the call graph for this function:

verify()

Sendmail::verify

(

)

check if there is a mandatory domain, if yes

Returns

void

Exceptions

Exception

Reimplemented from Sendmail_Core.

Definition at line 124 of file sendmail.class.php.

    {
        try {
            parent::verify();
        } catch (\Exception $e) {
            throw $e;
        }
        if ( defined('ALLOWED_EMAIL_DOMAIN') )
        {
            if ( ALLOWED_EMAIL_DOMAIN != "")
            {
                $as_domain=explode(",", ALLOWED_EMAIL_DOMAIN);
                $valid=0;
                foreach ($as_domain as $domain) {
                    $domain="@$domain";
                    if (strpos($this->from,$domain) != 0 ) {
                        $valid=1;
                        break;
                    }
                }
                if ( $valid == 0) {
                    throw new Exception("Domaine email {$this->from} interdit",EXC_INVALID);
 
                }
 
            }
 
        }
 
    }

References $e, $valid, EXC_INVALID, and from.

---

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

• include/class/sendmail.class.php