EmailHandler Class Reference

Public Member Functions
	EmailHandler ($toAddr, $subject, $message="", $emailFrom="", $emailName="", $attachments=array(), $iCalMgr=null)
	getMessageScript ($msg, $random_hash, $attachments, $iCalMgr)
	formatAttachments ($attachments, $random_hash)
	formatiCalendar ($iCalMgr, $random_hash)
	The iCal event should come in formatted by the event handler formatICal function. More...
	send ()

Public Attributes
	$transport
	$onSendComplete

Detailed Description

Definition at line 171 of file email_manager.inc.

Member Function Documentation

EmailHandler()

EmailHandler::EmailHandler	(		$toAddr,
			$subject,
			$message = "",
			$emailFrom = "",
			$emailName = "",
			$attachments = array(),
			$iCalMgr = null
	)

Parameters

String	$toAddr
String	$subject
String	$message
String	$emailFrom	- if blank, use settings email_from; if not blank and != settings, set this value into Reply To header instead
String	$emailName	- same as above
Array	$attachments	- optional array of full file paths to attach. Key is display name of file (which may be the same as the basename of the file path), value is santized file path. If a string is received, it will be conerted to an array with the key the basename of the path
	iCalendarEventManager	obj $iCalMgr

Definition at line 188 of file email_manager.inc.

     {
          global $config;
 
          $site_email_from =  Settings::getValue('email', 'email_from');
          $site_email_name =  Settings::getValue('email', 'email_name');
          
          $replyTo = $site_email_from;
          $replyToName = $site_email_name;
          
          if($emailFrom)
          {
               $replyTo = $emailFrom;
          }
          
          if($emailName)
          {
               $replyToName = $emailName;
          }
          
          $toAddr = trim($toAddr);
          
          if ($config['html_email_template'])
          {
               $file = $config['homedir'] . $config['html_email_template'];
               trace("Loading email template '$file'", 3);
               $template = file_get_contents($file);
               $template = str_replace("{var:styles}", Fakoli::getStyles(), $template);
               $message = str_replace("{message}", $message, $template);
          }
          
          $this->transport = EmailManager::createTransport();
 
          $this->transport->setTo($toAddr);
          $this->transport->setFrom($site_email_from, $site_email_name);
          $this->transport->setReplyTo($replyTo, $replyToName);
          $this->transport->setReturnPAth($site_email_from);
          $this->transport->setSubject($subject);
          $this->transport->setHTMLMessage($message);
          $this->transport->setPlainMessage(HTMLToText($message));
          
          if($attachments && !is_array($attachments))
          {
               $attachments = array_combine(basename($attachments), $attachments);
          }
          
          foreach($attachments as $filename => $attachment)
          {
               $this->transport->addAttachment($filename, $attachment);
          }
          
          if($iCalMgr)
          {
               $iCalMgr->setOrganizer($replyTo, $replyToName);
               $iCalMgr->setAttendee($toAddr);
               
               $this->transport->setICalAttachment($iCalMgr->format(), $iCalMgr->data->get("method"));
          }
          
     }

formatAttachments()

EmailHandler::formatAttachments	(		$attachments,
			$random_hash
	)

Parameters

HTML	$message
Array	$files	- files to attach

Definition at line 302 of file email_manager.inc.

     {
          if(!count($attachments)) return "";
          
          foreach($attachments as $display_name => $attachment)
          {
               if(is_file($attachment))
               {
                    $base_filename = basename($attachment);
                    
                    $fileAttachments .= "----PHP-alt-{$random_hash}\n";
                    $fp =  @fopen($attachment, "rb");
                    $fileContents = @fread($fp, filesize($attachment));
                    @fclose($fp);
                    $fileContents = chunk_split(base64_encode($fileContents));
                    $fileAttachments .= "Content-Type: application/octet-stream; name=\"". $base_filename ."\"\n" .
                              "Content-Description: ".$base_filename."\n" .
                              "Content-Disposition: attachment;\n" . " filename=\"".$display_name ."\"; size=".filesize($attachment).";\n" .
                              "Content-Transfer-Encoding: base64\n\n" .$fileContents . "\n\n";
               }
          }
          
          return $fileAttachments;
     }    

formatiCalendar()

EmailHandler::formatiCalendar	(		$iCalMgr,
			$random_hash
	)

The iCal event should come in formatted by the event handler formatICal function.

Here we provide the organizer's email if not already set, based on the reply to email and format the header for this block.

Definition at line 334 of file email_manager.inc.

     {    
          $method = $iCalMgr->data->get("method");
          
          $cal_message = "----PHP-alt-{$random_hash}\n";              
          $cal_message .= "Content-Type: text/calendar; charset=utf-8;method={$method}\n";
          $cal_message .= "Content-Disposition: inline; filename=meeting.ics\n";
          $cal_message .= "Content-Transfer-Encoding: 8bit\n";
                    
          $cal_message .= $iCalMgr->format(); 
     
          return $cal_message;
     }

getMessageScript()

EmailHandler::getMessageScript	(		$msg,
			$random_hash,
			$attachments,
			$iCalMgr
	)

Definition at line 253 of file email_manager.inc.

     {
          global $config;
          
 
          $fileAttachments = $this->formatAttachments($attachments, $random_hash);
          
          if($iCalMgr)
          {
               $iCal = $this->formatiCalendar($iCalMgr, $random_hash);
          }
          
          //define the body of the message.
          ob_start(); //Turn on output buffering
          ?>
 
----PHP-alt-<?php echo "$random_hash\n"; ?>
Content-Type: text/plain
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
 
<?php echo trim(HTMLToText($msg)); ?>
 
 
----PHP-alt-<?php echo "$random_hash\n"; ?>
Content-Type: text/html
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
 
<?php echo $html ?>
 
<?php echo $fileAttachments ?>
 
<?php echo $iCal ?>
 
----PHP-alt-<?php echo $random_hash; ?>--
          <?php
          //copy current buffer contents into $message variable
          // and delete current output buffer
          $message = ob_get_clean();
 
          return $message;
     }

send()

EmailHandler::send

(

)

Definition at line 348 of file email_manager.inc.

     {
          $rtn = $this->transport->send();
          
          trace("EmailHandler send rtn $rtn", 3);
          // Call the callback whether successful or not; calling script
          // decides how to handle either way. 
          if ($this->onSendComplete AND is_callable($this->onSendComplete))
          {
               call_user_func($this->onSendComplete, $rtn);
          }              
          return $rtn;
     }

Member Data Documentation

$onSendComplete

EmailHandler::$onSendComplete

Definition at line 174 of file email_manager.inc.

$transport

EmailHandler::$transport

Definition at line 173 of file email_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/email/email_manager.inc