- \n
- Eliminate the need to include the webmaster in any “To list”; the webmaster is always sent a Bcc by default.<\/li>\n
- Eliminate need to add headers for HTML layout with an option to remove if needed.<\/li>\n
- Enable the simple organization of those oh so common form submission or list E-mails to be formatted into a table layout without any markup in the initial mail string.<\/li>\n
- Provide defaults so the bare minimum of parameters may be used when calling.<\/li>\n<\/ul>\n
Elements<\/h1>\n
Requirements<\/h2>\n
- \n
- PHP 5.3+<\/li>\n<\/ul>\n
Files<\/h2>\n
Copy the following into your class file.<\/p>\n
\r\nclass class_mail\r\n{ \r\n\r\n\t\/*\r\n\tclass_mail - https:\/\/www.caskeys.com\/dc\/?p=5031\r\n\tDamon Vaughn Caskey\r\n\t2012_12_10\r\n\t\r\n\tMail handler. \r\n\t*\/\t\r\n\t\t\r\n\tconst\tc_bWMAlert\t= TRUE;\t\t\t\t\t\t\t\t\t\t\/\/Send webmaster a blind copy?\r\n\tconst\tc_cEDefMsg\t= "...";\t\t\t\t\t\t\t\t\t\/\/Default message.\r\n\tconst\tc_cEHead\t= "MIME-Version: 1.0 \\r\\nContent-type: text\/html; charset=iso-8859-1\\r\\n";\t\/\/Default E-mail headers.\r\n\tconst\tc_cESubject\t= "From EHS Web";\t\t\t\t\t\t\t\/\/Default outgoing E-mail subject.\r\n\tconst\tc_cEWMIn\t= "dvcask2@uky.edu";\t\t\t\t\t\t\/\/Default webmaster's incoming E-mail address.\r\n\tconst\tc_cEWMOut\t= "ehs_noreply@uky.edu";\t\t\t\t\t\/\/Default address when server sends mail.\r\n\t\t\t\t\r\n\tpublic function mail_send($cMsg=self::c_cEDefMsg, $cSubject=self::c_cESubject, $cTo=self::c_cEWMIn, $cFrom=self::c_cEWMOut, $cBcc=NULL, $bWMAlert=self::c_bWMAlert, $cHeader=self::c_cEHead, $cParams=NULL)\r\n\t{\t\r\n\t\t\/*\r\n\t\tmail_send\r\n\t\tDamon Vaughn Caskey\r\n\t\t2012_12_28\r\n\t\t\r\n\t\tSend HTML mail with standard defaults.\r\n\t\t\r\n\t\t$cMsg:\t\tBody of E-mail.\r\n\t\t$cSubject:\tSubject line.\r\n\t\t$cTo:\t\tOutgoing address list.\r\n\t\t$cFrom:\t\tReturn address.\r\n\t\t$cBcc:\t\tBlind carbon copy address list.\r\n\t\t$bWMAlert:\tSend Bcc to webmaster.\r\n\t\t$cHeader:\tHeader information.\r\n\t\t$cParams:\tOptional parameters.\r\n\t\t*\/\r\n\t\r\n\t\t$cBody = NULL;\t\/\/Final sting for message body.\r\n\t\r\n\t\t\/*\r\n\t\tInsert From address to header.\r\n\t\t*\/\r\n\t\t$cHeader .= "From: ".$cFrom. "\\r\\n";\t\t\r\n\t\t\r\n\t\t\/* \r\n\t\tIf Webmaster alert is on, insert address into Bcc and add to header. Otherwise just add Bcc to header as is.\r\n\t\t*\/\r\n\t\tif($bWMAlert===TRUE)\r\n\t\t{\t\t\t\r\n\t\t\t$cHeader .= "Bcc: ".self::c_cEWMIn. ", ".$cBcc."\\r\\n";\t\r\n\t\t}\r\n\t\telse\r\n\t\t{\r\n\t\t\t$cHeader .= "Bcc: ".$cBcc."\\r\\n";\r\n\t\t}\r\n\t\t\r\n\t\t$cHeader .="\\r\\n";\r\n\t\t\r\n\t\t\/*\r\n\t\tIf message passed as a key array, break into list and output as table layout.\r\n\t\t*\/\t\t\r\n\t\tif (is_array($cMsg))\r\n\t\t{\r\n\t\t\t\/*\r\n\t\t\tInitial html and table markup.\r\n\t\t\t*\/\r\n\t\t\t$cBody = "<html>\r\n\t\t\t\t\t\t<head>\r\n\t\t\t\t\t\t <title>".$cSubject."<\/title>\r\n\t\t\t\t\t\t<\/head>\r\n\t\t\t\t\t\t<body>\r\n\t\t\t\t\t\t <h1>".$cSubject."<\/h1>\r\n\t\t\t\t\t\t <table cellpadding='3'>";\r\n\t\t\t\r\n\t\t\t\/*\r\n\t\t\tGet each item in array and place into two column table row.\r\n\t\t\t*\/\r\n\t\t\tforeach($cMsg as $key => $value)\r\n\t\t\t{\t\t\t\r\n\t\t\t\t$cBody .= "<tr><th>".$key.":<\/th><td>".$value."<\/td><\/tr>";\t\t\t\r\n\t\t\t}\t\r\n\t\t\t\r\n\t\t\t\/*\r\n\t\t\tAdd closing markup.\r\n\t\t\t*\/\r\n\t\t\t$cBody .= "<\/table>\r\n\t\t\t\t\t<\/body>\r\n\t\t\t\t\t<\/html>";\t\r\n\t\t}\r\n\t\telse\r\n\t\t{\r\n\t\t\t\/*\r\n\t\t\tOutput message as is.\r\n\t\t\t*\/\r\n\t\t\t$cBody = $cMsg;\r\n\t\t}\r\n\t\t\t\r\n\t\t\/*\r\n\t\tRun mail function.\r\n\t\t*\/\r\n\t\treturn mail($cTo, $cSubject, $cBody, $cHeader, $cParams);\t\t\r\n\t}\t\r\n}\r\n\r\n<\/pre>\nNow include the file in your script and declare a class object. You are ready to go. Personally I prefer to place common class declarations in a single config file and use injected dependency to avoid multiple objects.<\/p>\n
\r\nrequire_once('mail.php');\t\/\/Path to mail class.\r\n\r\n$oMail = NULL;\t\t\t\t\/\/Initialize class object.\r\n\r\n$oMail = new class_mail();\t\/\/Class object.\r\n<\/pre>\nUse<\/h1>\n
Constants<\/h2>\n
Adjust the constant settings to suit your needs.<\/p>\n
\r\nconst\tc_bWMAlert\t= TRUE;\t\t\t\t\t\t\t\t\t\t\/\/Send webmaster a blind copy?\r\nconst\tc_cEDefMsg\t= "...";\t\t\t\t\t\t\t\t\t\/\/Default message.\r\nconst\tc_cEHead\t= "MIME-Version: 1.0 \\r\\nContent-type: text\/html; charset=iso-8859-1\\r\\n";\t\/\/Default E-mail headers.\r\nconst\tc_cESubject\t= "From EHS Web";\t\t\t\t\t\t\t\/\/Default outgoing E-mail subject.\r\nconst\tc_cEWMIn\t= "dvcask2@uky.edu";\t\t\t\t\t\t\/\/Default webmaster's incoming E-mail address.\r\nconst\tc_cEWMOut\t= "ehs_noreply@uky.edu";\t\t\t\t\t\/\/Default address when server sends mail.\r\n<\/pre>\n
- \n
- c_bWMAlert: Default option to always send Webmaster a Bcc of the outgoing mail.<\/li>\n
- c_cEDefMsg: Default message text.<\/li>\n
- c_cEHead: Default headers. Included in the class are the headers required to send E-mail with HTML formatting (tables, title, etc.).<\/li>\n
- c_cESubject: Default E-mail subject.<\/li>\n
- c_cEWMIn: Webmaster’s incoming address. By default a Bcc of every mail will be sent to this address.<\/li>\n
- c_cEWMOut: Default “from” address.<\/li>\n<\/ul>\n
Functions<\/h2>\n
mail_send<\/h3>\n
Primary (and as of this writing the only) function. Sends an E-mail; includes an optional tabled layout.<\/p>\n
\r\npublic function mail_send($cMsg=self::c_cEDefMsg, $cSubject=self::c_cESubject, $cTo=self::c_cEWMIn, $cFrom=self::c_cEWMOut, $cBcc=NULL, $bWMAlert=self::c_bWMAlert, $cHeader=self::c_cEHead, $cParams=NULL)\r\n\t{\t\r\n\t\t\/*\r\n\t\tmail_send\r\n\t\tDamon Vaughn Caskey\r\n\t\t2012_12_28\r\n\t\t\r\n\t\tSend HTML mail with standard defaults.\r\n\t\t\r\n\t\t$cMsg:\t\tBody of E-mail.\r\n\t\t$cSubject:\tSubject line.\r\n\t\t$cTo:\t\tOutgoing address list.\r\n\t\t$cFrom:\t\tReturn address.\r\n\t\t$cBcc:\t\tBlind carbon copy address list.\r\n\t\t$bWMAlert:\tSend Bcc to webmaster.\r\n\t\t$cHeader:\tHeader information.\r\n\t\t$cParams:\tOptional parameters.\r\n\t\t*\/\r\n\t\r\n\t\t$cBody = NULL;\t\/\/Final sting for message body.\r\n\t\r\n\t\t\/*\r\n\t\tInsert From address to header.\r\n\t\t*\/\r\n\t\t$cHeader .= "From: ".$cFrom. "\\r\\n";\t\t\r\n\t\t\r\n\t\t\/* \r\n\t\tIf Webmaster alert is on, insert address into Bcc and add to header. Otherwise just add Bcc to header as is.\r\n\t\t*\/\r\n\t\tif($bWMAlert===TRUE)\r\n\t\t{\t\t\t\r\n\t\t\t$cHeader .= "Bcc: ".self::c_cEWMIn. ", ".$cBcc."\\r\\n";\t\r\n\t\t}\r\n\t\telse\r\n\t\t{\r\n\t\t\t$cHeader .= "Bcc: ".$cBcc."\\r\\n";\r\n\t\t}\r\n\t\t\r\n\t\t$cHeader .="\\r\\n";\r\n\t\t\r\n\t\t\/*\r\n\t\tIf message passed as a key array, break into list and output as table layout.\r\n\t\t*\/\t\t\r\n\t\tif (is_array($cMsg))\r\n\t\t{\r\n\t\t\t\/*\r\n\t\t\tInitial html and table markup.\r\n\t\t\t*\/\r\n\t\t\t$cBody = "<html>\r\n\t\t\t\t\t\t<head>\r\n\t\t\t\t\t\t <title>".$cSubject."<\/title>\r\n\t\t\t\t\t\t<\/head>\r\n\t\t\t\t\t\t<body>\r\n\t\t\t\t\t\t <h1>".$cSubject."<\/h1>\r\n\t\t\t\t\t\t <table cellpadding='3'>";\r\n\t\t\t\r\n\t\t\t\/*\r\n\t\t\tGet each item in array and place into two column table row.\r\n\t\t\t*\/\r\n\t\t\tforeach($cMsg as $key => $value)\r\n\t\t\t{\t\t\t\r\n\t\t\t\t$cBody .= "<tr><th>".$key.":<\/th><td>".$value."<\/td><\/tr>";\t\t\t\r\n\t\t\t}\t\r\n\t\t\t\r\n\t\t\t\/*\r\n\t\t\tAdd closing markup.\r\n\t\t\t*\/\r\n\t\t\t$cBody .= "<\/table>\r\n\t\t\t\t\t<\/body>\r\n\t\t\t\t\t<\/html>";\t\r\n\t\t}\r\n\t\telse\r\n\t\t{\r\n\t\t\t\/*\r\n\t\t\tOutput message as is.\r\n\t\t\t*\/\r\n\t\t\t$cBody = $cMsg;\r\n\t\t}\r\n\t\t\t\r\n\t\t\/*\r\n\t\tRun mail function.\r\n\t\t*\/\r\n\t\treturn mail($cTo, $cSubject, $cBody, $cHeader, $cParams);\t\t\r\n\t}\r\n<\/pre>\nParameters<\/h4>\n
Unless noted, parameters are not required. Class defaults will be used for any missing.<\/p>\n
- \n
- $cMsg: The message to send (i.e. the body text). If passed as a keyed array, the listed items will be laid out as a table. See below for details.<\/li>\n
- $cSubject: Mail subject.<\/li>\n
- $cTo: Recipient address(s).<\/li>\n
- $cFrom: Sender address.<\/li>\n
- $cBcc: Blind copy address(s).<\/li>\n
- $bWMAlert: Send a blind copy to webmaster.<\/li>\n
- $cHeader: Header options.<\/li>\n
- $cParams: Optional parameters. See PHP Mail<\/a> for details.<\/li>\n<\/ul>\n
Examples<\/h4>\n
Send regular E-mail<\/h5>\n
This call will send a common E-mail to the designated recipients with the automatic webmaster Bcc turned off:<\/p>\n
\r\n$cMsg = "Hello world!";\r\n$cSubject = "Hi";\r\n$cTo = "someone@somewhere.com, someoneelse@somewhereelse.com";\r\n$cFrom = "me@myplace.com";\r\n\r\n$oMail->mail_send($cMsg, $cSubject, $cTo, $cFrom, NULL, FALSE);\r\n<\/pre>\n
Send table E-mail<\/h5>\n
A common task for E-mail is to document errors, alerts, form submissions and other types of keyed data that is far easier to read in table format. It’s certainly possible to do this by manually coding table markup into the message, but also repetitive and time consuming.<\/p>\n
Instead, you can pass the message as a keyed array; a simple but elegant table from your data will be created and sent to the recipients. The E-mail’s subject will be added as an attention grabbing header just above the table.<\/p>\n
\r\n$cMsg \t= NULL;\r\n\r\n\t\t$cMsg = array(\r\n\t\t\t"Time"\t\t\t\t=>\t$this->cErrTOE,\r\n\t\t\t"Type"\t\t\t\t=>\t$this->cErrType,\r\n\t\t\t"IP"\t\t\t\t=>\t$this->cIP,\r\n\t\t\t"Def. Source File"\t=>\t$this->cSource,\r\n\t\t\t"Source File"\t\t=>\t$this->cErrFile,\r\n\t\t\t"Line"\t\t\t\t=>\t$this->cErrLine,\r\n\t\t\t"State"\t\t\t\t=>\t$this->cErrState,\r\n\t\t\t"Code"\t\t\t\t=>\t$this->cErrCode,\r\n\t\t\t"Message"\t\t\t=>\t$this->cErrMsg,\r\n\t\t\t"Details"\t\t\t=>\t$this->cErrDetail\r\n\t\t);\r\n\r\n$this->oMail->mail_send($cMsg, "Error Report");\r\n<\/pre>\n
Example output:<\/h6>\n
![\"In](\"https:\/\/www.caskeys.com\/dc\/wp-content\/uploads\/2013\/01\/E-mail_error_0001-150x150.png\")
<\/a>In this example, an error alert is sent using table layout.<\/figcaption><\/figure>\n","protected":false},"excerpt":{"rendered":" PHP Class to simplify sending E-mail and E-mail forms.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":true,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[71],"tags":[211,234],"class_list":["post-5031","post","type-post","status-publish","format-standard","hentry","category-technology-temerity","tag-coding-object-oriented","tag-coding-php"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p5lNM5-1j9","jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/posts\/5031","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/comments?post=5031"}],"version-history":[{"count":20,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/posts\/5031\/revisions"}],"predecessor-version":[{"id":6225,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/posts\/5031\/revisions\/6225"}],"wp:attachment":[{"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/media?parent=5031"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/categories?post=5031"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.caskeys.com\/dc\/wp-json\/wp\/v2\/tags?post=5031"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- PHP 5.3+<\/li>\n<\/ul>\n