this class encapsulates the PHP mail() function. More...

Collaboration diagram for ilMimeMail:

Public Member Functions
	__construct ()
	Mail contructor. More...

	autoCheck ($bool)
	activate or desactivate the email addresses validator ex: autoCheck( true ) turn the validator on by default autoCheck feature is on More...

	Subject ($subject, $a_add_prefix=false)
	Define the subject line of the email. More...

	From ($from)
	set the sender of the mail More...

	ReplyTo ( $address)
	set the Reply-to header More...

	Receipt ()
	add a receipt to the mail ie. More...

	To ( $to)
	set the mail recipient More...

	Cc ($cc)
	Cc() cc : email address(es), accept both array and string. More...

	Bcc ( $bcc)
	Bcc() set the Bcc headers ( blank carbon copy ). More...

	Body ( $body, $charset="")
	Body( text [, charset] ) set the body (message) of the mail define the charset if the message contains extended characters (accents) default to us-ascii $mail->Body( "m�l en fran�ais avec des accents", "iso-8859-1" );. More...

	Organization ( $org)
	Organization( $org ) set the Organization header. More...

	Priority ( $priority)
	Priority( $priority ) set the mail priority $priority : integer taken between 1 (highest) and 5 ( lowest ) ex: $mail->Priority(1) ; => Highest. More...

	Attach ( $filename, $filetype="", $disposition="inline", $display_name=null)
	Attach a file to the mail. More...

	Send ()
	fornat and send the mail public More...

	Get ()
	return the whole e-mail , headers + message can be used for displaying the message in plain text or logging it More...

	ValidEmail ($address)
	check an email address validity public More...

	CheckAdresses ( $aad)
	check validity of email addresses return if unvalid, output an error message and exit, this may -should- be customized More...

	_build_attachement ()
	check and encode attach file(s) . More...

	_mimeEncode ($a_string)

Data Fields
	$sendto = array()

	$acc = array()

	$abcc = array()

	$xheaders = array()

	$priorities = array( '1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)' )

	$charset = "utf-8"

	$ctencoding = "8bit"

	$receipt = 0

Protected Attributes
	$aattach = array()

	$adisplay = array()

Detailed Description

this class encapsulates the PHP mail() function.

implements CC, Bcc, Priority headers include "libmail.php"; $m= new Mail; // create the mail $m->From( "leo@isp.com" ); $m->To( "destination@somewhere.fr" ); $m->Subject( "the subject of the mail" ); $message= "Hello world!\nthis is a test of the Mail class\nplease ignore\nThanks."; $m->Body( $message); // set the body $m->Cc( "someone@somewhere.fr"); $m->Bcc( "someoneelse@somewhere.fr"); $m->Priority(4) ; // set the priority to Low m->Attach( "/home/leo/toto.gif", "image/gif" ) ; // attach a file of type image/gif $m->Send(); // send the mail echo "the mail below has been sent:<br><pre>", $m->Get(), "</pre>";

Author: Leo West - lwest.nosp@m.@fre.nosp@m.e.fr

Version

Id: class.ilMimeMail.php 46278 2013-11-19 13:27:05Z jluetzen

Definition at line 28 of file class.ilMimeMail.php.

Constructor & Destructor Documentation

◆ __construct()

ilMimeMail::__construct ( )

Mail contructor.

Definition at line 80 of file class.ilMimeMail.php.

References autoCheck().

         {
                 $this->autoCheck( false);
                 $this->boundary= "--" . md5( uniqid("myboundary") );
         }

Here is the call graph for this function:

Member Function Documentation

◆ _build_attachement()

ilMimeMail::_build_attachement ( )

check and encode attach file(s) .

internal use only private

Definition at line 554 of file class.ilMimeMail.php.

