Chris/webperl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deprecating the hell out of the email functions.

Browse Source
This commit is contained in:
Chris 2013-01-29 21:22:55 +00:00
parent d08f185276
commit 284f718be0
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Webperl/Template.pm
View File

@ -120,6 +120,8 @@ package Webperl::Template;
use POSIX qw(strftime); use POSIX qw(strftime);
use Webperl::Utils qw(path_join superchomp); use Webperl::Utils qw(path_join superchomp);
use Carp qw(longmess);
use strict; use strict;
our ($errstr, $utfentities, $entities, $ords, @timescales); our ($errstr, $utfentities, $entities, $ords, @timescales);
@ -710,6 +712,14 @@ sub build_optionlist {
# as normal, and prepend an email header using the to and cc fields in the args (bcc # as normal, and prepend an email header using the to and cc fields in the args (bcc
# is not supported). # is not supported).
# #
# @deprecated This function should not be used in new code: it is horribly inflexible,
# relies heavily on sendmail-based functionality, and is not really part of
# the template engine's job anyway. New code should use the facilities
# provided by Webperl::Message::Queue - you should send email by calling
# Webperl::Message::Queue::queue_message(), using Webperl::Template::load_template()
# to load and process the message body before passing it into `queue_message()`
# in the `message` argument.
#
# @param template The name of the template to load and send. # @param template The name of the template to load and send.
# @param args A reference to a hash containing values to substitute in the template. # @param args A reference to a hash containing values to substitute in the template.
# This MUST include 'from', 'to', and 'subject' values! # This MUST include 'from', 'to', and 'subject' values!
@ -720,6 +730,8 @@ sub email_template {
my $args = shift; my $args = shift;
my $email; my $email;
print STDERR longmess("Call to deprecated Webperl::Template::email_template()");
# Check we have required fields # Check we have required fields
return "No from field specified in email template arguments." if(!$args -> {"***from***"}); return "No from field specified in email template arguments." if(!$args -> {"***from***"});
return "No subject field specified in email template arguments." if(!$args -> {"***subject***"}); return "No subject field specified in email template arguments." if(!$args -> {"***subject***"});
@ -748,12 +760,22 @@ sub email_template {
# specified email over a pipe to sendmail, sending it to the recipient(s). The # specified email over a pipe to sendmail, sending it to the recipient(s). The
# email should be complete, including any headers. # email should be complete, including any headers.
# #
# @deprecated This function should not be used in new code: it is horribly inflexible,
# relies heavily on sendmail-based functionality, and is not really part of
# the template engine's job anyway. New code should use the facilities
# provided by Webperl::Message::Queue - you should send email by calling
# Webperl::Message::Queue::queue_message(), using Webperl::Template::load_template()
# to load and process the message body before passing it into `queue_message()`
# in the `message` argument.
#
# @param email The email to send. # @param email The email to send.
# @return undef if the mail was sent, otherwise an error message is returned. # @return undef if the mail was sent, otherwise an error message is returned.
sub send_email_sendmail { sub send_email_sendmail {
my $self = shift; my $self = shift;
my $email = shift; my $email = shift;
print STDERR longmess("Call to deprecated Webperl::Template::send_email_sendmail()");
open(SENDMAIL, "|".$self -> {"mailcmd"}) open(SENDMAIL, "|".$self -> {"mailcmd"})
or return "send_email_sendmail: unable to open sendmail pipe: $!"; or return "send_email_sendmail: unable to open sendmail pipe: $!";
print SENDMAIL $email print SENDMAIL $email