3 Allows emailing one or more customers, based on a search for customers. Search can
4 be specified either through cust_main fields as cgi params, or through a base64 encoded
5 frozen hash in the 'search' cgi param. Form allows selecting an existing msg_template,
6 or creating a custom message, and shows a preview of the message before sending.
7 If linked to as a popup, include the cgi parameter 'popup' for proper header handling.
9 This may also be used as an element in other pages, enabling you to provide an
10 alternate initial form while using this for search freezing/thawing and
11 preview/send actions, with the following options:
13 form_action - the URL to submit the form to
15 title - the title of the page
17 no_search_fields - arrayref of additional fields that are not search parameters
19 alternate_form - subroutine that returns alternate html for the initial form,
20 replaces msgnum/from/subject/html_body/action inputs and submit button,
21 not used if an action is specified
23 post_search_hook - sub hook for additional processing after search has been processed from cgi,
24 gets passed options 'conf' and 'search' (a reference to the unfrozen %search hash),
25 should be used to set msgnum or from/subject/html_body cgi params
30 <% include('/elements/header-popup.html', $title) %>
32 <% include('/elements/header.html', $title) %>
36 <FORM NAME="OneTrueForm" ACTION="<% $form_action %>" METHOD="POST">
37 <INPUT TYPE="hidden" NAME="table" VALUE="<% $table %>">
38 %# Mixing search params with from address, subject, etc. required special-case
39 %# handling of those, risked name conflicts, and caused massive problems with
40 %# multi-valued search params. We are no longer in search context, so we
41 %# pack the search into a Storable string for later use.
42 <INPUT TYPE="hidden" NAME="search" VALUE="<% encode_base64(nfreeze(\%search)) %>">
43 <INPUT TYPE="hidden" NAME="popup" VALUE="<% $popup %>">
44 <INPUT TYPE="hidden" NAME="url" VALUE="<% $url | h %>">
46 % if ( $cgi->param('action') eq 'send' ) {
48 <FONT SIZE="+2">Sending notice</FONT>
50 <% include('/elements/progress-init.html',
52 [ qw( search table from subject html_body text_body msgnum ) ],
53 'process/email-customers.html',
58 % } elsif ( $cgi->param('action') eq 'preview' ) {
60 <FONT SIZE="+2">Preview notice</FONT>
64 % if ( $cgi->param('action') ) {
66 <TABLE BGCOLOR="#cccccc" CELLSPACING=0>
67 <INPUT TYPE="hidden" NAME="msgnum" VALUE="<% $cgi->param('msgnum') %>">
69 % if ( $msg_template ) {
70 <% include('/elements/tr-fixed.html',
71 'label' => 'Template:',
72 'value' => $msg_template->msgname,
77 <% include('/elements/tr-fixed.html',
80 'value' => scalar( $from ),
84 <% include('/elements/tr-fixed.html',
86 'label' => 'Subject:',
87 'value' => scalar( $subject ),
91 <INPUT TYPE="hidden" NAME="html_body" VALUE="<% $html_body |h %>">
93 <TD ALIGN="right" VALIGN="top">Message (HTML display): </TD>
94 <TD CLASS="background" ALIGN="left"><% $html_body %></TD>
97 % my $text_body = HTML::FormatText->new(leftmargin=>0)->format(
98 % HTML::TreeBuilder->new_from_content(
102 <INPUT TYPE="hidden" NAME="text_body" VALUE="<% $text_body |h %>">
104 <TD ALIGN="right" VALIGN="top">Message (Text display): </TD>
105 <TD CLASS="background" STYLE="background-color:white" ALIGN="left"><PRE><% $text_body %></PRE></TD>
110 % if ( $cgi->param('action') eq 'preview' ) {
113 function areyousure(href) {
114 return confirm("Send this notice to <% ($num_cust > 1) ? "$num_cust customers" : '1 customer' %> ?");
119 <INPUT TYPE="hidden" NAME="action" VALUE="send">
120 <INPUT TYPE="submit" VALUE="Send notice" onClick="return areyousure()">
124 % } elsif ($opt{'alternate_form'}) {
126 <% &{$opt{'alternate_form'}}() %>
130 <SCRIPT TYPE="text/javascript">
131 function toggle(obj) {
132 document.getElementById('table_no_template').style.display = (obj.value == 0) ? '' : 'none';
137 <& /elements/select-msg_template.html,
138 onchange => 'toggle(this)',
141 <TABLE BGCOLOR="#cccccc" CELLSPACING=0 WIDTH="100%" id="table_no_template">
142 <& /elements/tr-td-label.html, 'label' => 'From:' &>
143 <TD><& /elements/input-text.html,
144 'field' => 'from_name',
145 'value' => $conf->config('invoice_from_name', $agent_virt_agentnum) ||
146 $conf->config('company_name', $agent_virt_agentnum), #?
149 <& /elements/input-text.html,
150 'field' => 'from_addr',
151 'type' => 'email', # HTML5, woot
152 'value' => $conf->config('invoice_from', $agent_virt_agentnum),
156 <% include('/elements/tr-input-text.html',
157 'field' => 'subject',
158 'label' => 'Subject:',
164 <TD ALIGN="right" VALIGN="top" STYLE="padding-top:3px">Message: </TD>
165 <TD><& /elements/htmlarea.html,
166 'field' => 'html_body',
176 <INPUT TYPE="hidden" NAME="action" VALUE="preview">
177 <INPUT TYPE="submit" VALUE="Preview notice">
179 % } #end not action or alternate form
183 % if ( $cgi->param('action') eq 'send' ) {
184 <SCRIPT TYPE="text/javascript">
189 <% include('/elements/footer.html') %>
196 unless $FS::CurrentUser::CurrentUser->access_right('Bulk send customer notices');
198 my $conf = FS::Conf->new;
199 my @no_search_fields = qw( action table from subject html_body text_body popup url );
201 my $form_action = $opt{'form_action'} || 'email-customers.html';
202 my $title = $opt{'title'} || 'Send customer notices';
203 push( @no_search_fields, @{$opt{'no_search_fields'}} ) if $opt{'no_search_fields'};
205 my $table = $cgi->param('table') or die "'table' required";
206 my $agent_virt_agentnum = $cgi->param('agent_virt_agentnum') || '';
208 my $popup = $cgi->param('popup');
209 my $url = $cgi->param('url');
210 my $pdest = { 'message' => "Notice sent" };
211 $pdest->{'url'} = $cgi->param('url') if $url;
214 if ( $cgi->param('search') ) {
215 %search = %{ thaw(decode_base64($cgi->param('search'))) };
218 %search = $cgi->Vars;
219 delete $search{$_} for @no_search_fields;
220 # FS::$table->search is expected to know which parameters might be
221 # multi-valued, and to accept scalar values for them also. No good
222 # solution to this since CGI can't tell whether a parameter _might_
223 # have had multiple values, only whether it does.
224 @search{keys %search} = map { /\0/ ? [ split /\0/, $_ ] : $_ } values %search;
227 &{$opt{'post_search_hook'}}(
229 'search' => \%search,
230 ) if $opt{'post_search_hook'};
234 if ( $cgi->param('from') ) {
235 $from = $cgi->param('from');
236 } elsif ( $cgi->param('from_name') ) {
237 $from = ($cgi->param('from_name') . ' <' . $cgi->param('from_addr') . '>');
238 } elsif ( $cgi->param('from_addr') ) {
239 $from = $cgi->param('from_addr');
242 my $subject = $cgi->param('subject') || '';
243 my $html_body = $cgi->param('html_body') || '';
245 my $msg_template = '';
247 if ( $cgi->param('action') eq 'preview' ) {
249 my $sql_query = "FS::$table"->search(\%search);
250 my $count_query = delete($sql_query->{'count_query'});
251 my $count_sth = dbh->prepare($count_query)
252 or die "Error preparing $count_query: ". dbh->errstr;
254 or die "Error executing $count_query: ". $count_sth->errstr;
255 my $count_arrayref = $count_sth->fetchrow_arrayref;
256 $num_cust = $count_arrayref->[0];
258 if ( $cgi->param('msgnum') ) {
259 $msg_template = qsearchs('msg_template',
260 { msgnum => $cgi->param('msgnum') } )
261 or die "template not found: ".$cgi->param('msgnum');
262 $sql_query->{'extra_sql'} .= ' LIMIT 1';
263 $sql_query->{'select'} = "$table.*";
264 $sql_query->{'order_by'} = '';
265 my $object = qsearchs($sql_query);
266 my $cust = $object->cust_main;
268 'cust_main' => $cust,
271 my %message = $msg_template->prepare(%msgopts);
272 ($from, $subject, $html_body) = @message{'from', 'subject', 'html_body'};