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
10 an alternate initial form while using this for search freezing/thawing and
11 preview/send actions, with the following options:
13 acl - the access right to use (defaults to 'Bulk send customer notices')
15 form_action - the URL to submit the form to
17 process_url - the URL for starting the JSRPC process
19 title - the title of the page
21 no_search_fields - arrayref of additional fields that are not search parameters
23 alternate_form - subroutine that returns alternate html for the initial form,
24 replaces msgnum/from/subject/html_body/action inputs and submit button,
25 not used if an action is specified
27 post_search_hook - sub hook for additional processing after search has been processed from cgi,
28 gets passed options 'conf' and 'search' (a reference to the unfrozen %search hash),
29 should be used to set msgnum or from/subject/html_body cgi params
34 <% include('/elements/header-popup.html', $title) %>
36 <% include('/elements/header.html', $title) %>
40 <FORM NAME="OneTrueForm" ACTION="<% $form_action %>" METHOD="POST">
41 <INPUT TYPE="hidden" NAME="table" VALUE="<% $table %>">
42 %# Mixing search params with from address, subject, etc. required special-case
43 %# handling of those, risked name conflicts, and caused massive problems with
44 %# multi-valued search params. We are no longer in search context, so we
45 %# pack the search into a Storable string for later use.
46 <INPUT TYPE="hidden" NAME="search" VALUE="<% encode_base64(nfreeze(\%search)) %>">
47 <INPUT TYPE="hidden" NAME="popup" VALUE="<% $popup %>">
48 <INPUT TYPE="hidden" NAME="url" VALUE="<% $url | h %>">
49 <INPUT TYPE="hidden" NAME="custnum" VALUE="<% scalar($cgi->param('custnum')) |h %>">
51 % if ( $cgi->param('action') eq 'send' ) {
53 <INPUT TYPE="hidden" NAME="to_contact_classnum" VALUE="<% $cgi->param('to_contact_classnum') %>">
54 <FONT SIZE="+2">Sending notice</FONT>
56 <& /elements/progress-init.html,
58 [ qw( search table from subject html_body text_body
59 msgnum to_contact_classnum emailtovoice_contact custnum ) ],
64 % } elsif ( $cgi->param('action') eq 'preview' ) {
65 <INPUT TYPE="hidden" NAME="to_contact_classnum" VALUE="<% join(',', @contact_classnum) %>">
66 <FONT SIZE="+2">Preview notice</FONT>
70 % if ( $cgi->param('action') ) {
72 <TABLE BGCOLOR="#cccccc" CELLSPACING=0>
73 <INPUT TYPE="hidden" NAME="msgnum" VALUE="<% scalar($cgi->param('msgnum')) %>">
74 <INPUT TYPE="hidden" NAME="emailtovoice_contact" VALUE="<% scalar $cgi->param('emailtovoice_contact') |h %>">
75 % if ( $msg_template ) {
76 <% include('/elements/tr-fixed.html',
77 'label' => 'Template:',
78 'value' => $msg_template->msgname,
83 <% include('/elements/tr-fixed.html',
90 <& /elements/tr-td-label.html, 'label' => 'To contacts:' &>
91 <td><% join('<BR>', @contact_classname) %></td>
94 <% include('/elements/tr-fixed.html',
96 'label' => 'Subject:',
101 <INPUT TYPE="hidden" NAME="html_body" VALUE="<% $html_body |h %>">
103 <TH ALIGN="right" VALIGN="top">Message (HTML display): </TD>
104 <TD CLASS="background" ALIGN="left"><% $html_body %></TD>
107 % my $text_body = HTML::FormatText->new(leftmargin=>0)->format(
108 % HTML::TreeBuilder->new_from_content(
112 <INPUT TYPE="hidden" NAME="text_body" VALUE="<% $text_body |h %>">
114 <TH ALIGN="right" VALIGN="top">Message (Text display): </TD>
115 <TD CLASS="background" STYLE="background-color:white" ALIGN="left">
116 <a href="javascript:void(0)" onclick="this.style.display='none'; document.getElementById('email-message-text').style.display=''">click to view</a>
117 <PRE id="email-message-text" style="display: none;"><% $text_body %></PRE>
123 % if ( $cgi->param('action') eq 'preview' ) {
126 function areyousure(href) {
127 return confirm("Send this notice to <% ($num_cust > 1) ? "$num_cust customers" : '1 customer' %> ?");
132 <INPUT TYPE="hidden" NAME="action" VALUE="send">
133 <INPUT TYPE="submit" VALUE="Send notice" onClick="return areyousure()">
137 % } elsif ($opt{'alternate_form'}) {
139 <% &{$opt{'alternate_form'}}() %>
143 <SCRIPT TYPE="text/javascript">
144 function toggle(obj) {
145 document.getElementById('table_no_template').style.display = (obj.value == 0) ? '' : 'none';
150 <& /elements/select-msg_template.html,
151 onchange => 'toggle(this)',
154 % # select destination contact classes
155 <TABLE CELLSPACING=0 id="send_to_contacts_table">
157 <TD>Send to contacts:</TD>
159 <div id="contactclassesdiv">
160 <& /elements/checkboxes.html,
161 'style' => 'display: inline; vertical-align: top',
162 'disable_links' => 1,
163 'names_list' => \@contact_checkboxes,
164 'element_name_prefix' => 'contact_class_',
165 'checked_callback' => sub {
166 my($cgi, $name) = @_;
167 $name eq 'invoice' #others default to unchecked
171 % if ($send_to_domain) {
173 <INPUT TYPE="checkbox" NAME="emailtovoice" ID="emailtovoice" VALUE="ON" onclick="toggleDiv(this)">Email to voice
175 <div id="emailtovoicediv" style="display:none">
177 <& /elements/select-cust_phone.html,
178 'cust_num' => $cgi->param('custnum'),
179 'field_name' => 'emailtovoice_contact',
180 'format' => 'xxxxxxxxxx',
181 'phone_types' => [ 'daytime', 'night', 'fax', 'mobile' ],
182 &>@<% $send_to_domain |h %>
189 % # if sending a one-off message, show a form to edit it
190 <TABLE BGCOLOR="#cccccc" CELLSPACING=0 WIDTH="100%" id="table_no_template">
191 <& /elements/tr-td-label.html, 'label' => 'From:' &>
192 <TD><& /elements/input-text.html,
193 'field' => 'from_name',
194 'value' => $conf->config('invoice_from_name', $agent_virt_agentnum) ||
195 $conf->config('company_name', $agent_virt_agentnum), #?
198 <& /elements/input-text.html,
199 'field' => 'from_addr',
200 'type' => 'email', # HTML5, woot
201 'value' => $conf->config('invoice_from', $agent_virt_agentnum),
205 <& /elements/tr-input-text.html,
206 'field' => 'subject',
207 'label' => 'Subject:',
212 <TD ALIGN="right" VALIGN="top" STYLE="padding-top:3px">Message: </TD>
213 <TD><& /elements/htmlarea.html,
214 'field' => 'html_body',
224 <INPUT TYPE="hidden" NAME="action" VALUE="preview">
225 <INPUT TYPE="hidden" NAME="custnum" VALUE="<% scalar($cgi->param('custnum')) |h %>">
226 <INPUT TYPE="submit" VALUE="Preview notice">
228 % } #end not action or alternate form
232 % if ( $cgi->param('action') eq 'send' ) {
233 <SCRIPT TYPE="text/javascript">
238 <SCRIPT TYPE="text/javascript">
239 function toggleDiv(obj) {
240 var box_contactclasses = document.getElementById('contactclassesdiv');
241 var box_emailtovoice = document.getElementById('emailtovoicediv');
243 box_emailtovoice.style.display = (box_emailtovoice.style.display == 'none') ? 'block' : 'none';
244 document.getElementById('emailtovoice_contact').options[0].selected=true;
246 box_contactclasses.style.display = (box_contactclasses.style.display == 'none') ? 'block' : 'none';
250 <& /elements/footer.html &>
256 $opt{'acl'} ||= 'Bulk send customer notices';
261 unless $FS::CurrentUser::CurrentUser->access_right($opt{'acl'});
263 my $conf = FS::Conf->new;
264 my @no_search_fields = qw( action table from subject html_body text_body popup url );
266 my $send_to_domain = $conf->config('email-to-voice_domain');
268 my $form_action = $opt{'form_action'} || 'email-customers.html';
269 my $process_url = $opt{'process_url'} || 'process/email-customers.html';
270 my $title = $opt{'title'} || 'Send customer notices';
271 push( @no_search_fields, @{$opt{'no_search_fields'}} ) if $opt{'no_search_fields'};
273 $m->comp('/elements/handle_uri_query');
275 my $table = $cgi->param('table') or die "'table' required";
276 my $agent_virt_agentnum = $cgi->param('agent_virt_agentnum') || '';
278 my $popup = $cgi->param('popup');
279 my $url = $cgi->param('url');
280 if (!$url && $cgi->param('custnum')) { $url = $fsurl."view/cust_main.cgi?".$cgi->param('custnum'); }
281 my $pdest = { 'message' => "Notice sent" };
282 $pdest->{'url'} = $cgi->param('url') if $url;
285 if ( $cgi->param('search') ) {
286 %search = %{ thaw(decode_base64( $cgi->param('search') )) };
289 %search = $cgi->Vars;
290 delete $search{$_} for @no_search_fields;
291 # FS::$table->search is expected to know which parameters might be
292 # multi-valued, and to accept scalar values for them also. No good
293 # solution to this since CGI can't tell whether a parameter _might_
294 # have had multiple values, only whether it does.
295 @search{keys %search} = map { /\0/ ? [ split /\0/, $_ ] : $_ } values %search;
298 &{$opt{'post_search_hook'}}(
300 'search' => \%search,
301 ) if $opt{'post_search_hook'};
305 if ( $cgi->param('from') ) {
306 $from = $cgi->param('from');
307 } elsif ( $cgi->param('from_name') ) {
308 $from = ($cgi->param('from_name') . ' <' . $cgi->param('from_addr') . '>');
309 } elsif ( $cgi->param('from_addr') ) {
310 $from = $cgi->param('from_addr');
313 my $subject = $cgi->param('subject') || '';
314 my $html_body = $cgi->param('html_body') || '';
316 my @contact_classnum;
317 my @contact_classname;
319 my $subject = $cgi->param('subject');
320 my $body = $cgi->param('body');
322 my $msg_template = '';
324 if ( $cgi->param('action') eq 'preview' ) {
326 my $sql_query = "FS::$table"->search(\%search);
327 my $count_query = delete($sql_query->{'count_query'});
328 my $count_sth = dbh->prepare($count_query)
329 or die "Error preparing $count_query: ". dbh->errstr;
331 or die "Error executing $count_query: ". $count_sth->errstr;
332 my $count_arrayref = $count_sth->fetchrow_arrayref;
333 $num_cust = $count_arrayref->[0];
335 if ( $cgi->param('msgnum') ) {
336 $msg_template = qsearchs('msg_template',
337 { msgnum => scalar($cgi->param('msgnum')) } )
338 or die "template not found: ".$cgi->param('msgnum');
339 $sql_query->{'extra_sql'} .= ' LIMIT 1';
340 $sql_query->{'select'} = "$table.*";
341 $sql_query->{'order_by'} = '';
342 my $object = qsearchs($sql_query);
343 my $cust = $object->cust_main;
345 'cust_main' => $cust,
348 my %message = $msg_template->prepare(%msgopts);
349 ($from, $subject, $html_body) = @message{'from', 'subject', 'html_body'};
353 if ($cgi->param('action')) {
355 # contact_class_X params in preview
356 if ($cgi->param('emailtovoice_contact')) {
357 $email_to = $cgi->param('emailtovoice_contact') . '@' . $send_to_domain;
358 push @contact_classnum, 'emailtovoice';
359 push @contact_classname, $email_to;
361 elsif ($cgi->param('to_contact_classnum')) {
362 foreach my $c (split(/,/, $cgi->param('to_contact_classnum'))) {
363 push @contact_classnum, $c;
364 if ( $c eq 'invoice' ) {
365 push @contact_classname, 'Invoice recipients';
367 my $contact_class = FS::contact_class->by_key($c);
368 push @contact_classname, encode_entities($contact_class->classname);
373 foreach my $param ( $cgi->param ) {
374 if ( $param =~ /^contact_class_(\w+)$/ ) {
375 push @contact_classnum, $1;
376 if ( $1 eq 'invoice' ) {
377 push @contact_classname, 'Invoice recipients';
379 my $contact_class = FS::contact_class->by_key($1);
380 push @contact_classname, encode_entities($contact_class->classname);
388 # and set up contact checkboxes for edit mode
389 my @contact_checkboxes = (
390 [ 'invoice' => { label => 'Invoice recipients' } ]
393 foreach my $class (qsearch('contact_class', { disabled => '' })) {
394 push @contact_checkboxes, [
396 { label => $class->classname }