{"id":1262,"date":"2016-01-04T21:03:30","date_gmt":"2016-01-04T15:03:30","guid":{"rendered":"http:\/\/promincproductions.com\/blog\/?p=1262"},"modified":"2021-10-23T13:55:10","modified_gmt":"2021-10-23T18:55:10","slug":"magento-custom-error-email","status":"publish","type":"post","link":"https:\/\/promincproductions.com\/blog\/magento-custom-error-email\/","title":{"rendered":"Magento 1: Custom Error \/ Exception Email"},"content":{"rendered":"

Magento has a process that send the website administrator an email when an exception is thrown.  That system works just fine.  When this happens, the rendering of the remainder of the page is halted and the user will be displayed an error page.<\/p>\n\n\n\n

\"Magento<\/a>
Trigger a custom error email in Magento that emulates the exception emails without throwing the exception on the website. This allows for custom error events without disrupting the user experience.<\/figcaption><\/figure><\/div>\n\n\n\n

However, what about the instance where you want to receive the same email while not<\/em> interrupting the user experience.  In other-words, send the email and then continue to render the page page.  There is no default method for this built into Magento.  So continue to read below for a quick fix that allows you to implement an Exception Email without the standard exception process happening.<\/p>\n\n\n\n

Note: This code is designed to worith with Magento 1.x versions.<\/p>\n\n\n\n

Caution<\/h2>\n\n\n\n

I’ll get this out of the way from the get-go.  Implementing this could have adverse effects in that your users may not have the experience they\/you expect, allowing code to continue may result in excessive server usage, etc.  Use this sparingly and ensure that you are handling errors correctly.<\/p>\n\n\n\n

In my case, the situation where I’m using this is to alert me if a CURL request had failed.  The error was being handled correctly already, but aside from reading the logs I have no way of being informed that the CURL request failed.  So that’s where this new email alert comes into play.<\/p>\n\n\n\n

The Code<\/h2>\n\n\n\n

In the code below, replace PromInc<\/strong> with your company name.<\/p>\n\n\n\n

Generate and Send the Error<\/h3>\n\n\n\n

We need to extend the Core helper to add two methods:<\/p>\n\n\n\n

  1. Generate a callstack to include in the email<\/li>
  2. Generate and send the contents of the email<\/li><\/ol>\n\n\n\n

    Add the following files.<\/p>\n\n\n\n

    File:
    <\/strong>app\/etc\/modules\/PromInc_Modules<\/strong>.xml<\/p>\n\n\n\n

    <?xml version=\"1.0\" encoding=\"utf-8\"?>\n<config>\n <modules>\n  <PromInc_Core>\n    <active>true<\/active>\n     <codePool>local<\/codePool>\n  <\/PromInc_Core>\n <\/modules>\n<\/config>\n<\/code><\/pre>\n\n\n\n
    File:
    <\/strong>app\/code\/local\/PromInc<\/strong>\/Core\/etc\/config.xml<\/p>\n\n\n\n
    <config>\n  <global>\n    <helpers>\n      <core>\n        <rewrite>\n          <data>PromInc_Core_Helper_Data<\/data>\n        <\/rewrite>\n      <\/core>\n    <\/helpers>\n  <\/global>\n<\/config>\n<\/code><\/pre>\n\n\n\n
    File:
    <\/strong>app\/code\/local\/PromInc<\/strong>\/Core\/Helper\/Data.php    <\/p>\n\n\n\n
    <?php\nclass PromInc_Core_Helper_Data extends Mage_Core_Helper_Data\n{\n\n const LS = \"\\n\";\n\n \/**\n * Get Callstack\n *\n * @param mixed $delim (default self::LS) Line delimiter\n *\n * @return string Callstack\n *\/\n public function get_callstack($delim=self::LS) {\n   $dt = debug_backtrace();\n   $cs = '';\n   foreach ($dt as $t) {\n     $cs .= $t['file'] . ' line ' . $t['line'] . ' calls ' . $t['function'] . \"()\" . $delim;\n   }\n   return $cs;\n }\n\n\n \/**\n * Send an error email to the website adminstrator\n *\n * This is the same error email recieved when an exception is thrown,\n * however this does not interupt the rendering of the rest of the page.\n *\n * This is used for custom functions where you need to be alerted of an instance on the site while not disrupting the user experience.\n *\n * @param mixed $errorTitle (default NULL) Title of the error (default NULL)\n * @param mixed $location (default NULL) Location in code that the error occurred\n * For .php files: __METHOD__\n * For .phtml files: __FILE__\n * @param mixed $extraInfo (default NULL) Optional information to pass in the email\n *\/\n public function sendExceptionEmail($errorTitle=NULL, $location=NULL, $extraInfo=NULL) {\n   $errorDetails = Mage::helper('core')->get_callstack();\n   $errorDetails .= self::LS.self::LS;\n   $errorDetails .= \"Location In Code:\".self::LS.$location;\n   if( $errorDetails ) {\n     $errorDetails .= self::LS.self::LS;\n     $errorDetails .= \"Error Details:\".self::LS.$extraInfo;\n    }\n    $errorDetails .= self::LS.self::LS;\n\n    $reportData = array(\n      0 => $errorTitle,\n      1 => $errorDetails,\n      \"script_name\" => __METHOD__,\n      \"skin\" => Mage::app()->getStore()->getCode(),\n      \"url\" => Mage::getSingleton('core\/url')->parseUrl( Mage::helper('core\/url')->getCurrentUrl() )->getPath()\n    );\n\n    if (isset($reportData) && is_array($reportData)) {\n      require(Mage::getBaseDir().DS.'errors'.DS.'processor.php');\n      $processor = new Error_Processor();\n      $processor->saveReport($reportData);\n      $processor->sendReport();\n    }\n }\n\n}<\/code><\/pre>\n\n\n\n
    With these two files added, clear the cache from within the Magento Admin.<\/p>\n\n\n\n
    1. System -> Cache Management<\/li>
    2. Check Configuration<\/strong> and Layouts<\/strong> and click Submit<\/strong>.<\/li><\/ol>\n\n\n\n
      Trigger the Exception Email<\/h3>\n\n\n\n
      All that needs to be done now is to trigger the email to send from within your code where an error has occurred.<\/p>\n\n\n\n
      Mage::helper('core')->sendExceptionEmail(\"Error Name\", \"Additional Error Information\");<\/code><\/pre>\n\n\n\n
      Parameters:<\/p>\n\n\n\n
      Parameter Name<\/strong><\/td>Default Value<\/strong><\/td>Description<\/strong><\/td><\/tr>
      $errorTitle<\/td>ERROR (Magento)<\/td>The title\/name of the error that has occurred.<\/td><\/tr>
      $location<\/td>NULL<\/td>\n
      Location in code that the error occurred.<\/p>\n
      It depends on where you are calling this exception email as to what you want to set this value to:<\/p>\n
        \n
      • For .php files: __METHOD__<\/li>\n
      • For .phtml files: __FILE__<\/li>\n<\/ul>\n<\/td><\/tr>
      $extraInfo<\/td>NULL<\/td>\n
      Extra information that you wish to have passed into the email.<\/p>\n
      See below for the default contents of the email, which includes a stacktrace.<\/p>\n
      Note: if you want a new line within this extra content, pass it in with the string “\\n” in your variable.<\/p>\n<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      Example of Email Contents<\/h2>\n\n\n\n
      URL: http:\/\/www.example.com\/var\/www\/staging\/index.php\/some\/page.html\n\nIP Address: 10.10.10.10\n\nTime: 2015-12-18 22:17:04 GMT\n\nError:\nError Title Will Go Here\n\nTrace:\n\/var\/www\/staging\/app\/code\/core\/Mage\/Core\/Controller\/Varien\/Action.php line 420 calls newajaxAction() \/var\/www\/staging\/app\/code\/core\/Mage\/Core\/Controller\/Varien\/Router\/Standard.php line 254 calls dispatch() \/var\/www\/staging\/app\/code\/core\/Mage\/Core\/Controller\/Varien\/Front.php line 176 calls match() \/var\/www\/staging\/app\/code\/core\/Mage\/Core\/Model\/App.php line 349 calls dispatch() \/var\/www\/staging\/app\/Mage.php line 640 calls run() \/var\/www\/staging\/index.php line 81 calls run()\n\n\nLocation:\nPromInc_Core_Helper_Data::sendExceptionEmail\nThis is additional information I passed into the error<\/pre>","protected":false},"excerpt":{"rendered":"
      Magento has a process that send the website administrator an email when an exception is thrown.  That system […]<\/p>\n","protected":false},"author":1,"featured_media":1279,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"wprm-recipe-roundup-name":"","wprm-recipe-roundup-description":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[46,5],"tags":[],"class_list":["post-1262","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-magento","category-website-development"],"jetpack_featured_media_url":"https:\/\/promincproductions.com\/blog\/wp-content\/uploads\/2016\/01\/Magento-Custom-Error-Email.jpg","jetpack_shortlink":"https:\/\/wp.me\/p4BbcR-km","jetpack_sharing_enabled":true,"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/posts\/1262","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/comments?post=1262"}],"version-history":[{"count":7,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/posts\/1262\/revisions"}],"predecessor-version":[{"id":2033,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/posts\/1262\/revisions\/2033"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/media\/1279"}],"wp:attachment":[{"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/media?parent=1262"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/categories?post=1262"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/promincproductions.com\/blog\/wp-json\/wp\/v2\/tags?post=1262"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}