Skip to content

Commit

Permalink
+Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JWardee committed Dec 2, 2020
1 parent 9c227df commit 3095d1d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Backup and save your contact form emails (including Contact Form 7) to your data
* Debugging - see exactly which file and code line was responsible for sending the email, along with any errors encountered
* Manage what user permissions can see the logs
* Routinely have your logs cleared out at a specified time - or keep them forever
* Need to be notified when there's a problem sending your mail. We've got hooks to allow you to do just that
* Need to be notified when there's a problem sending your mail? We've got hooks that allow you to do just that
* Completely free

![alt text](https://raw.githubusercontent.com/JWardee/wp-mail-catcher/master/build/images/wp-mail-catcher-screenshot-1.png)
Expand Down
24 changes: 24 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,27 @@ Immediately find out if your contact form submission was successfully sent.
* Debugging - see exactly which file and code line was responsible for sending the email, along with any errors encountered
* Manage what user permissions can see the logs
* Routinely have your logs cleared out at a specified time - or keep them forever
* Need to be notified when there's a problem sending your mail? We've got hooks that allow you to do just that
* Completely free

## Hooks and actions
* `wp_mail_catcher_mail_success` is triggered when a message is sent and logged successfully. It has a single argument that is an array containing the log
* `id` related to the id in the `mail_catcher_logs` MySQL table
* `time` relative, readable time to when the log was saved
* `email_to` the email address(es) that the message was sent to
* `subject` the subject line of the message
* `message` the contents of the message
* `status` an integer depicting if the message was sent successfully or not (1 = sent successfully. 0 = sending failed)
* `error` the error that occurred - if any
* `backtrace_segment` a json_encoded object that shows which file and line the mail was initially triggered from
* `attachments` a list of any attachments that were sent along with the email
* `additional_headers` a list of any headers that were sent
* `attachment_file_paths` a list of the location of any attachments that were sent
* `timestamp` a unix timestamp of when the email was sent
* `is_html` a boolean, that will be true if the message is a html email and false if not
* `email_from` the from value of the email
* `wp_mail_catcher_mail_failed` is triggered when a message is sent and logged successfully. It has a single argument that is an array containing the log (same as the arguments for `wp_mail_catcher_mail_success`)

== Frequently Asked Questions ==
= Is this really free? =

Expand Down Expand Up @@ -73,6 +92,11 @@ Great! Please leave a note in our (GitHub tracker)

== Changelog ==

= 1.4.0 =

- Enhancement: Refreshed log table UI
- Enhancement: Added 2 new actions `wp_mail_catcher_mail_success` and `wp_mail_catcher_mail_failed`

= 1.3.10 =

- Performance: Email previews are now loaded lazily
Expand Down

0 comments on commit 3095d1d

Please sign in to comment.