.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::Send 3"
.TH Mail::Send 3 2023-07-25 "perl v5.38.0" "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
Mail::Send \- Simple electronic mail interface
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  require Mail::Send;
\&
\&  $msg = Mail::Send\->new;
\&  $msg = Mail::Send\->new(Subject => \*(Aqexample\*(Aq, To => \*(Aqtimbo\*(Aq);
\&
\&  $msg\->to(\*(Aquser@host\*(Aq);
\&  $msg\->to(\*(Aquser@host\*(Aq, \*(Aquser2@example.com\*(Aq);
\&  $msg\->subject(\*(Aqexample subject\*(Aq);
\&  $msg\->cc(\*(Aquser@host\*(Aq);
\&  $msg\->bcc(\*(Aqsomeone@else\*(Aq);
\&
\&  $msg\->set($header, @values);
\&  $msg\->add($header, @values);
\&  $msg\->delete($header);
\&
\&  # Launch mailer and set headers. The filehandle returned
\&  # by open() is an instance of the Mail::Mailer class.
\&  # Arguments to the open() method are passed to the Mail::Mailer
\&  # constructor.
\&
\&  $fh = $msg\->open;   # some default mailer
\&  $fh = $msg\->open(\*(Aqsendmail\*(Aq); # explicit
\&  print $fh "Body of message";
\&  $fh\->close          # complete the message and send it
\&      or die "couldn\*(Aqt send whole message: $!\en";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mail::Send creates e\-mail messages without using the Mail::Header
knowledge, which means that all escaping and folding must be done by
you!  Also: do not forget to escape leading dots.  Simplicity has its price.
.PP
When you have time, take a look at Mail::Transport which is part of
the MailBox suite.
.SH METHODS
.IX Header "METHODS"
.SS Constructors
.IX Subsection "Constructors"
.IP Mail::Send\->\fBnew\fR(PAIRS) 4
.IX Item "Mail::Send->new(PAIRS)"
A list of header fields (provided as key-value PAIRS) can be used to
initialize the object, limited to the few provided as method: \f(CW\*(C`to\*(C'\fR,
\&\f(CW\*(C`subject\*(C'\fR, \f(CW\*(C`cc\*(C'\fR, and \f(CW\*(C`bcc\*(C'\fR.  For other header fields, use \fBadd()\fR.
.SS "Header fields"
.IX Subsection "Header fields"
.ie n .IP "$obj\->\fBadd\fR($fieldname, @values)" 4
.el .IP "\f(CW$obj\fR\->\fBadd\fR($fieldname, \f(CW@values\fR)" 4
.IX Item "$obj->add($fieldname, @values)"
Add values to the list of defined values for the \f(CW$fieldname\fR.
.ie n .IP $obj\->\fBbcc\fR(@values) 4
.el .IP \f(CW$obj\fR\->\fBbcc\fR(@values) 4
.IX Item "$obj->bcc(@values)"
.PD 0
.ie n .IP $obj\->\fBcc\fR(@values) 4
.el .IP \f(CW$obj\fR\->\fBcc\fR(@values) 4
.IX Item "$obj->cc(@values)"
.ie n .IP $obj\->\fBdelete\fR($fieldname) 4
.el .IP \f(CW$obj\fR\->\fBdelete\fR($fieldname) 4
.IX Item "$obj->delete($fieldname)"
.ie n .IP "$obj\->\fBset\fR($fieldname, @values)" 4
.el .IP "\f(CW$obj\fR\->\fBset\fR($fieldname, \f(CW@values\fR)" 4
.IX Item "$obj->set($fieldname, @values)"
.PD
The \f(CW@values\fR will replace the old values for the \f(CW$fieldname\fR.  Returned is
the LIST of values after modification.
.ie n .IP $obj\->\fBsubject\fR(@values) 4
.el .IP \f(CW$obj\fR\->\fBsubject\fR(@values) 4
.IX Item "$obj->subject(@values)"
.PD 0
.ie n .IP $obj\->\fBto\fR(@values) 4
.el .IP \f(CW$obj\fR\->\fBto\fR(@values) 4
.IX Item "$obj->to(@values)"
.PD
.SS Sending
.IX Subsection "Sending"
.ie n .IP $obj\->\fBopen\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBopen\fR(%options) 4
.IX Item "$obj->open(%options)"
The \f(CW%options\fR are used to initiate a mailer object via
\&\fBMail::Mailer::new()\fR.  Then \fBMail::Mailer::open()\fR is called
with the knowledge collected in this \f(CW\*(C`Mail::Send\*(C'\fR object.
.Sp
Be warned: this module implements raw smtp, which means that you have
to escape lines which start with a dot, by adding one in front.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of the MailTools distribution,
\&\fIhttp://perl.overmeer.net/mailtools/\fR.
.SH AUTHORS
.IX Header "AUTHORS"
The MailTools bundle was developed by Graham Barr.  Later, Mark
Overmeer took over maintenance without commitment to further development.
.PP
Mail::Cap by Gisle Aas <aas@oslonett.no>.
Mail::Field::AddrList by Peter Orbaek <poe@cit.dk>.
Mail::Mailer and Mail::Send by Tim Bunce <Tim.Bunce@ig.co.uk>.
For other contributors see ChangeLog.
.SH LICENSE
.IX Header "LICENSE"
Copyrights 1995\-2000 Graham Barr <gbarr@pobox.com> and
2001\-2017 Mark Overmeer <perl@overmeer.net>.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR