https://github.com/technodelight/zenc-email-logger
Email logging functionality for Magento
https://github.com/technodelight/zenc-email-logger
Last synced: about 1 year ago
JSON representation
Email logging functionality for Magento
- Host: GitHub
- URL: https://github.com/technodelight/zenc-email-logger
- Owner: technodelight
- License: mit
- Created: 2013-11-19T13:40:35.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T07:46:33.000Z (about 5 years ago)
- Last Synced: 2025-03-26T14:06:00.942Z (about 1 year ago)
- Language: PHP
- Size: 87.9 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zenc-email-logger
=================
[](https://scrutinizer-ci.com/g/technodelight/zenc-email-logger/?branch=master)
[](https://scrutinizer-ci.com/g/technodelight/zenc-email-logger/build-status/master)
Email logging functionality for Magento. Useful if you don't want to deal with sendmail/postfix/whatever setups and you want to debug/style email contents on your local environment.
The logger has the following advantages over other tools:
- Could be added easily to existing projects without requiring any special 3rd party tool
- Logs emails with detailed (extendable) informations to database, including headers and raw email output
- Logging through re-usable elements (A compatible `Zend_Mail` override and a custom zend mail transport for logging)
- allow adding extra informations before saving to log instance by subscribing to the custom event `zenc_emaillogger_send_mail`
- restful API to retrieve email details, with formatting capabilities (dump, html, json formats supported), allows retrieving last sent email
#### How to use
The content's captured by the logger is now only visible via the rest controller. There's a plan to add an admin panel for this in the future.
To retrieve the list of sent mails, visit your browser with this URL:
```
/emails/rest/list
```
To retrieve the last email which have been sent, just go here:
```
/emails/rest/read/id/last
```
To retrieve the contents of a specific email you can use the ID of the log record instead of `last`, like `/emails/rest/read/id/1` .
The REST controller has the ability to change the format of rendering. Just append `?format=` to the end of the URL. Currently available renderers:
- dump (which does a `var_dump()` on the log item's data)
- html (renders the email's HTML content if present)
- json (dumps every data in a friendly format, so you could use this module in your CI)
##### Configuration options
There are two options you can set under **System -> Configuration -> Developer -> Email Logger**:
- Enabled - enables/disables the functionality
- Enable Passthrough - enables/disables passthrough (when enabled emails are both logged AND sent out)
## INSTALLATION Via Modman - Recommended (https://github.com/colinmollenhour/modman)
#### 1) Install Modman:
```
bash < <(wget -O - https://raw.github.com/colinmollenhour/modman/master/modman-installer)
```
or
```
bash < <(curl -s https://raw.github.com/colinmollenhour/modman/master/modman-installer)
source ~/.profile
```
#### 2) Install Zenc EmailLogger
cd [magento root folder]
modman init
modman clone https://github.com/technodelight/zenc-email-logger.git
- Make sure you've cleaned Magento's cache to enable the new module; hit refresh
#### How to update
modman update zenc-email-logger
- Clean Magento's cache to make sure new changes will be enabled.
- Run setup scripts with n98-magerun
#### Notes
This readme is also available as a github page: http://technodelight.github.io/zenc-email-logger/
#### License
[OSL v3](http://opensource.org/licenses/OSL-3.0)