Changeset 24

Timestamp:

Dec 1, 2005 9:09:45 PM (18 years ago)

Author:

scdev

Message:

 

File:

• trunk/lib/Email.inc.php (modified) (18 diffs)

trunk/lib/Email.inc.php

@@ -8 +8 @@
  * @author  Quinn Comendant <quinn@strangecode.com>
  * @version 1.0
- 
 -------------------------------------------------------------------------------------
 // Example.
@@ -14 +13 @@
     'to' => array($frm['email'], 'q@lovemachine.local'),
     'from' => sprintf('%s <%s>', App::getParam('site_name'), App::getParam('site_email')),
-    'subject' => 'Your Golbon account has been activated',
+    'subject' => 'Your account has been activated',
 ));
 $email->setTemplate('email_registration_confirm.ihtml');
@@ -22 +21 @@
     'username' => $frm['username'],
     'password' => $frm['password1'],
-    'inviting_member_business_name' => $frm['inviting_member_business_name'],
 ));
 if ($email->send()) {
@@ -28 +26 @@
 } else {
     App::logMsg(sprintf('Error sending confirmation email to address %s', $frm['email']), LOG_DEBUG, __FILE__, __LINE__);
-    App::raiseMsg(sprintf('We tried sending you a confirmation email to address %s but there was an error. After logging in, please visit the "My Account" page to confirm that this address is correct.', $frm['email']), MSG_NOTICE, __FILE__, __LINE__);
 }
 -------------------------------------------------------------------------------------
@@ -34 +31 @@
 class Email {
 
+    // Default parameters, to be overwritten by setParam() and read with getParam()
     var $_params = array(
         'to' => null,
@@ -40 +38 @@
         'regex' => null
     );
+    
+    // String that contains the email body.
     var $_template;
+    
+    // String that contains the email body after replacements.
     var $_template_replaced;
-    var $regex;
 
     /**
@@ -54 +55 @@
     function Email($params=null)
     {
+        // The regex used in validEmail(). Set here instead of in the default _params above so we can use the concatination . dot.
+        // This matches an email address as complex as: 
+        //      Bob Smith <bob&smith's/dep=sales!@smith-wick.ca.us> (Sales department)
+        // ...and something as simple as:
+        //      x@x.com
         $this->setParam(array('regex' => '/^(?:[^,@]*\s+|[^,@]*(<)|)'   // Display name
         . '((?:[^.<>\s@\",\[\]]+[^<>\s@\",\[\]])*[^.<>\s@\",\[\]]+)'    // Local-part 
@@ -79 +85 @@
     {
         if (isset($params) && is_array($params)) {
-
             // Enforce valid email addresses.
             if (isset($params['to']) && !$this->validEmail($params['to'])) {
@@ -129 +134 @@
             return false;
         }
+        // This could be a new template, so reset the _template_replaced.
         $this->_template_replaced = null;
         return true;
@@ -150 +156 @@
         } else {
             $_template = $string;
+            // This could be a new template, so reset the _template_replaced.
             $this->_template_replaced = null;
             return true;
@@ -165 +172 @@
     function replace($replacements)
     {
+        // Ensure template exists.
         if (!isset($this->_template)) {
             App::logMsg(sprintf('Cannot replace variables, no template defined.', null), LOG_ERR, __FILE__, __LINE__);
             return false;
         }
-
+        
+        // Ensure replacements argument is an array.
         if (!is_array($replacements)) {
             App::logMsg(sprintf('Cannot replace variables, invalid replacements.', null), LOG_ERR, __FILE__, __LINE__);
@@ -181 +190 @@
         // Replace values.
         $replace = array_values($replacements);
-
+        
+        // Search and replace all values at once.
         $this->_template_replaced = preg_replace($search, $replace, $this->_template);
     }
@@ -197 +207 @@
     function send($to=null, $from=null, $subject=null)
     {
+        // Use arguments if provided.
         if (isset($to)) {
              $this->setParam(array('to' => $to));
@@ -206 +217 @@
              $this->setParam(array('subject' => $subject));
         }
-
+    
+    
+        // Ensure required values exist.
         if (!isset($this->_template)) {
             App::logMsg(sprintf('Cannot send email. Template not set.', null), LOG_ERR, __FILE__, __LINE__);
@@ -221 +234 @@
         }
 
+        // Wrap email text body, using _template_replaced if replacements have been used, or just a fresh _template if not.
         $final_body = wordwrap(isset($this->_template_replaced) ? $this->_template_replaced : $this->_template);
-        // Test that all placeholders have been replaced.
+
+        // Ensure all placeholders have been replaced. Find anything with {...} characters.
         if (preg_match('/({[^}]+})/', $final_body, $unreplaced_match)) {
             App::logMsg(sprintf('Cannot send email. Variables left unreplaced in template: %s', (isset($unreplaced_match) ? $unreplaced_match[1] : '')), LOG_ERR, __FILE__, __LINE__);
@@ -228 +243 @@
         }
         
+        // Final "to" header can have multiple addresses if in an array.
         $final_to = is_array($this->_params['to']) ? join(', ', $this->_params['to']) : $this->_params['to'];
-        $final_from = sprintf("From: %s\r\n", $this->_params['from']);
+        
+        // From headers are custom headers.
+        $headers = sprintf("From: %s\r\n", $this->_params['from']);
+        
+        // This is the address where delivery problems are sent to. We must strip off everything except the local@domain part.
         $envelope_sender_header = sprintf('-f %s', preg_replace('/^.*<?([^\s@\[\]<>()]+\@[A-Za-z0-9.-]{1,}\.[A-Za-z]{2,5})>?$/iU', '$1', $this->_params['from']));
-        if (!mail($final_to, $this->_params['subject'], $final_body, $final_from, $envelope_sender_header)) {
-            App::logMsg(sprintf('Email failure with parameters: %s, %s, %s, %s', $this->_params['to'], $this->_params['subject'], str_replace("\r\n", '', $final_from), $envelope_sender_header), LOG_NOTICE, __FILE__, __LINE__);
+
+        // Ensure message was successfully accepted for delivery.
+        if (!mail($final_to, $this->_params['subject'], $final_body, $headers, $envelope_sender_header)) {
+            App::logMsg(sprintf('Email failure with parameters: %s, %s, %s, %s', $this->_params['to'], $this->_params['subject'], str_replace("\r\n", '', $headers), $envelope_sender_header), LOG_NOTICE, __FILE__, __LINE__);
             return false;
         }
@@ -256 +278 @@
     function validEmail($email)
     {
+        // If an array, check values recursively.
         if (is_array($email)) {
             foreach ($email as $e) {
@@ -264 +287 @@
             return true;
         } else {
-            if (!preg_match($this->getParam('regex'), $email)) {
+            // To be valid email address must match regex and fit within the lenth constraints.
+            if (preg_match($this->getParam('regex'), $email, $e_parts) && strlen($e_parts[2]) < 64 && strlen($e_parts[3]) < 255) {
+                return true;
+            } else {
                 App::logMsg(sprintf('Invalid email: %s', $email), LOG_DEBUG, __FILE__, __LINE__);
                 return false;
             }
-            return true;
         }
     }