SYNOPSIS
COPYRIGHT
#==================================================================== # LedgerSMB # Small Medium Business Accounting software # http://www.ledgersmb.org/ # # Copyright (C) 2006 # This work contains copyrighted information from a number of sources # all used with permission. # # This file contains source code included with or based on SQL-Ledger # which # is Copyright Dieter Simader and DWS Systems Inc. 2000-2005 # and licensed under the GNU General Public License version 2 or, at # your option, any later version. For a full list including contact # information of contributors, maintainers, and copyright holders, # see the CONTRIBUTORS file. # # Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork): # Copyright (C) 2002 # # Author: DWS Systems Inc. # Web: http://www.sql-ledger.org # # Contributors: # # Original Author and copyright holder: # Dieter Simader [email protected] #====================================================================
METHODS
LedgerSMB::Mailer->new(...)
Create a new Mailer object. If any arguments are passed in, a message that uses them will be automatically prepared but not sent.$mail->prepare_message(to => $to, from => $from, ...)
Prepares and encodes base message for sending or adding attachments.Arguments
- to, from, cc, bcc
- Address fields for the email.
- subject
- The subject for the email.
- message
- The message body for the email.
- contenttype
- The conttent type for the body of the message, not for any attachments.
- notify
- Sets the Disposition-Notification-To header (read receipt request) for the message. This header will only be added if a from address is set.
$mail->attach(data => $data, file => $file, filename => $name, strip => $strip)
Add an attachment to the prepared message. If $data is specified, use the value of that variable as the attachment value, otherwise attach the file given by $file. If both a file and data are given, the data is attached. filename must be given and is used to name the attachment.$strip is an optional string to remove from the filename send with the attachment.
$mail->send
Sends a prepared message using the method configured in ledgersmb.conf.