"Solo",
);
-@base_items = qw (
- invoice_template
- invoice_latex
- invoice_latexreturnaddress
- invoice_latexfooter
- invoice_latexsmallfooter
- invoice_latexnotes
- invoice_latexcoupon
- invoice_html
- invoice_htmlreturnaddress
- invoice_htmlfooter
- invoice_htmlnotes
- logo.png
- logo.eps
- );
+@base_items = qw(
+invoice_template
+invoice_latex
+invoice_latexreturnaddress
+invoice_latexfooter
+invoice_latexsmallfooter
+invoice_latexnotes
+invoice_latexcoupon
+invoice_html
+invoice_htmlreturnaddress
+invoice_htmlfooter
+invoice_htmlnotes
+logo.png
+logo.eps
+);
+
+my %msg_template_options = (
+ 'type' => 'select-sub',
+ 'options_sub' => sub { require FS::Record;
+ require FS::agent;
+ require FS::msg_template;
+ map { $_->msgnum, $_->msgname }
+ qsearch('msg_template', { disabled => '' });
+ },
+ 'option_sub' => sub { require FS::msg_template;
+ my $msg_template = FS::msg_template->by_key(shift);
+ $msg_template ? $msg_template->msgname : ''
+ },
+);
+
#Billing (81 items)
#Invoicing (50 items)
#...
#Unclassified (77 items)
-
@config_items = map { new FS::ConfItem $_ } (
{
{
'key' => 'alert_expiration',
- 'section' => 'billing',
+ 'section' => 'notification',
'description' => 'Enable alerts about billing method expiration (i.e. expiring credit cards).',
'type' => 'checkbox',
'per_agent' => 1,
{
'key' => 'alerter_template',
- 'section' => 'billing',
- 'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards). See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Credit_cards_and_Electronic_checks">billing documentation</a> for details.',
+ 'section' => 'deprecated',
+ 'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
'type' => 'textarea',
'per_agent' => 1,
},
+
+ {
+ 'key' => 'alerter_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for credit card expiration alerts.',
+ %msg_template_options,
+ },
{
'key' => 'apacheip',
},
{
+ 'key' => 'decline_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for credit card and electronic check decline messages.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'declinetemplate',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Template file for credit card and electronic check decline emails.',
'type' => 'textarea',
},
{
'key' => 'emaildecline',
- 'section' => 'billing',
+ 'section' => 'notification',
'description' => 'Enable emailing of credit card and electronic check decline notices.',
'type' => 'checkbox',
},
{
'key' => 'emaildecline-exclude',
- 'section' => 'billing',
+ 'section' => 'notification',
'description' => 'List of error messages that should not trigger email decline notices, one per line.',
'type' => 'textarea',
},
{
+ 'key' => 'cancel_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for cancellation emails.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'cancelmessage',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Template file for cancellation emails.',
'type' => 'textarea',
},
{
'key' => 'cancelsubject',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Subject line for cancellation emails.',
'type' => 'text',
},
{
'key' => 'emailcancel',
- 'section' => 'billing',
- 'description' => 'Enable emailing of cancellation notices. Make sure to fill in the cancelmessage and cancelsubject configuration values as well.',
+ 'section' => 'notification',
+ 'description' => 'Enable emailing of cancellation notices. Make sure to select the template in the cancel_msgnum option.',
'type' => 'checkbox',
},
},
{
+ 'key' => 'welcome_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for welcome messages when a svc_acct record is created.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'welcome_email',
- 'section' => '',
- 'description' => 'Template file for welcome email. Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language. The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code></ul>',
+ 'section' => 'deprecated',
+ 'description' => 'Template file for welcome email. Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.',
'type' => 'textarea',
'per_agent' => 1,
},
{
'key' => 'welcome_email-from',
- 'section' => '',
+ 'section' => 'deprecated',
'description' => 'From: address header for welcome email',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'welcome_email-subject',
- 'section' => '',
+ 'section' => 'deprecated',
'description' => 'Subject: header for welcome email',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'welcome_email-mimetype',
- 'section' => '',
+ 'section' => 'deprecated',
'description' => 'MIME type for welcome email',
'type' => 'select',
'select_enum' => [ 'text/plain', 'text/html' ],
'type' => 'textarea',
},
+# {
+# 'key' => 'warning_msgnum',
+# 'section' => 'notification',
+# 'description' => 'Template to use for warning messages, sent to the customer email invoice destination(s) when a svc_acct record has its usage drop below a threshold.',
+# %msg_template_options,
+# },
+
{
'key' => 'warning_email',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Template file for warning email. Warning emails are sent to the customer email invoice destination(s) each time a svc_acct record has its usage drop below a threshold or 0. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language. The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code> <li><code>$column</code> <li><code>$amount</code> <li><code>$threshold</code></ul>',
'type' => 'textarea',
},
{
'key' => 'warning_email-from',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'From: address header for warning email',
'type' => 'text',
},
{
'key' => 'warning_email-cc',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
'type' => 'text',
},
{
'key' => 'warning_email-subject',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Subject: header for warning email',
'type' => 'text',
},
{
'key' => 'warning_email-mimetype',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'MIME type for warning email',
'type' => 'select',
'select_enum' => [ 'text/plain', 'text/html' ],
},
{
+ 'key' => 'impending_recur_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for alerts about first-time recurring billing.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'impending_recur_template',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Template file for alerts about looming first time recurrant billing. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitition language. Also see packages with a <a href="../browse/part_pkg.cgi">flat price plan</a> The following variables are available<ul><li><code>$packages</code> allowing <code>$packages->[0]</code> thru <code>$packages->[n]</code> <li><code>$package</code> the first package, same as <code>$packages->[0]</code> <li><code>$recurdates</code> allowing <code>$recurdates->[0]</code> thru <code>$recurdates->[n]</code> <li><code>$recurdate</code> the first recurdate, same as <code>$recurdate->[0]</code> <li><code>$first</code> <li><code>$last</code></ul>',
# <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
'type' => 'textarea',
use vars qw( @ISA @EXPORT_OK);
use Exporter;
-use FS::Record qw(qsearch);
+use FS::Record qw(qsearch qsearchs);
use FS::Conf;
use FS::cust_main;
use FS::Misc;
}
return if(!@customers);
foreach my $customer (@customers) {
+ next if !($customer->ncancelled_pkgs); # skip inactive customers
my $paydate = $customer->paydate;
next if $paydate =~ /^\s*$/; # skip empty expiration dates
if (grep { $expire_time < $_date + $_ &&
$expire_time > $_date + $_ - $window_time }
($warning_time, $urgent_time, $panic_time) ) {
+ # Send an expiration notice.
my $agentnum = $customer->agentnum;
- $mail_sender = $conf->config('invoice_from', $agentnum);
- $failure_recipient = $conf->config('invoice_from', $agentnum)
- || 'postmaster';
-
- my @alerter_template = $conf->config('alerter_template', $agentnum)
- or die 'cannot load config file alerter_template';
-
- my $alerter = new Text::Template(TYPE => 'ARRAY',
- SOURCE => [
- map "$_\n", @alerter_template
- ])
- or die "can't create Text::Template object: $Text::Template::ERROR";
-
- $alerter->compile()
- or die "can't compile template: $Text::Template::ERROR";
-
- my @packages = $customer->ncancelled_pkgs;
- if(@packages) {
+ my $error = '';
+
+ my $msgnum = $conf->config('alerter_msgnum', $agentnum);
+ if ( $msgnum ) { # new hotness
+ my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
+ $error = $msg_template->send('cust_main' => $customer);
+ }
+ else { #!$msgnum, the hard way
+ $mail_sender = $conf->config('invoice_from', $agentnum);
+ $failure_recipient = $conf->config('invoice_from', $agentnum)
+ || 'postmaster';
+
+ my @alerter_template = $conf->config('alerter_template', $agentnum)
+ or die 'cannot load config file alerter_template';
+
+ my $alerter = new Text::Template(TYPE => 'ARRAY',
+ SOURCE => [
+ map "$_\n", @alerter_template
+ ])
+ or die "can't create Text::Template object: $Text::Template::ERROR";
+
+ $alerter->compile()
+ or die "can't compile template: $Text::Template::ERROR";
+
my @invoicing_list = $customer->invoicing_list;
my @to_addrs = grep { $_ ne 'POST' } @invoicing_list;
if(@to_addrs) {
$fill_in{'payby'} = 'current method';
}
# Send it already!
- my $error = FS::Misc::send_email (
+ $error = FS::Misc::send_email (
from => $mail_sender,
to => [ @to_addrs ],
subject => 'Billing Arrangement Expiration',
body => [ $alerter->fill_in( HASH => \%fill_in ) ],
);
- die "can't send expiration alert: $error"
- if $error;
- }
- else { # if(@to_addrs)
- push @{$agent_failure_body{$customer->agentnum}},
- sprintf(qq{%5d %-32.32s %4s %10s %12s %12s},
- $custnum,
- $first . " " . $last . " " . $company,
- $payby,
- $paydate,
- $daytime,
- $night );
- }
- } # if(@packages)
+ }
+ else { # if(@to_addrs)
+ push @{$agent_failure_body{$customer->agentnum}},
+ sprintf(qq{%5d %-32.32s %4s %10s %12s %12s},
+ $custnum,
+ $first . " " . $last . " " . $company,
+ $payby,
+ $paydate,
+ $daytime,
+ $night );
+ }
+ } # if($msgnum)
+
+# should we die here rather than report failure as below?
+ die "can't send expiration alert: $error"
+ if $error;
+
} # if(expired)
} # foreach(@customers)
#we're at now now (and later).
my($time) = $^T;
+ my $conf = new FS::Conf;
+ my $error = '';
my $integer = driver_name =~ /^mysql/ ? 'SIGNED' : 'INTEGER';
push @cust_pkgs, $cust_pkg[0];
shift @cust_pkg;
}
- my $error =
- $cust_main->notify( 'impending_recur_template',
+ my $msgnum = $conf->config('impending_recur_msgnum',$cust_main->agentnum);
+ if ( $msgnum ) {
+ my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
+ $error = $msg_template->send($cust_main);
+ }
+ else {
+ $error = $cust_main->notify( 'impending_recur_template',
'extra_fields' => { 'packages' => \@packages,
'recurdates' => \@recurdates,
'package' => $packages[0],
'recurdate' => $recurdates[0],
},
);
+ } #if $msgnum
warn "Error notifying, custnum ". $cust_main->custnum. ": $error" if $error;
unless ($error) {
'mime_type', 'varchar', '', $char_d, '', '',
'body', 'blob', 'NULL', '', '', '',
'disabled', 'char', 'NULL', 1, '', '',
+ 'from_addr', 'varchar', 'NULL', 255, '', '',
],
'primary_key' => 'msgnum',
'unique' => [ ['msgname', 'mime_type'] ],
#default namespace
'payment_gateway' => [],
+ #migrate to templates
+ 'msg_template' => [],
+
;
\%hash;
&& ! grep { $transaction->error_message =~ /$_/ }
$conf->config('emaildecline-exclude')
) {
- my @templ = $conf->config('declinetemplate');
- my $template = new Text::Template (
- TYPE => 'ARRAY',
- SOURCE => [ map "$_\n", @templ ],
- ) or return "($perror) can't create template: $Text::Template::ERROR";
- $template->compile()
- or return "($perror) can't compile template: $Text::Template::ERROR";
-
- my $templ_hash = {
- 'company_name' =>
- scalar( $conf->config('company_name', $self->agentnum ) ),
- 'company_address' =>
- join("\n", $conf->config('company_address', $self->agentnum ) ),
- 'error' => $transaction->error_message,
- };
- my $error = send_email(
- 'from' => $conf->config('invoice_from', $self->agentnum ),
- 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
- 'subject' => 'Your payment could not be processed',
- 'body' => [ $template->fill_in(HASH => $templ_hash) ],
- );
+ # Send a decline alert to the customer.
+ my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
+ my $error = '';
+ if ( $msgnum ) {
+ my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
+ $error = $msg_template->send( 'cust_main' => $self );
+ }
+ else { #!$msgnum
+
+ my @templ = $conf->config('declinetemplate');
+ my $template = new Text::Template (
+ TYPE => 'ARRAY',
+ SOURCE => [ map "$_\n", @templ ],
+ ) or return "($perror) can't create template: $Text::Template::ERROR";
+ $template->compile()
+ or return "($perror) can't compile template: $Text::Template::ERROR";
+
+ my $templ_hash = {
+ 'company_name' =>
+ scalar( $conf->config('company_name', $self->agentnum ) ),
+ 'company_address' =>
+ join("\n", $conf->config('company_address', $self->agentnum ) ),
+ 'error' => $transaction->error_message,
+ };
+
+ my $error = send_email(
+ 'from' => $conf->config('invoice_from', $self->agentnum ),
+ 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
+ 'subject' => 'Your payment could not be processed',
+ 'body' => [ $template->fill_in(HASH => $templ_hash) ],
+ );
+ }
$perror .= " (also received error sending decline notification: $error)"
if $error;
=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
+Deprecated. Use event notification and message templates
+(L<FS::msg_template>) instead.
+
Sends a templated email notification to the customer (see L<Text::Template>).
OPTIONS is a hash and may include
my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
if ( !$options{'quiet'} && $conf->exists('emailcancel') && @invoicing_list ) {
- my $error = send_email(
- 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
- 'to' => \@invoicing_list,
- 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
- 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
- );
+ my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
+ my $error = '';
+ if ( $msgnum ) {
+ my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
+ $error = $msg_template->send( 'cust_main' => $self->cust_main,
+ 'object' => $self );
+ }
+ else {
+ $error = send_email(
+ 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
+ 'to' => \@invoicing_list,
+ 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
+ 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
+ );
+ }
#should this do something on errors?
}
my %labels;
#tie %labels, 'Tie::IxHash';
push @{ $labels{$_->[0]} }, $_->[1]
- foreach $self->h_labels(@_);
+ foreach $self->$method(@_);
my @labels;
foreach my $label ( keys %labels ) {
my %seen = ();
use FS::Conf;
use FS::Record qw( qsearch qsearchs );
+use Date::Format qw( time2str );
+use HTML::Entities qw( encode_entities) ;
+use vars '$DEBUG';
+
+$DEBUG=1;
+
=head1 NAME
FS::msg_template - Object methods for msg_template records
=item msgname
-msgname
+Template name.
=item agentnum
-agentnum
+Agent associated with this template. Can be NULL for a global template.
=item mime_type
-mime_type
+MIME type. Defaults to text/html.
+
+=item from_addr
+
+Source email address.
+
+=item subject
+
+The message subject line, in L<Text::Template> format.
=item body
-body
+The message body, as plain text or HTML, in L<Text::Template> format.
=item disabled
disabled
-
=back
=head1 METHODS
|| $self->ut_anything('subject')
|| $self->ut_anything('body')
|| $self->ut_enum('disabled', [ '', 'Y' ] )
+ || $self->ut_textn('from_addr')
;
return $error if $error;
+ my $body = $self->body;
+ $body =~ s/ / /g; # just in case these somehow get in
+ $self->body($body);
+
$self->mime_type('text/html') unless $self->mime_type;
$self->SUPER::check;
}
-=item send OPTION => VALUE, ...
+=item prepare OPTION => VALUE
-Fills in the template and emails it to the customer.
+Fills in the template and returns a hash of the 'from' address, 'to'
+addresses, subject line, and body.
Options are passed as a list of name/value pairs:
=cut
-sub send {
+sub prepare {
my( $self, %opt ) = @_;
my $cust_main = $opt{'cust_main'};
my $object = $opt{'object'};
+ warn "preparing template '".$self->msgname."' to cust#".$cust_main->custnum."\n"
+ if($DEBUG);
+
+ my $subs = $self->substitutions;
+
+ ###
+ # create substitution table
+ ###
+ my %hash;
+ foreach my $obj ($cust_main, $object || ()) {
+ foreach my $name (@{ $subs->{$obj->table} }) {
+ if(!ref($name)) {
+ # simple case
+ $hash{$name} = $obj->$name();
+ }
+ elsif( ref($name) eq 'ARRAY' ) {
+ # [ foo => sub { ... } ]
+ $hash{$name->[0]} = $name->[1]->($obj);
+ }
+ else {
+ warn "bad msg_template substitution: '$name'\n";
+ #skip it?
+ }
+ }
+ }
+ $_ = encode_entities($_) foreach values(%hash); # HTML escape
###
# fill-in
###
- my $subs = $self->substitutions;
-
- #XXX html escape this stuff
- my %hash = map { $_ => $cust_main->$_() } @{ $subs->{'cust_main'} };
- unless ( ! $object || $object->table eq 'cust_main' ) {
- %hash = ( %hash, map { $_ => $object->$_() } @{ $subs->{$object->table} } );
- }
-
my $subject_tmpl = new Text::Template (
TYPE => 'STRING',
SOURCE => $self->subject,
my $conf = new FS::Conf;
- send_email(
- generate_email(
- #XXX override from in event?
- 'from' => scalar( $conf->config('invoice_from', $cust_main->agentnum) ),
- 'to' => \@to,
- 'subject' => $subject,
- 'html_body' => $body,
- #XXX auto-make a text copy w/HTML::FormatText?
- # alas, us luddite mutt/pine users just aren't that big a deal
- )
+ (
+ 'from' => $self->from ||
+ scalar( $conf->config('invoice_from', $cust_main->agentnum) ),
+ 'to' => \@to,
+ 'subject' => $subject,
+ 'html_body' => $body,
+ #XXX auto-make a text copy w/HTML::FormatText?
+ # alas, us luddite mutt/pine users just aren't that big a deal
);
}
+=item send OPTION => VALUE
+
+Fills in the template and sends it to the customer. Options are as for
+'prepare'.
+
+=cut
+
+sub send {
+ my $self = shift;
+ send_email(generate_email($self->prepare(@_)));
+}
+
+# helper sub for package dates
+my $ymd = sub { $_[0] ? time2str('%Y-%m-%d', $_[0]) : '' };
+
#return contexts and fill-in values
+# If you add anything, be sure to add a description in
+# httemplate/edit/msg_template.html.
sub substitutions {
{ 'cust_main' => [qw(
display_custnum agentnum agent_name
balance
invoicing_list_emailonly
cust_status ucfirst_cust_status cust_statuscolor
- )],
- #XXX make these pretty: signupdate dundate paydate_monthyear usernum
- # next_bill_date
-
- 'cust_pkg' => [qw(
- )],
- #XXX these are going to take more pretty-ing up
+ signupdate dundate
+ ),
+ [ signupdate_ymd => sub { time2str('%Y-%m-%d', shift->signupdate) } ],
+ [ dundate_ymd => sub { time2str('%Y-%m-%d', shift->dundate) } ],
+ [ paydate_my => sub { sprintf('%02d/%04d', shift->paydate_monthyear) } ],
+ [ otaker_first => sub { shift->access_user->first } ],
+ [ otaker_last => sub { shift->access_user->last } ],
+ ],
+ # next_bill_date
+ 'cust_pkg' => [qw(
+ pkgnum pkg_label pkg_label_long
+ location_label
+ status statuscolor
+
+ start_date setup bill last_bill
+ adjourn susp expire
+ labels_short
+ ),
+ [ cancel => sub { shift->getfield('cancel') } ], # grrr...
+ [ start_ymd => sub { $ymd->(shift->getfield('start_date')) } ],
+ [ setup_ymd => sub { $ymd->(shift->getfield('setup')) } ],
+ [ next_bill_ymd => sub { $ymd->(shift->getfield('bill')) } ],
+ [ last_bill_ymd => sub { $ymd->(shift->getfield('last_bill')) } ],
+ [ adjourn_ymd => sub { $ymd->(shift->getfield('adjourn')) } ],
+ [ susp_ymd => sub { $ymd->(shift->getfield('susp')) } ],
+ [ expire_ymd => sub { $ymd->(shift->getfield('expire')) } ],
+ [ cancel_ymd => sub { $ymd->(shift->getfield('cancel')) } ],
+ ],
'cust_bill' => [qw(
invnum
)],
#XXX not really thinking about cust_bill substitutions quite yet
-
+
+ 'svc_acct' => [qw(
+ username
+ ),
+ [ password => sub { shift->getfield('_password') } ],
+ ], # for welcome messages
};
}
+sub _upgrade_data {
+ my ($self, %opts) = @_;
+
+ my @fixes = (
+ [ 'alerter_msgnum', 'alerter_template', '', '' ],
+ [ 'cancel_msgnum', 'cancelmessage', 'cancelsubject', '' ],
+ [ 'decline_msgnum', 'declinetemplate', '', '' ],
+ [ 'impending_recur_msgnum', 'impending_recur_template', '', '' ],
+ [ 'welcome_msgnum', 'welcome_email', 'welcome_email-subject', 'welcome_email-from' ],
+ [ 'warning_msgnum', 'warning_email', 'warning_email-subject', 'warning_email-from' ],
+ );
+
+ my $conf = new FS::Conf;
+ my @agentnums = ('', map {$_->agentnum} qsearch('agent', {}));
+ foreach my $agentnum (@agentnums) {
+ foreach (@fixes) {
+ my ($newname, $oldname, $subject, $from) = @$_;
+ if ($conf->exists($oldname, $agentnum)) {
+ my $new = new FS::msg_template({
+ 'msgname' => $oldname,
+ 'agentnum' => $agentnum,
+ 'from_addr' => ($from && $conf->config($from, $agentnum)) ||
+ $conf->config('invoice_from', $agentnum),
+ 'subject' => ($subject && $conf->config($subject, $agentnum)) || '',
+ 'mime_type' => 'text/html',
+ 'body' => join('<BR>',$conf->config($oldname, $agentnum)),
+ });
+ my $error = $new->insert;
+ die $error if $error;
+ $conf->set($newname, $new->msgnum, $agentnum);
+ $conf->delete($oldname, $agentnum);
+ $conf->delete($from, $agentnum) if $from;
+ $conf->delete($subject, $agentnum) if $subject;
+ }
+ }
+ }
+}
+
=back
=head1 BUGS
}
#welcome email
- my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
- = ('','','','','','');
-
- if ( $conf->exists('welcome_email', $agentnum) ) {
- $welcome_template = new Text::Template (
- TYPE => 'ARRAY',
- SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
- ) or warn "can't create welcome email template: $Text::Template::ERROR";
- $welcome_from = $conf->config('welcome_email-from', $agentnum);
- # || 'your-isp-is-dum'
- $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
- || 'Welcome';
- $welcome_subject_template = new Text::Template (
- TYPE => 'STRING',
- SOURCE => $welcome_subject,
- ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
- $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
- || 'text/plain';
+ my $error = '';
+ my $msgnum = $conf->config('welcome_msgnum', $agentnum);
+ if ( $msgnum ) {
+ my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
+ $error = $msg_template->send('cust_main' => $cust_main);
}
- if ( $welcome_template && $cust_pkg ) {
- my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
- if ( $to ) {
-
- my %hash = (
- 'custnum' => $self->custnum,
- 'username' => $self->username,
- 'password' => $self->_password,
- 'first' => $cust_main->first,
- 'last' => $cust_main->getfield('last'),
- 'pkg' => $cust_pkg->part_pkg->pkg,
- );
- my $wqueue = new FS::queue {
- 'svcnum' => $self->svcnum,
- 'job' => 'FS::svc_acct::send_email'
- };
- my $error = $wqueue->insert(
- 'to' => $to,
- 'from' => $welcome_from,
- 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
- 'mimetype' => $welcome_mimetype,
- 'body' => $welcome_template->fill_in( HASH => \%hash, ),
- );
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return "error queuing welcome email: $error";
- }
+ else { #!$msgnum
+ my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
+ = ('','','','','','');
+
+ if ( $conf->exists('welcome_email', $agentnum) ) {
+ $welcome_template = new Text::Template (
+ TYPE => 'ARRAY',
+ SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
+ ) or warn "can't create welcome email template: $Text::Template::ERROR";
+ $welcome_from = $conf->config('welcome_email-from', $agentnum);
+ # || 'your-isp-is-dum'
+ $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
+ || 'Welcome';
+ $welcome_subject_template = new Text::Template (
+ TYPE => 'STRING',
+ SOURCE => $welcome_subject,
+ ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
+ $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
+ || 'text/plain';
+ }
+ if ( $welcome_template ) {
+ my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
+ if ( $to ) {
+
+ my %hash = (
+ 'custnum' => $self->custnum,
+ 'username' => $self->username,
+ 'password' => $self->_password,
+ 'first' => $cust_main->first,
+ 'last' => $cust_main->getfield('last'),
+ 'pkg' => $cust_pkg->part_pkg->pkg,
+ );
+ my $wqueue = new FS::queue {
+ 'svcnum' => $self->svcnum,
+ 'job' => 'FS::svc_acct::send_email'
+ };
+ my $error = $wqueue->insert(
+ 'to' => $to,
+ 'from' => $welcome_from,
+ 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
+ 'mimetype' => $welcome_mimetype,
+ 'body' => $welcome_template->fill_in( HASH => \%hash, ),
+ );
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "error queuing welcome email: $error";
+ }
- if ( $options{'depend_jobnum'} ) {
- warn "$me depend_jobnum found; adding to welcome email dependancies"
- if $DEBUG;
- if ( ref($options{'depend_jobnum'}) ) {
- warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
- "to welcome email dependancies"
+ if ( $options{'depend_jobnum'} ) {
+ warn "$me depend_jobnum found; adding to welcome email dependancies"
if $DEBUG;
- push @jobnums, @{ $options{'depend_jobnum'} };
- } else {
- warn "$me adding job $options{'depend_jobnum'} ".
- "to welcome email dependancies"
- if $DEBUG;
- push @jobnums, $options{'depend_jobnum'};
+ if ( ref($options{'depend_jobnum'}) ) {
+ warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
+ "to welcome email dependancies"
+ if $DEBUG;
+ push @jobnums, @{ $options{'depend_jobnum'} };
+ } else {
+ warn "$me adding job $options{'depend_jobnum'} ".
+ "to welcome email dependancies"
+ if $DEBUG;
+ push @jobnums, $options{'depend_jobnum'};
+ }
}
- }
- foreach my $jobnum ( @jobnums ) {
- my $error = $wqueue->depend_insert($jobnum);
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return "error queuing welcome email job dependancy: $error";
+ foreach my $jobnum ( @jobnums ) {
+ my $error = $wqueue->depend_insert($jobnum);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "error queuing welcome email job dependancy: $error";
+ }
}
- }
- }
-
- }
+ }
- } # if ( $cust_pkg )
+ } # if $welcome_template
+ } # if !$msgnum
+ } # if $cust_pkg
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
''; #no error
my @deleteable = qw( invoice_latexreturnaddress invoice_htmlreturnaddress );
my %deleteable = map { $_ => 1 } @deleteable;
-my @sections = qw(required billing invoicing UI self-service username password session shell BIND );
+my @sections = qw(required billing invoicing notification UI self-service username password session shell BIND );
push @sections, '', 'deprecated';
my %section_items = ();
<% include( 'elements/edit.html',
+ 'html_init' => '<TABLE id="outerTable"><TR><TD>',
'name_singular' => 'template',
'table' => 'msg_template',
'viewall_dir' => 'browse',
+ 'agent_virt' => 1,
+ 'agent_null' => 1,
+ 'agent_null_right' => 'Edit global templates',
+
'fields' => [ 'msgname',
'subject',
+ 'from_addr',
{ field=>'body', type=>'htmlarea', width=>763 },
],
- 'labels' => { 'msgnum' => 'Template',
- 'msgname' => 'Template name',
- 'subject' => 'Message subject',
- 'body' => 'Message template',
+ 'labels' => { 'msgnum' => 'Template',
+ 'msgname' => 'Template name',
+ 'from_addr' => 'Return address',
+ 'subject' => 'Message subject',
+ 'body' => 'Message template',
},
+ 'html_foot' => "</TD>$sidebar</TR></TABLE>",
)
%>
<%init>
|| $FS::CurrentUser::CurrentUser->access_right('Edit global templates')
|| $FS::CurrentUser::CurrentUser->access_right('Configuration');
+# Create hints pane
+
+my %substitutions = (
+ 'cust_main' => [
+ '$display_custnum'=> 'Customer#',
+ '$agentnum' => 'Agent#',
+ '$agent_name' => 'Agent name',
+ '$payby' => 'Payment method',
+ '$paymask' => 'Card/account# (masked)',
+ '$payname' => 'Name on card/bank name',
+ '$paytype' => 'Account type',
+ '$payip' => 'IP address used to submit payment info',
+ '$num_ncancelled_pkgs' => '# of active packages',
+ '$num_cancelled_pkgs' => '# of cancelled packages',
+ '$num_pkgs' => '# of packages',
+ '$classname' => 'Customer class',
+ '$categoryname' => 'Customer category',
+ '$balance' => 'Current balance',
+ '$invoicing_list_emailonly' => 'Billing email address',
+ '$cust_status' => 'Status',
+ '$ucfirst_cust_status' => 'Status, capitalized',
+ '$cust_statuscolor' => 'Status color code',
+ ],
+ 'contact' => [ # duplicate this for shipping
+ '$name' => 'Company and contact name',
+ '$name_short' => 'Company or contact name',
+ '$company' => 'Company name',
+ '$contact' => 'Contact name (last, first)',
+ '$contact_firstlast'=> 'Contact name (first last)',
+ '$first' => 'First name',
+ '$last' => 'Last name',
+ '$address1' => 'Address line 1',
+ '$address2' => 'Address line 2',
+ '$city' => 'City',
+ '$county' => 'County',
+ '$state' => 'State',
+ '$zip' => 'Zip',
+ '$country' => 'Country',
+ '$daytime' => 'Day phone',
+ '$night' => 'Night phone',
+ '$fax' => 'Fax',
+ ],
+ 'cust_bill' => [
+ '$invnum' => 'Invoice#',
+ ],
+ 'cust_pkg' => [
+ '$pkgnum' => 'Package#',
+ '$pkg_label' => 'Package label (short)',
+ '$pkg_label_long' => 'Package label (long)',
+ '$status' => 'Status',
+ '$statuscolor' => 'Status color code',
+ '$start_ymd' => 'Start date',
+ '$setup_ymd' => 'Setup date',
+ '$last_bill_ymd' => 'Last bill date',
+ '$next_bill_ymd' => 'Next bill date',
+ '$susp_ymd' => 'Suspended on date',
+ '$cancel_ymd' => 'Canceled on date',
+ '$adjourn_ymd' => 'Adjournment date',
+ '$expire_ymd' => 'Expiration date',
+ '$labels_short' => 'Service labels',
+ '$location_label' => 'Service location',
+ ],
+ 'svc_acct' => [
+ '$username' => 'Login name',
+ '$password' => 'Password',
+ ],
+);
+my @c = @{ $substitutions{'contact'} };
+for (my $i=0; $i<scalar(@c); $i += 2) {
+ $c[$i] =~ s/\$(.*)/\$ship_$1/;
+}
+$substitutions{'shipping'} = \@c;
+
+tie my %sections, 'Tie::IxHash', (
+'contact' => 'Name and contact info (billing)',
+'shipping' => 'Name and contact info (shipping)',
+'cust_main' => 'Customer status and payment info',
+'cust_pkg' => 'Package fields',
+'cust_bill' => 'Invoice fields',
+'svc_acct' => 'Login service fields',
+);
+
+my $widget = new HTML::Widgets::SelectLayers(
+ 'options' => \%sections,
+ 'form_name' => 'dummy',
+ 'html_between'=>'</FORM><FONT SIZE=-1>',
+ 'selected_layer'=>(keys(%sections))[0],
+ 'layer_callback' => sub {
+ my $section = shift;
+ my $html = include('/elements/table-grid.html');
+ my @hints = @{ $substitutions{$section} };
+ while(@hints) {
+ my $key = shift @hints;
+ $html .= qq!\n<TR><TD><A href="javascript:insertHtml('{$key}')">$key</A></TD>!;
+ $html .= "\n<TD>".shift(@hints).'</TD></TR>';
+ }
+ $html .= "\n</TABLE>";
+ return $html;
+ },
+);
+
+my $sidebar = '
+<SCRIPT TYPE="text/javascript">
+function insertHtml(what) {
+ var oEditor = FCKeditorAPI.GetInstance("body");
+ oEditor.InsertHtml(what);
+};
+</SCRIPT>
+<TD valign="top"><FORM name="dummy">
+Substitutions: '
+. $widget->html .
+'<BR>Click links to insert.
+<BR>Enclose substitutions and other Perl expressions in braces:
+<BR>{ $name } = ExampleCo (Smith, John)
+<BR>{ time2str("%D", time) } = '.time2str("%D", time).'
+</FONT></TD>
+';
+
</%init>
projects / freeside.git / commitdiff