/ 
OpenInteract-1.2
River stage zero No dependents
/ OpenInteract::Utility

NAME

OpenInteract::Utility - Package of routines that do not really fit anywhere else

SYNOPSIS

# Send a mail message from anywhere in the system
eval {  OpenInteract::Utility->send_mail( { to => 'dingdong@nutty.com',
                                            from => 'whynot@metoo.com',
                                            subject => 'wassup?',
                                            message => 'lets get down' } ) };
if ( $@ ) {
  warn "Mail not sent! Reason: $@";
}

DESCRIPTION

This class has a number of methods that are simple utilities.

METHODS

send_email( \% )

Sends an email with the parameters you specify.

On success: returns a true value;

On failure: dies with general error message ('Cannot send email: <error>') and sets typical messages in OpenInteract::Error, including the following parameters in {extra}:

- subject: subject of email
- from: who is the email from (will use the admin email if not specified)
- to/email: who is the email going to
- message: what content is in the email

Example:

eval { OpenInteract::Utility->send_mail({ 
                        to      => 'santa@xmas.com', 
                        subject => 'gimme!',
                        message => join "\n", @xmas_list }) };
if ( $@ ) {
  my $ei = OpenInteract::Error->get;
  carp "Failed to send an email! Error: $ei->{system_msg}\n",
       "Mail to: $ei->{extra}->{to}\nMessage: $ei->{extra}->{message}";
}

TO DO

Spool email on error

Perhaps throw an error when we cannot send an email, but also spool it to our website 'email' directory.

Allow attachments

We should be able to refer to files only in a particular directory for attaching to the email. (We do not want people specifying '/etc/passwd', right?)

We can have this work both ways:

# this method can allow nothing outside of its own base file
# structure (something like this, just a spur-of-the-moment thing...)
my $attach_id =  $R->utility->register_attachment({ 
                      filename => "uploads/4/this_upload.gif" 
                 });
...

my $rv = $R->utility->send_email( { ..., attachment => $attach_id } );

Something to think about...

BUGS

None known.

SEE ALSO

Mail::Sendmail

COPYRIGHT

Copyright (c) 2001 intes.net, inc.. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS

Chris Winters <chris@cwinters.com>