EmailLog Class Reference

Inherits DataItem.

Static Public Member Functions
static	logEmail ($mgr, $toAddr, $rtn)
	Record email sent in a log. More...

Public Attributes
	$table = "email_log"
	$primary_key = "email_log_id"
	$fields

Detailed Description

Definition at line 8 of file email_log.inc.

Member Function Documentation

logEmail()

static EmailLog::logEmail (   $mgr,   $toAddr,   $rtn  )

static

Record email sent in a log.

Parameters

obj	$mgr	EmailManager
string	$toAddr
boolean	$rtn

Definition at line 31 of file email_log.inc.

     {
          // don't save log if email not sent.
          if(!$rtn) return;
          
          if (Settings::getValue("email", "log_messages"))
          {
               $item = $mgr->item;
                         
               $log = new EmailLog();
               $log->recipient_name = "";
               $log->recipient_email = $toAddr;
               $log->sender_email = $mgr->emailFrom;
               $log->sender_name = $mgr->emailName;
               $log->subject = $mgr->subject;
               $log->message = Settings::getValue("email", "log_message_bodies") ? $mgr->message : "";
               $log->save();
          }
     }    

Member Data Documentation

$fields

EmailLog::$fields

Initial value:

= array(
               "email_log_id"      =>   Number,
               "sender_name"       =>   String,
               "sender_email"      =>   String,
               "recipient_name"    =>   String,
               "recipient_email"   =>   String,
               "subject"           =>   String,
               "message"           =>   HTML,
               "date_sent"              =>   Timestamp,
               )

Definition at line 13 of file email_log.inc.

$primary_key

EmailLog::$primary_key = "email_log_id"

Definition at line 11 of file email_log.inc.

$table

EmailLog::$table = "email_log"

Definition at line 10 of file email_log.inc.

---

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

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