References $filename, and exit.

         {
                 $this->xheaders["Content-Type"] = "multipart/mixed;\n boundary=\"$this->boundary\"";
 
                 $this->fullBody = "This is a multi-part message in MIME format.\n--$this->boundary\n";
                 $this->fullBody .= "Content-Type: text/plain; charset=$this->charset\nContent-Transfer-Encoding: $this->ctencoding\n\n".
                         $this->body ."\n";
 
                 $sep= chr(13) . chr(10);
 
                 $ata= array();
                 $k=0;
 
                 // for each attached file, do...
                 for( $i=0; $i < count( $this->aattach); $i++ ) {
 
                         $filename = $this->aattach[$i];
                         $basename = basename($filename);
                         $ctype = $this->actype[$i];     // content-type
                         $disposition = $this->adispo[$i];
                         $display_name = $this->adisplay[$i];
                         if(!$display_name)
                         {
                                 $display_name = $basename;
                         }
 
                         if( ! file_exists( $filename) ) {
                                 echo "Class Mail, method attach : file $filename can't be found"; 
                                 exit;
                         }
 
                         $subhdr= "--$this->boundary\nContent-type: $ctype;\n name=\"$basename\"\nContent-Transfer-Encoding:".
                                 "base64\nContent-Disposition: $disposition;\n  filename=\"$display_name\"\n\n";
                         $ata[$k++] = $subhdr;
                         // non encoded line length
                         $linesz= filesize( $filename)+1;
                         $fp= fopen( $filename, 'r' );
                         $ata[$k++] = chunk_split(base64_encode(fread( $fp, $linesz)));
                         fclose($fp);
                 }
 
                 $this->fullBody .= implode($sep, $ata);
         }

◆ _mimeEncode()

ilMimeMail::_mimeEncode ( $a_string )

Definition at line 598 of file class.ilMimeMail.php.

Referenced by ilMail\addFullname().

         {
                 $encoded = '=?utf-8?b?';
                 $encoded .= base64_encode($a_string);
                 $encoded .= '?=';
 
                 return $encoded;
         }

Here is the caller graph for this function:

◆ Attach()

ilMimeMail::Attach	(	$filename,
		$filetype = `""`,
		$disposition = `"inline"`,
		$display_name = `null`
	)

Attach a file to the mail.

Parameters

	string	filename : path of the file to attach
	string	filetype : MIME-type of the file. default to 'application/x-unknown-content-type'
	string	disposition : instruct the Mailclient to display the file if possible ("inline") or always as a link ("attachment") possible values are "inline", "attachment"
string	$display_name,	filename to use in email (if different from source file)

Definition at line 303 of file class.ilMimeMail.php.

References $filename, $ilSetting, $ilUser, $result, ilMail\getIliasMailerAddress(), ilLoggerFactory\getLogger(), and ilUtil\makeClickable().

         {
                 // TODO : si filetype="", alors chercher dans un tablo de MT connus / extension du fichier
                 if( $filetype == "" )
                 {
                         $filetype = "application/octet-stream";
                 }
 
                 $this->aattach[] = $filename;
                 $this->actype[] = $filetype;
                 $this->adispo[] = $disposition;
                 $this->adisplay[] = $display_name;
         }

Here is the call graph for this function:

◆ autoCheck()

ilMimeMail::autoCheck ( $bool )

activate or desactivate the email addresses validator ex: autoCheck( true ) turn the validator on by default autoCheck feature is on

Parameters

boolean set to true to turn on the auto validation public

Definition at line 93 of file class.ilMimeMail.php.

Referenced by __construct().

         {
                 if( $bool )
                 {
                         $this->checkAddress = true;
                 }
                 else
                 {
                         $this->checkAddress = false;
                 }
         }

Here is the caller graph for this function:

◆ Bcc()

ilMimeMail::Bcc ( $bcc )

Bcc() set the Bcc headers ( blank carbon copy ).

bcc : email address(es), accept both array and string

Parameters

string bcc

Definition at line 219 of file class.ilMimeMail.php.

References CheckAdresses().

         {
                 if( is_array($bcc) ) 
                 {
                         $this->abcc = $bcc;
                 } 
                 else 
                 {
                         $this->abcc[]= $bcc;
                 }
 
                 if( $this->checkAddress == true )
                 {
                         $this->CheckAdresses( $this->abcc );
                 }
         }

Here is the call graph for this function:

◆ Body()

ilMimeMail::Body	(	$body,
		$charset = `""`
	)

