[livejournal] r18928: a little bit of documentation will help ...

U   trunk/cgi-bin/ljmail.pl

Modified: trunk/cgi-bin/ljmail.pl
===================================================================
--- trunk/cgi-bin/ljmail.pl	2011-04-21 03:49:31 UTC (rev 18927)
+++ trunk/cgi-bin/ljmail.pl	2011-04-21 04:07:10 UTC (rev 18928)
@@ -1,6 +1,20 @@
 #!/usr/bin/perl
 #
 
+#
+# Synopsis:
+#
+# LJ::send_mail({
+#     'to'        => $email,
+#     'from'      => $LJ::DONOTREPLY_EMAIL,
+#     'fromname'  => $LJ::SITENAME, # optional
+#     'charset'   => $encoding, # optional, defaults to utf8
+#     'subject'   => $subject,
+#     'body'      => $body,
+#     'html'      => $html, # optional
+# }) or die "Error: couldn't send email";
+#
+
 use strict;
 
 use lib "$ENV{LJHOME}/cgi-bin";