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
|
=encoding utf8
=head1 NAME
Mail::Message::Construct::Read - read a Mail::Message from a file handle
=head1 SYNOPSIS
my $msg1 = Mail::Message->read(\*STDIN);
my $msg2 = Mail::Message->read(\@lines);
=head1 DESCRIPTION
When complex methods are called on a C<Mail::Message> object, this package
is autoloaded to support the reading of messages directly from any file
handle.
=head1 METHODS
=head2 Constructing a message
=over 4
=item $class-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
Read a message from a C<$fh>, C<STRING>, C<SCALAR>, or a reference to an
C<ARRAY> of lines. Most C<%options> are passed to the L<new()|Mail::Message/"Constructors"> of the message
which is created, but a few extra are defined.
Please have a look at L<build()|Mail::Message::Construct::Build/"Constructing a message"> and L<buildFromBody()|Mail::Message::Construct::Build/"Constructing a message"> before thinking about
this C<read> method. Use this C<read> only when you have a file-handle
like STDIN to parse from, or some external source of message lines.
When you already have a separate set of head and body lines, then C<read>
is certainly B<not> your best choice.
Some people use this method in a procmail script: the message arrives
at stdin, so we only have a filehandle. In this case, you are stuck
with this method. The message is preceded by a line which can be used
as message separator in mbox folders. See the example how to handle
that one.
This method will remove C<Status> and C<X-Status> fields when they appear
in the source, to avoid the risk that these fields accidentally interfere
with your internal administration, which may have security implications.
-Option --Default
body_type undef
parser_class undef
seekable false
strip_status_fields <C<true>>
trusted true
=over 2
=item body_type => CLASS
Force a body type (any specific implementation of a L<Mail::Message::Body|Mail::Message::Body>)
to be used to store the message content. When the body is a multipart or
nested, this will be overruled.
=item parser_class => CLASS
Enforce a certain parser type to be used, which must be an extension of
the parser class otherwise taken.
=item seekable => BOOLEAN
Indicate that a seekable file-handle has been passed. In this case, we
can use the L<Mail::Box::Parser::Perl|Mail::Box::Parser::Perl> parser which reads messages
directly from the input stream.
=item strip_status_fields => BOOLEAN
Remove the C<Status> and C<X-Status> fields from the message after
reading, to lower the risk that received messages from external
sources interfere with your internal administration. If you want
fields not to be stripped (you would like to disable the stripping)
you probably process folders yourself, which is a Bad Thing!
=item trusted => BOOLEAN
=back
ยป example:
my $msg1 = Mail::Message->read(\*STDIN);
my $msg2 = Mail::Message->read(\@lines, log => 'PROGRESS');
$folder->addMessages($msg1, $msg2);
my $msg3 = Mail::Message->read(<<MSG);
Subject: hello world
To: you@example.com
# warning: empty line required !!!
Hi, greetings!
MSG
# promail example
my $fromline = <STDIN>;
my $msg = Mail::Message->read(\*STDIN);
my $coerced = $mboxfolder->addMessage($msg);
$coerced->fromLine($fromline);
=back
=head1 SEE ALSO
This module is part of Mail-Message version 3.019,
built on November 24, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2001-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