Body( text [, charset] ) set the body (message) of the mail define the charset if the message contains extended characters (accents) default to us-ascii $mail->Body( "m�l en fran�ais avec des accents", "iso-8859-1" );.

Parameters

string	body
string	charset (optional)

Definition at line 245 of file class.ilMimeMail.php.

         {
                 $this->body = $body;
 
                 if( $charset != "" ) 
                 {
                         $this->charset = strtolower($charset);
                         if( $this->charset == "us-ascii" )
                         {
                                 $this->ctencoding = "7bit";
                         }
                 }
         }

◆ Cc()

ilMimeMail::Cc ( $cc )

Cc() cc : email address(es), accept both array and string.

Parameters

string cc set the CC headers ( carbon copy )

Definition at line 196 of file class.ilMimeMail.php.

References CheckAdresses().

         {
                 if( is_array($cc) )
                 {
                         $this->acc= $cc;
                 }
                 else
                 {
                         $this->acc[]= $cc;
                 }
 
                 if( $this->checkAddress == true )
                 {
                         $this->CheckAdresses( $this->acc );
                 }
         }

Here is the call graph for this function:

◆ CheckAdresses()

ilMimeMail::CheckAdresses ( $aad )

check validity of email addresses return if unvalid, output an error message and exit, this may -should- be customized

Parameters

array aad -

Definition at line 539 of file class.ilMimeMail.php.

References exit, and ValidEmail().

