4 use base qw( FS::cust_main_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs );
7 use vars qw( @statuses );
11 FS::cust_msg - Object methods for cust_msg records
17 $record = new FS::cust_msg \%hash;
18 $record = new FS::cust_msg { 'column' => 'value' };
20 $error = $record->insert;
22 $error = $record->check;
26 An FS::cust_msg object represents an email message generated by Freeside
27 and sent to a customer (see L<FS::msg_template>). FS::cust_msg inherits
28 from FS::Record. The following fields are currently supported:
32 =item custmsgnum - primary key
34 =item custnum - customer number
36 =item msgnum - template number
38 =item msgtype - the message type
40 =item _date - the time the message was sent
42 =item env_from - envelope From address
44 =item env_to - envelope To addresses, including Bcc, separated by newlines
46 =item header - message header
48 =item body - message body (as a complete MIME document)
50 =item preview - HTML fragment to show as a preview of the message
52 =item error - Email::Sender error message (or null for success)
54 =item status - "prepared", "sent", or "failed"
68 # the new method can be inherited from FS::Record, if a table method is defined
70 sub table { 'cust_msg'; }
72 sub nohistory_fields { ('header', 'body'); }
73 # history is kind of pointless on this table
75 @statuses = qw( prepared sent failed );
79 Adds this record to the database. If there is an error, returns the error
80 and emits a warning; otherwise returns false.
85 # warn of all errors here; failing to insert/update one of these should
86 # cause a warning at worst
88 my $error = $self->SUPER::insert;
89 warn "[cust_msg] error logging message status: $error\n" if $error;
95 Delete this record from the database. There's no reason to do this.
101 warn "[cust_msg] log entry deleted\n";
102 return $self->SUPER::delete;
105 =item replace OLD_RECORD
107 Replaces the OLD_RECORD with this one in the database. If there is an error,
108 returns the error and emits a warning, otherwise returns false.
114 my $error = $self->SUPER::replace(@_);
115 warn "[cust_msg] error logging message status: $error\n" if $error;
121 Checks all fields to make sure this is a valid example. If there is
122 an error, returns the error, otherwise returns false. Called by the insert
127 # the check method should currently be supplied - FS::Record contains some
128 # data checking routines
134 $self->ut_numbern('custmsgnum')
135 || $self->ut_numbern('custnum')
136 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
137 || $self->ut_numbern('msgnum')
138 || $self->ut_foreign_keyn('msgnum', 'msg_template', 'msgnum')
139 || $self->ut_numbern('_date')
140 || $self->ut_textn('env_from')
141 || $self->ut_textn('env_to')
142 || $self->ut_anything('header')
143 || $self->ut_anything('body')
144 || $self->ut_anything('preview')
145 || $self->ut_enum('status', \@statuses)
146 || $self->ut_textn('error')
147 || $self->ut_enum('msgtype', [ '',
154 return $error if $error;
161 Sends the message through its parent L<FS::msg_template>. Returns an error
162 message on error, or an empty string.
168 # it's still allowed to have cust_msgs without message templates, but only
170 my $msg_template = $self->msg_template || 'FS::msg_template::email';
171 $msg_template->send_prepared($self);
176 Returns the complete message as a L<MIME::Entity>.
178 XXX this only works if the message in fact contains a MIME entity. Messages
179 created by external APIs may not look like that.
183 Returns a list of the MIME parts contained in the message, as L<MIME::Entity>
190 if ( !exists($self->{entity}) ) {
191 my $parser = MIME::Parser->new;
192 my $output_dir = "$FS::UID::cache_dir/cache.$FS::UID::datasrc/mimeparts";
193 mkdir($output_dir) unless -d $output_dir;
194 $parser->output_under($output_dir);
196 $parser->parse_data( $self->header . "\n" . $self->body );
203 # return only the parts with bodies, not the multipart containers
204 grep { $_->bodyhandle } $self->entity->parts_DFS;
213 =item process_send CUSTMSGNUM
215 Given a C<cust_msg.custmsgnum> value, sends the message. It must already
216 have been prepared (via L<FS::msg_template/prepare>).
221 my $custmsgnum = shift;
222 my $cust_msg = FS::cust_msg->by_key($custmsgnum)
223 or die "cust_msg #$custmsgnum not found";
224 my $error = $cust_msg->send;
225 die $error if $error;
230 L<FS::msg_template>, L<FS::cust_main>, L<FS::Record>.