[Jifty-commit] r6415 - in jifty/trunk: plugins.old/EmailErrors/lib/Jifty/Plugin

Jifty commits jifty-commit at lists.jifty.org
Wed Feb 25 00:24:55 EST 2009


Author: alexmv
Date: Wed Feb 25 00:24:55 2009
New Revision: 6415

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/plugins.old/EmailErrors/lib/Jifty/Plugin/EmailErrors.pm

Log:
 r42562 at kohr-ah:  chmrr | 2009-02-24 23:52:12 -0500
 Add POD for EmailErrors


Modified: jifty/trunk/plugins.old/EmailErrors/lib/Jifty/Plugin/EmailErrors.pm
==============================================================================
--- jifty/trunk/plugins.old/EmailErrors/lib/Jifty/Plugin/EmailErrors.pm	(original)
+++ jifty/trunk/plugins.old/EmailErrors/lib/Jifty/Plugin/EmailErrors.pm	Wed Feb 25 00:24:55 2009
@@ -4,8 +4,33 @@
 package Jifty::Plugin::EmailErrors;
 use base qw/Jifty::Plugin/;
 
-# Your plugin goes here.  If takes any configuration or arguments, you
-# probably want to override L<Jifty::Plugin/init>.
+=head1 NAME
+
+Jifty::Plugin::EmailErrors - Emails all 500 pages to an arbitrary email address
+
+=head1 SYNOPSIS
+
+In your config.yml or equivilent:
+
+  Plugins:
+   - EmailErrors:
+       to: address at example.com
+       from: server at example.com
+       subject: Server error
+
+=head1 DESCRIPTION
+
+All errors which result in the browser going to the '500 server error'
+page will send an email with the stack trace that caused it.
+
+=head1 METHODS
+
+=head2 init
+
+Sets up the global values for C<from>, C<to>, and C<subject>, based on
+the plugin's provided configuration.
+
+=cut
 
 sub init {
     my $self = shift;


More information about the Jifty-commit mailing list