1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
package FS::cust_msg;
use base qw( FS::cust_main_Mixin FS::Record );
use strict;
use FS::Record qw( dbh );
use MIME::Parser;
=head1 NAME
FS::cust_msg - Object methods for cust_msg records
=head1 SYNOPSIS
use FS::cust_msg;
$record = new FS::cust_msg \%hash;
$record = new FS::cust_msg { 'column' => 'value' };
$error = $record->insert;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_msg object represents an email message generated by Freeside.
FS::cust_msg inherits from FS::Record. The following fields are currently
supported:
=over 4
=item custmsgnum - primary key
=item custnum - customer number
=item msgnum - template number
=item msgtype - the message type
=item _date - the time the message was sent
=item env_from - envelope From address
=item env_to - envelope To addresses, including Bcc, separated by newlines
=item header - message header
=item body - message body (as a complete MIME document)
=item preview - HTML fragment to show as a preview of the message
=item error - Email::Sender error message (or null for success)
=item status - "prepared", "sent", or "failed"
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'cust_msg'; }
sub nohistory_fields { ('header', 'body'); }
# history is kind of pointless on this table
our @statuses = qw( prepared sent failed );
=item insert
Adds this record to the database. If there is an error, returns the error
and emits a warning; otherwise returns false.
=cut
sub insert {
# warn of all errors here; failing to insert/update one of these should
# cause a warning at worst
my $self = shift;
my $error = $self->SUPER::insert;
warn "[cust_msg] error logging message status: $error\n" if $error;
return $error;
}
=item delete
Delete this record from the database. There's no reason to do this.
=cut
sub delete {
my $self = shift;
warn "[cust_msg] log entry deleted\n";
return $self->SUPER::delete;
}
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error and emits a warning, otherwise returns false.
=cut
sub replace {
my $self = shift;
my $error = $self->SUPER::replace(@_);
warn "[cust_msg] error logging message status: $error\n" if $error;
return $error;
}
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('custmsgnum')
|| $self->ut_numbern('custnum')
|| $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
|| $self->ut_numbern('msgnum')
|| $self->ut_foreign_keyn('msgnum', 'msg_template', 'msgnum')
|| $self->ut_numbern('_date')
|| $self->ut_textn('env_from')
|| $self->ut_textn('env_to')
|| $self->ut_anything('header')
|| $self->ut_anything('body')
|| $self->ut_anything('preview')
|| $self->ut_enum('status', \@statuses)
|| $self->ut_textn('error')
|| $self->ut_enum('msgtype', [ '',
'invoice',
'receipt',
'admin',
'report',
])
;
return $error if $error;
$self->SUPER::check;
}
=item send
Sends the message through its parent L<FS::msg_template>. Returns an error
message on error, or an empty string.
=cut
sub send {
my $self = shift;
# it's still allowed to have cust_msgs without message templates, but only
# for email.
my $msg_template = $self->msg_template || 'FS::msg_template::email';
$msg_template->send_prepared($self);
}
=item entity
Returns the complete message as a L<MIME::Entity>.
XXX this only works if the message in fact contains a MIME entity. Messages
created by external APIs may not look like that.
=item parts
Returns a list of the MIME parts contained in the message, as L<MIME::Entity>
objects.
=cut
sub entity {
my $self = shift;
if ( !exists($self->{entity}) ) {
my $parser = MIME::Parser->new;
my $output_dir = "$FS::UID::cache_dir/cache.$FS::UID::datasrc/mimeparts";
mkdir($output_dir) unless -d $output_dir;
$parser->output_under($output_dir);
$self->{entity} =
$parser->parse_data( $self->header . "\n" . $self->body );
}
$self->{entity};
}
sub parts {
my $self = shift;
# return only the parts with bodies, not the multipart containers
grep { $_->bodyhandle } $self->entity->parts_DFS;
}
=back
=head1 SUBROUTINES
=over 4
=item process_send CUSTMSGNUM
Given a C<cust_msg.custmsgnum> value, sends the message. It must already
have been prepared (via L<FS::msg_template/prepare>).
=cut
sub process_send {
my $custmsgnum = shift;
my $cust_msg = FS::cust_msg->by_key($custmsgnum)
or die "cust_msg #$custmsgnum not found";
my $error = $cust_msg->send;
die $error if $error;
}
sub _upgrade_schema {
my ($class, %opts) = @_;
my $sql = '
DELETE FROM cust_msg WHERE NOT EXISTS
( SELECT 1 FROM cust_main WHERE cust_main.custnum = cust_msg.custnum )
';
my $sth = dbh->prepare($sql) or die dbh->errstr;
$sth->execute or die $sth->errstr;
'';
}
=back
=head1 SEE ALSO
L<FS::msg_template>, L<FS::cust_main>, L<FS::Record>.
=cut
1;
|
