1Mail::Server::IMAP4::FeUtscehr(3C)ontributed Perl DocumeMnatialt:i:oSnerver::IMAP4::Fetch(3)
2
3
4

NAME

6       Mail::Server::IMAP4::Fetch - message info for IMAP protocol speed-up
7

SYNOPSIS

9        my $imap = Mail::Server::IMAP4::Fetch->new($msg);
10        print $imap->fetchBody(1);   # for FETCH BODYSTRUCTURE
11        print $imap->fetchBody;      # for FETCH BODY
12        print $imap->fetchEnvelope;  # for FETCH ENVELOPE
13        print $imap->fetchSize;
14

DESCRIPTION

16       Create a new object hierarchy, which contains information to capture
17       the most important details about the message.  The object can be used
18       to speed-up IMAP-server implementations, as Mail::Box::Netzwert.
19
20       The object used here is a simplified representation of a
21       Mail::Box::Message object.  It does not maintain headers and does not
22       refer to the folder.  It only works with messages stored in a file.
23       Therefore, this object can be frozen by Storable if you want to.
24

METHODS

26       Constructors
27
28       Mail::Server::IMAP4::Fetch->new(MESSAGE⎪PART, OPTIONS)
29
30        Option      --Default
31        md5checksums  0
32
33           . md5checksums BOOLEAN
34
35       Attributes
36
37       $obj->bodyLocation
38
39       $obj->headLocation
40
41       $obj->partLocation
42
43       IMAP Commands
44
45       $obj->fetchBody(EXTENDED)
46
47           Returns one string, representing the message's structure as defined
48           by the IMAP protocol.  The boolean argument indicates whether you
49           like to have the EXTENDED information, as the imap command 'FETCH
50           BODYSTRUCTURE' defines or the limited information of 'FETCH BODY'.
51
52       $obj->fetchEnvelope
53
54           Returns a string representation of some header information.
55
56       $obj->fetchSize
57
58           Returns the size of the message body.
59
60       $obj->part([PARTNR])
61
62           The partnummer is a list of dot-separated positive integers, num‐
63           bering (nested) parts in multi-part message bodies.  By default,
64           the info of the main message is returned.
65
66           Example:
67
68            my $partinfo = $msg->info->part('1.2.1');
69            print $msg->info->part('3.3')->fetchBody;
70
71       $obj->printStructure([FILEHANDLE⎪undef, [NUMBER]])
72
73           Print the structure of the fetch data to the specified FILEHANDLE
74           or the selected filehandle.  When explicitly "undef" is specified
75           as handle, then the output will be returned as string.  Only a lim‐
76           ited set of the information is displayed.
77
78           Example:
79
80            my $imap = ...;
81            $imap->printStructure(\*OUTPUT);
82            $imap->printStructure;
83            my $struct = $imap->printStructure(undef);
84
85       Internals
86

DETAILS

88       See
89
90       RFC2060: "Internet Message Access Protocol IMAP4v1" section 7.4.2
91       RFC2045: "MIME Part One: Format of Internet Message Bodies".
92

SEE ALSO

94       This module is part of Mail-Box distribution version 2.070, built on
95       March 25, 2007. Website: http://perl.overmeer.net/mailbox/
96

LICENSE

98       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
99       ChangeLog.
100
101       This program is free software; you can redistribute it and/or modify it
102       under the same terms as Perl itself.  See
103       http://www.perl.com/perl/misc/Artistic.html
104
105
106
107perl v5.8.8                       2007-03-25     Mail::Server::IMAP4::Fetch(3)
Impressum