Referenced by Bcc(), Cc(), and To().

         {
                 for($i=0;$i< count( $aad); $i++ ) {
                         if( ! $this->ValidEmail( $aad[$i]) ) 
                         {
                                 echo "Class Mail, method Mail : invalid address $aad[$i]";
                                 exit;
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ From()

ilMimeMail::From ( $from )

set the sender of the mail

Parameters

string from should be an email address

Definition at line 128 of file class.ilMimeMail.php.

References exit.

Referenced by ilPurchaseBaseGUI\__sendBill().

         {
                 if( ! is_string($from) && !is_array($from)) {
                         echo "Class Mail: error, From is not a string or array";
                         exit;
                 }
                 if(is_array($from))
                 {
                         $this->xheaders['From']     = $from[0];
                         $this->xheaders['FromName'] = $from[1];
                         return;
                 }
 
                 $this->xheaders['From'] = $from;
         }

Here is the caller graph for this function:

◆ Get()

ilMimeMail::Get ( )

return the whole e-mail , headers + message can be used for displaying the message in plain text or logging it

Definition at line 503 of file class.ilMimeMail.php.

         {
                 $this->BuildMail();
                 $mail = "To: " . $this->strTo . "\n";
                 $mail .= $this->headers . "\n";
                 $mail .= $this->fullBody;
                 return $mail;
         }

◆ Organization()

ilMimeMail::Organization ( $org )

Organization( $org ) set the Organization header.

Parameters

string organization

Definition at line 264 of file class.ilMimeMail.php.

         {
                 if( trim( $org != "" )  )
                 {
                         $this->xheaders['Organization'] = $org;
                 }
         }

◆ Priority()

ilMimeMail::Priority ( $priority )

Priority( $priority ) set the mail priority $priority : integer taken between 1 (highest) and 5 ( lowest ) ex: $mail->Priority(1) ; => Highest.

Parameters

integer priority

Definition at line 279 of file class.ilMimeMail.php.

         {
                 if( ! intval( $priority ) )
                 {
                         return false;
                 }
 
                 if( ! isset( $this->priorities[$priority-1]) )
                 {
                         return false;
                 }
 
                 $this->xheaders["X-Priority"] = $this->priorities[$priority-1];
 
                 return true;
         }

◆ Receipt()

ilMimeMail::Receipt ( )

add a receipt to the mail ie.

a confirmation is returned to the "From" address (or "ReplyTo" if defined) when the receiver opens the message.

Warning: this functionality is not a standard, thus only some mail clients are compliants.

Definition at line 163 of file class.ilMimeMail.php.

         {
                 $this->receipt = 1;
         }

◆ ReplyTo()

ilMimeMail::ReplyTo ( $address )

set the Reply-to header

Parameters

string address should be an email address

Definition at line 148 of file class.ilMimeMail.php.

         {
                 if( ! is_string($address) )
                 {
                         return false;
                 }
 
                 $this->xheaders["Reply-To"] = $address;
         }

◆ Send()

ilMimeMail::Send ( )

fornat and send the mail public

Definition at line 494 of file class.ilMimeMail.php.

         {
                 $this->BuildMail();
         }

◆ Subject()

ilMimeMail::Subject	(	$subject,
		$a_add_prefix = `false`
	)

Define the subject line of the email.

Parameters

string subject any monoline string

Definition at line 109 of file class.ilMimeMail.php.

References ilMail\getSubjectPrefix().

         {
                 if($a_add_prefix)
                 {
                         // #9096
                         include_once "Services/Mail/classes/class.ilMail.php";
                         $prefix = ilMail::getSubjectPrefix();
                         if(trim($prefix))
                         {
                                 $subject = trim($prefix)." ".$subject;
                         }
                 }
                 $this->xheaders['Subject'] = $subject;
         }

Here is the call graph for this function:

◆ To()

ilMimeMail::To ( $to )

set the mail recipient

Parameters

string to email address, accept both a single address or an array of addresses

Definition at line 172 of file class.ilMimeMail.php.

References CheckAdresses().

         {
                 // TODO : test validit� sur to
                 if( is_array( $to ) )
                 {
                         $this->sendto= $to;
                 }
                 else
                 {
                         $this->sendto[] = $to;
                 }
 
                 if( $this->checkAddress == true )
                 {
                         $this->CheckAdresses( $this->sendto );
                 }
         }

Here is the call graph for this function:

◆ ValidEmail()

ilMimeMail::ValidEmail ( $address )

check an email address validity public

Parameters

string address : email address to check

Returns: boolean true if email adress is ok

Definition at line 519 of file class.ilMimeMail.php.

Referenced by CheckAdresses().

         {
                 if( ereg( ".*<(.+)>", $address, $regs ) ) {
                         $address = $regs[1];
                 }
                 if(ereg( "^[^@  ]+@([a-zA-Z0-9\-]+\.)+([a-zA-Z0-9\-]{2}|net|com|gov|mil|org|edu|int)\$",$address) )
                 {
                         return true;
                 }
                 else
                 {
                         return false;
                 }
         }

Here is the caller graph for this function:

Field Documentation

◆ $aattach

ilMimeMail::$aattach = array()

protected

Definition at line 50 of file class.ilMimeMail.php.

◆ $abcc

ilMimeMail::$abcc = array()

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

◆ $acc

ilMimeMail::$acc = array()

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

◆ $adisplay

ilMimeMail::$adisplay = array()

protected

Definition at line 55 of file class.ilMimeMail.php.

◆ $charset

ilMimeMail::$charset = "utf-8"

Definition at line 73 of file class.ilMimeMail.php.

◆ $ctencoding

ilMimeMail::$ctencoding = "8bit"

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

◆ $priorities

ilMimeMail::$priorities = array( '1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)' )

Definition at line 67 of file class.ilMimeMail.php.

◆ $receipt

ilMimeMail::$receipt = 0

Definition at line 75 of file class.ilMimeMail.php.

◆ $sendto

ilMimeMail::$sendto = array()

Definition at line 34 of file class.ilMimeMail.php.

◆ $xheaders

ilMimeMail::$xheaders = array()

Definition at line 61 of file class.ilMimeMail.php.

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

Services/Mail/classes/class.ilMimeMail.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _build_attachement()

◆ _mimeEncode()

◆ Attach()

◆ autoCheck()

◆ Bcc()

◆ Body()

◆ Cc()

◆ CheckAdresses()

◆ From()

◆ Get()

◆ Organization()

◆ Priority()

◆ Receipt()

◆ ReplyTo()

◆ Send()

◆ Subject()

◆ To()

◆ ValidEmail()

Field Documentation

◆ $aattach

◆ $abcc

◆ $acc

◆ $adisplay

◆ $charset

◆ $ctencoding

◆ $priorities

◆ $receipt

◆ $sendto

◆ $xheaders