Inheritance diagram for Sendmail_Core:

Collaboration diagram for Sendmail_Core:

Public Member Functions
	__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

	get_format ()

	mailto ($p_mailto)
	set the recipient

	send ()
	Send email.

	set_format ($format)
	format is either HTML or PLAIN

	set_from ($p_from)
	set the from

	set_message ($p_message)
	body of the message (utf8)

	set_subject ($p_subject)

	verify ()
	verify that the message is ready to go

Protected Attributes
	$afile

	$content

	$format

	$from

	$header

	$mailto

	$message

	$subject

Detailed Description

Description of Sendmail.

API for sending email.

Author: dany

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

Constructor & Destructor Documentation

◆ __construct()

Sendmail_Core::__construct ( )

Definition at line 49 of file sendmail_core.class.php.

    {
        $this->format='PLAIN';
    }

Member Function Documentation

◆ add_file()

Sendmail_Core::add_file ( FileToSend $file )

Add file to the message.

Parameters

FileToSend $file file to add to the message

Definition at line 111 of file sendmail_core.class.php.

    {
        $this->afile[] = $file;
    }

References $file.

◆ add_supplemental_header()

Sendmail_Core::add_supplemental_header ( )

Function to override if supplemental header are needed.

Returns: string

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

    {
        return '';
    }

Referenced by compose().

◆ compose()

Sendmail_Core::compose ( )

create the message before sending

Definition at line 145 of file sendmail_core.class.php.

    {
        $this->verify();
            $this->header="";
            $this->content="";
 
        // a random hash will be necessary to send mixed content
        $separator = md5(time());
 
        // carriage return type (we use a PHP end of line constant)
        $eol = PHP_EOL;
 
        // main header (multipart mandatory)
        $this->header = "From: " . $this->from . $eol;
        $this->header .= "MIME-Version: 1.0" . $eol;
        $this->header .= $this->add_supplemental_header();
        if ($this->format == 'PLAIN')
        {
            $this->header .= "Content-Type: multipart/mixed; boundary=\"" . $separator . "\""  ;
            // message PLAIN
            $this->content .= "--" . $separator . $eol;
            $this->content .= "Content-Type: text/plain; charset=UTF-8" . $eol;
            $this->content .= "Content-Transfer-Encoding: 8bit" . $eol.$eol ;
            $this->content .= $this->message . $eol ;
        } elseif ($this->format == 'HTML') {
            $separator_second=md5(rand());
            
            $this->header .= "Content-Type: multipart/mixed; boundary=\"" . $separator . "\"" .$eol ;
             // message PLAIN
            $this->content .= "--" . $separator . $eol;
            $this->content .= "Content-Type: multipart/alternative; boundary=\"" . $separator_second . "\"".$eol  ;
            $this->content.= "--$separator_second".$eol;
            $this->content .= "Content-Type: text/plain; charset=UTF-8; format=flowed".$eol;
            $this->content .= "Content-Transfer-Encoding: 8bit" . $eol.$eol ;
            $this->content .= strip_tags($this->message) . $eol ;
            $this->content.=$eol;
            $this->content.=$eol;
            $this->content.=$eol;
            // message HTML
            $this->content .= "--" . $separator_second.$eol;
            $this->content .= "Content-Type: text/html; charset=UTF-8" . $eol;
            $this->content .= "Content-Transfer-Encoding: 8bit" . $eol.$eol ;
            $this->content .=<<<eof
<!DOCTYPE html>{$eol}
<html>{$eol}
<head>{$eol}
 
<meta http-equiv="content-type" content="text/html; charset=UTF-8">{$eol}
</head>{$eol}
<body>
{$eol}
{$eol}
{$eol}
eof;
            $this->content .= $this->message. $eol ;
            $this->content .="  </body> </html>".$eol;
            $this->content .= "--" . $separator_second."--" . $eol;
    
        }else {
            throw new \Exception('SC172 : unknow format ');            
        }
        
        if ( ! empty($this->afile ) )
        {
            // attachment
            for ($i = 0; $i < count($this->afile); $i++)
            {
                
                $file = $this->afile[$i];
                $file_size = filesize($file->full_name);
                $mimetype=( $file->type=="")?mime_content_type($file->full_name):$file->type;
                $handle = fopen($file->full_name, "r");
                if ( $handle == false ){ 
                    \record_log("SC159 ".var_export($file,true));
                    throw new Exception ('SC159 email not send file not added'.$file->full_name);
                }
                $content = fread($handle, $file_size);
                fclose($handle);
                $content = chunk_split(base64_encode($content));
                $this->content .= "--" . $separator . $eol;
                $this->content .= "Content-Type: " . $mimetype . "; name=\"" . $file->filename . "\"" . $eol;
                $this->content .= "Content-Disposition: attachment; filename=\"" . $file->filename . "\"" . $eol;
                $this->content .= "Content-Transfer-Encoding: base64" . $eol;
                $this->content.=$eol;
                $this->content .= $content . $eol ;
            }
        }
        if ( empty ($this->afile) ) $this->content.=$eol;
 
        $this->content .= "--" . $separator . "--";
    }

