File: Send.pod

package info (click to toggle)
libmailtools-perl 2.06-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 392 kB
  • ctags: 259
  • sloc: perl: 2,193; makefile: 48
file content (138 lines) | stat: -rw-r--r-- 2,894 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
=head1 NAME

Mail::Send - Simple electronic mail interface

=head1 SYNOPSIS

  require Mail::Send;

  $msg = Mail::Send->new;
  $msg = Mail::Send->new(Subject => 'example', To => 'timbo');

  $msg->to('user@host');
  $msg->to('user@host', 'user2@example.com');
  $msg->subject('example subject');
  $msg->cc('user@host');
  $msg->bcc('someone@else');

  $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('sendmail'); # explicit
  print $fh "Body of message";
  $fh->close          # complete the message and send it
      or die "couldn't send whole message: $!\n";

=head1 DESCRIPTION

L<Mail::Send|Mail::Send> creates e-mail messages without using the L<Mail::Header|Mail::Header>
knowledge, which means that all escaping and folding must be done by
you!  Simplicity has its price.

When you have time, take a look at Mail::Transport

=head1 METHODS

=head2 Constructors

Mail::Send-E<gt>B<new>(PAIRS)

=over 4

A list of header fields (provided as key-value PAIRS) can be
used to initialize the object.

=back

=head2 Header fields

$obj-E<gt>B<add>(FIELDNAME, VALUES)

=over 4

Add values to the list of defined values for the FIELDNAME.

=back

$obj-E<gt>B<bcc>(VALUES)

=over 4

=back

$obj-E<gt>B<cc>(VALUES)

=over 4

=back

$obj-E<gt>B<delete>(FIELDNAME)

=over 4

=back

$obj-E<gt>B<set>(FIELDNAME, VALUES)

=over 4

VALUES will replace the old values for the FIELDNAME.  Returned is
the LIST of values after modification.

=back

$obj-E<gt>B<subject>(VALUES)

=over 4

=back

$obj-E<gt>B<to>(VALUES)

=over 4

=back

=head2 Sending

$obj-E<gt>B<open>(OPTIONS)

=over 4

The OPTIONS are used to initiate a mailer object via
L<Mail::Mailer::new()|Mail::Mailer/"Constructors">.  Then L<Mail::Mailer::open()|Mail::Mailer/"Constructors"> is called
with the knowledge collected in this Mail::Send object.

=back

=head1 SEE ALSO

This module is part of the MailTools distribution,
F<http://perl.overmeer.net/mailtools/>.

=head1 AUTHORS

The MailTools bundle was developed by Graham Barr.  Later, Mark
Overmeer took over maintenance without commitment to further development.

Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
For other contributors see ChangeLog.

=head1 LICENSE

Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>