.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LedgerSMB::Mailer 3pm"
.TH LedgerSMB::Mailer 3pm "2012-03-26" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
LedgerSMB::Mailer \- Mail output for LedgerSMB
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 10
\& #====================================================================
\& # 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 dsmimader@sql\-ledger.com
\& #====================================================================
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "LedgerSMB::Mailer\->new(...)"
.IX Subsection "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.
.ie n .SS "$mail\->prepare_message(to => $to, from => $from, ...)"
.el .SS "\f(CW$mail\fP\->prepare_message(to => \f(CW$to\fP, from => \f(CW$from\fP, ...)"
.IX Subsection "$mail->prepare_message(to => $to, from => $from, ...)"
Prepares and encodes base message for sending or adding attachments.
.PP
\fIArguments\fR
.IX Subsection "Arguments"
.IP "to, from, cc, bcc" 4
.IX Item "to, from, cc, bcc"
Address fields for the email.
.IP "subject" 4
.IX Item "subject"
The subject for the email.
.IP "message" 4
.IX Item "message"
The message body for the email.
.IP "contenttype" 4
.IX Item "contenttype"
The conttent type for the body of the message, not for any attachments.
.IP "notify" 4
.IX Item "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.
.ie n .SS "$mail\->attach(data => $data, file => $file, filename => $name, strip => $strip)"
.el .SS "\f(CW$mail\fP\->attach(data => \f(CW$data\fP, file => \f(CW$file\fP, filename => \f(CW$name\fP, strip => \f(CW$strip\fP)"
.IX Subsection "$mail->attach(data => $data, file => $file, filename => $name, strip => $strip)"
Add an attachment to the prepared message.  If \f(CW$data\fR is specified, use the
value of that variable as the attachment value, otherwise attach the file
given by \f(CW$file\fR.  If both a file and data are given, the data is attached.
filename must be given and is used to name the attachment.
.PP
\&\f(CW$strip\fR is an optional string to remove from the filename send with the
attachment.
.ie n .SS "$mail\->send"
.el .SS "\f(CW$mail\fP\->send"
.IX Subsection "$mail->send"
Sends a prepared message using the method configured in ledgersmb.conf.