References $content, $file, $i, add_supplemental_header(), content, elseif, from, html, record_log(), and verify().

Here is the call graph for this function:

◆ get_format()

Sendmail_Core::get_format ( )

Definition at line 54 of file sendmail_core.class.php.

                                 {
        return $this->format;
    }

References $format.

◆ mailto()

Sendmail_Core::mailto ( $p_mailto )

set the recipient

Parameters

type $p_mailto has the form name email.nosp@m.@ema.nosp@m.il.co.nosp@m.m

Definition at line 92 of file sendmail_core.class.php.

    {
        $this->mailto = $p_mailto;
    }

References mailto().

Referenced by mailto(), Sendmail\send(), and send().

Here is the call graph for this function:

◆ send()

Sendmail_Core::send ( )

Send email.

Exceptions

Exception

Reimplemented in Sendmail.

Definition at line 241 of file sendmail_core.class.php.

    {
        try {
            $this->verify();
 
        } catch (Exception $e) {
            throw $e;
        }
 
        if (!mail($this->mailto, $this->subject, $this->content,$this->header))
        {
            throw new Exception('send failed');
        }
    }

References $e, content, mailto(), and verify().

Here is the call graph for this function:

◆ set_format()

Sendmail_Core::set_format ( $format )

format is either HTML or PLAIN

Parameters

type $format HTML or PLAIN

Returns: Sendmail_Core

Definition at line 62 of file sendmail_core.class.php.

                                        {
        if ( in_array($format,['PLAIN','HTML'] ) == false) {
            throw new \Exception('SC64 : unknow format ');
        }
        $this->format = $format;
        return $this;
    }

References $format.

◆ set_from()

Sendmail_Core::set_from ( $p_from )

set the from

Parameters

$p_from has the form name info@.nosp@m.phpc.nosp@m.ompta.nosp@m..eu

Definition at line 74 of file sendmail_core.class.php.

    {
        $this->from = $p_from;
    }

References from.

◆ set_message()

Sendmail_Core::set_message ( $p_message )

body of the message (utf8)

Parameters

type $p_message

Definition at line 101 of file sendmail_core.class.php.

    {
        // $this->message =wordwrap($p_message,70,"\r\n");
        $this->message =$p_message;
    }

◆ set_subject()

Sendmail_Core::set_subject ( $p_subject )

Parameters

$p_subject set the subject

Definition at line 83 of file sendmail_core.class.php.

    {
        $this->subject = $p_subject;
    }

◆ verify()

Sendmail_Core::verify ( )

verify that the message is ready to go

Exceptions

Exception

Reimplemented in Sendmail.

Definition at line 120 of file sendmail_core.class.php.

    {
        $array = explode(",", "from,subject,mailto,message");
        for ($i = 0; $i < count($array); $i++)
        {
            $name = $array[$i];
            if (trim($this->$name??"") == "")
            {
                throw new Exception( sprintf(_("%s est vide"),$name),EXC_INVALID);
            }
        }
    }

References $array, $i, $name, _, and EXC_INVALID.

Referenced by compose(), and send().

Field Documentation

◆ $afile

Sendmail_Core::$afile

protected

Definition at line 42 of file sendmail_core.class.php.

◆ $content

Sendmail_Core::$content

protected

Definition at line 46 of file sendmail_core.class.php.

Referenced by compose().

◆ $format

Sendmail_Core::$format

protected

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

Referenced by get_format(), and set_format().

◆ $from

Sendmail_Core::$from

protected

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

◆ $header

Sendmail_Core::$header

protected

Definition at line 47 of file sendmail_core.class.php.

◆ $mailto

Sendmail_Core::$mailto

protected

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

◆ $message

Sendmail_Core::$message

protected

Definition at line 44 of file sendmail_core.class.php.

◆ $subject

Sendmail_Core::$subject

protected

Definition at line 43 of file sendmail_core.class.php.

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

include/lib/sendmail_core.class.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_file()

◆ add_supplemental_header()

◆ compose()

◆ get_format()

◆ mailto()

◆ send()

◆ set_format()

◆ set_from()

◆ set_message()

◆ set_subject()

◆ verify()

Field Documentation

◆ $afile

◆ $content

◆ $format

◆ $from

◆ $header

◆ $mailto

◆ $message

◆ $subject