ErrorMail Class Reference

Public Member Functions
	SendMail ()
	SendErr ()

Public Attributes
	$logmode
	$logfile
	$header
	$mailcmd
	$mailto
	$mailfrom
	$mailfromname
	$replyto
	$script
	$subject
	$msgbody
	$line
	$file
	$callingfunction
	$physfile
	$error
	$server_id
	$sql
	$errdate
	$cu
	$member

Private Member Functions
	getPyFileLocation ()
	getAwsSesLoggingContextJsonString ()

Detailed Description

Definition at line 9 of file errormail.i.

Member Function Documentation

getAwsSesLoggingContextJsonString()

ErrorMail::getAwsSesLoggingContextJsonString ( )

private

Prepare a a dictionary of {context: "json ob"} –context option for Python Email Sending Script

Definition at line 84 of file errormail.i.

                                                         {

        $context = array();

        // these attributes are expected to be set on the calling
        // side before invoking SendMail and SendErr
        $context["cucode"] = $this->cu;
        $context["callingScript"] = $this->file;
        $context["callingFunction"] = $this->callingfunction;
        $context["serverName"] = $this->server;
        $context["ServerScript"] = $this->script;

        return HCU_JsonEncode($context);
    }

getPyFileLocation()

ErrorMail::getPyFileLocation ( )

private

Obtain a python file that will send the email.

Definition at line 70 of file errormail.i.

                                         {
        # Goal is to default it with a script with more generalized functionality
        # added in sendSESEmailBulk.py script
        if ($this->bulk) {
            return dirname(__FILE__) . "/../scripts/sendSESEmailBulk.py";
        } else {
            return dirname(__FILE__) . "/../scripts/sendSESEmail.py";
        }
    }

SendErr()

ErrorMail::SendErr

(

)

function SendErr() This sends an email pointing out an error. At this point in time, all references in Odyssey have not been updated. No, this is not the email in Mammoth which comes from the error handler.

Definition at line 184 of file errormail.i.

                     {
    $pyFile = $this->pyFile;

    $msg = "";
    $msg .= "Error in $this->script on Server $this->server\\n";
    $msg .= "Called as $this->query\\n\\n";
    $msg .= $this->line == ""   ? "" :  "LINE: $this->line\\n";
    $msg .= $this->file == ""   ? "" :  "FILE: $this->file\\n";
    $msg .= $this->error == ""  ? "" :  "ERROR: $this->error\\n";
    $msg .= $this->sql == ""    ? "" :  "SQL: $this->sql\\n";
    $msg .= $this->cu == ""     ? "" :  "CU: $this->cu\\n";
    $msg .= $this->member == "" ? "" :  "MEMBER: $this->member\\n";

    // Set up message
    // Requires some finagling: if newline is literal \n then bash line doesn't work but with \\n, it shows up in the email as "\n."
    $plainTextString = "--plaintext \"`echo " . escapeshellarg($msg) . "`\"";

    // Set up subject
    $subject = "Error in $this->script";
    $subjectString = "--subject " . escapeshellarg($subject);

    // Set up from
    $fromString = "--efrom " . escapeshellarg($this->mailfrom);

    // Set up to.  Amazon has a limit of 50 recipients so parse at this point.
    $toArray = is_array($this->mailto) ? $this->mailto : explode(";", str_replace(",", ";", strval($this->mailto)));
    $toSwitch = $this->hideto ? "--bcc" : "--to";
    $toList = array();

    $awsSesLoggingContext = "--context " . escapeshellarg($this->getAwsSesLoggingContextJsonString());

    foreach($toArray as $toEmail) {
      if (trim($toEmail) != "") {
        $toList[] = escapeshellarg($toEmail);

        if (count($toList) >= 50) {
          $toString = "$toSwitch " . implode(" ", $toList);
          $cmd = "(python3 $pyFile $toString $fromString $subjectString $plainTextString $awsSesLoggingContext) &";
          exec($cmd);
          $toList = array();
        }
      }
    }

    $toString = "$toSwitch " . implode(" ", $toList);
    $cmd = "(python3 $pyFile $toString $fromString $subjectString $plainTextString $awsSesLoggingContext) &";
    exec($cmd);
  }

SendMail()

ErrorMail::SendMail

(

)

function SendMail() Send an email through AWS SES. Like the previous implemention, the email is sent in the background. That means that there is no checking to see if the email has failed. For AWS SES fails are: 1) Invalid syntax of either from or to emails (should be checked before), 2) The From email is not verified (at this point in time, the default of norep.nosp@m.ly@h.nosp@m.omecu.nosp@m..net is not verified.), For more information,

See also

the sendSESEmail.py script.

Definition at line 111 of file errormail.i.

                      {
    $pyFile = $this->getPyFileLocation();

    // Set up from
    $from = $this->mailfromname != '' ? "{$this->mailfromname} <{$this->mailfrom}>" : $this->mailfrom;
    $fromString = "--efrom " . escapeshellarg($from);

    // Set up reply to
    $replyToString = $this->replyto != "" ? "--replyto " . escapeshellarg($this->replyto) : "";

    // Set up subject
    $subjectString = "--subject " . escapeshellarg($this->subject);

    // Now HTML emails are set up using the header declaration (legacy).
    // Also allow direct setting of the plaintext and htmltext parts of the email.
    $plainTextBody = "";
    $htmlTextBody = "";
    if ($this->htmlMsgbody != "") {
      $htmlTextBody = $this->htmlMsgbody;
    }
    if ($this->plainMsgbody != "") {
      $plainTextBody = $this->plainMsgbody;
    }
    if ($this->msgbody != "") {
      if (trim(strtolower($this->header)) == "content-type: text/html") { // For the most part, they have the same case except for a couple.
        $htmlTextBody = $this->msgbody;
      } else {
        $plainTextBody = $this->msgbody;
      }
    }

    // Need to escape newlines.  They cause the email to fail.
    $plainTextString = "";
    $htmlTextString = "";
    if ($plainTextBody != "") {
      // Requires some finagling: if newline is literal \n then bash line doesn't work but with \\n, it shows up in the email as "\n."
      $plainTextBody = str_replace("\n", "\\n", str_replace("\r\n", "\\r\\n", $plainTextBody));
      $plainTextString = "--plaintext \"`echo " . escapeshellarg($plainTextBody) . "`\"";
    }
    if ($htmlTextBody != "") {
      // Do not replace newlines with breaks.  Script is responsible for displaying correctly; also breaks image data (in the case of billing/workflow emails.)
      $htmlTextString = "--htmltext " . escapeshellarg($htmlTextBody);
    }

    if ($plainTextString == "" && $htmlTextString == "") {
      $plainTextString = "--plaintext ''";
    }

    // Set up to.  Amazon has a limit of 50 recipients so parse at this point.
    $toArray = is_array($this->mailto) ? $this->mailto : explode(";", str_replace(",", ";", strval($this->mailto)));
    $toSwitch = $this->hideto ? "--bcc" : "--to";
    $executeQuietly = $this->executeQuietly ? "--quiet" : "";

    // sanitize list of emails
    $toArray = array_map("trim", $toArray);
    $toArray = array_map("escapeshellarg", $toArray);

    $toString = "$toSwitch " . implode(" ", $toArray);

    $awsSesLoggingContext = "--context " . escapeshellarg($this->getAwsSesLoggingContextJsonString());

    $cmd = "(python3 $pyFile $toString $fromString $subjectString $plainTextString \
            $htmlTextString $replyToString $executeQuietly $awsSesLoggingContext) > /dev/null &";

    exec($cmd);
  }

---

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

• app/web/shared/library/errormail.i