external message services: core refactoring of msg_template

[freeside.git] / FS / FS / cust_msg.pm

diff --git a/FS/FS/cust_msg.pm b/FS/FS/cust_msg.pm
index 72f64b9..9346327 100644 (file)
--- a/FS/FS/cust_msg.pm
+++ b/FS/FS/cust_msg.pm
@@ -45,7 +45,7 @@ from FS::Record.  The following fields are currently supported:
 
 =item header - message header
 
-=item body - message body
+=item body - message body (as a complete MIME document)
 
 =item error - Email::Sender error message (or null for success)
 
@@ -150,10 +150,27 @@ sub check {
   $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;
+  my $msg_template = $self->msg_template
+    or return 'message was created without a template object';
+  $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>