Mail::Transport::Receive(3pm)

1Mail::Transport::ReceivUes(e3r)Contributed Perl DocumentMaatiilo:n:Transport::Receive(3)
2
3
4

NAME

6       Mail::Transport::Receive - receive messages
7

INHERITANCE

9        Mail::Transport::Receive
10          is a Mail::Transport
11          is a Mail::Reporter
12
13        Mail::Transport::Receive is extended by
14          Mail::Transport::IMAP4
15          Mail::Transport::POP3
16

SYNOPSIS

18        my $receiver = Mail::Transport::POP3->new(...);
19        my $message = $receiver->receive($id);
20

DESCRIPTION

22       Each object which extends Mail::Transport::Receive implement a protocol
23       which can get messages into your application.  The internals of each
24       implementation can differ quite a lot, so have a look at each separate
25       manual page as well.
26
27       Current message receivers:
28
29       * Mail::Transport::POP3
30           Implements the POP3 protocol.  See also Mail::Box::POP3.
31

METHODS

33       Constructors
34
35       Mail::Transport::Receive->new(OPTIONS)
36
37           See "METHODS" in Mail::Transport
38
39       Receiving mail
40
41       $obj->receive([UNIQUE-MESSAGE-ID])
42
43           Receive one message from the remote server.  Some receivers will
44           provide the next message automatically, other are random access and
45           use the specified ID.
46
47       Server connection
48
49       $obj->findBinary(NAME [, DIRECTORIES])
50
51           See "Server connection" in Mail::Transport
52
53       $obj->remoteHost
54
55           See "Server connection" in Mail::Transport
56
57       $obj->retry
58
59           See "Server connection" in Mail::Transport
60
61       Error handling
62
63       $obj->AUTOLOAD
64
65           See "Error handling" in Mail::Reporter
66
67       $obj->addReport(OBJECT)
68
69           See "Error handling" in Mail::Reporter
70
71       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
72
73       Mail::Transport::Receive->defaultTrace([LEVEL]⎪[LOGLEVEL,
74       TRACELEVEL]⎪[LEVEL, CALLBACK])
75
76           See "Error handling" in Mail::Reporter
77
78       $obj->errors
79
80           See "Error handling" in Mail::Reporter
81
82       $obj->log([LEVEL [,STRINGS]])
83
84       Mail::Transport::Receive->log([LEVEL [,STRINGS]])
85
86           See "Error handling" in Mail::Reporter
87
88       $obj->logPriority(LEVEL)
89
90       Mail::Transport::Receive->logPriority(LEVEL)
91
92           See "Error handling" in Mail::Reporter
93
94       $obj->logSettings
95
96           See "Error handling" in Mail::Reporter
97
98       $obj->notImplemented
99
100           See "Error handling" in Mail::Reporter
101
102       $obj->report([LEVEL])
103
104           See "Error handling" in Mail::Reporter
105
106       $obj->reportAll([LEVEL])
107
108           See "Error handling" in Mail::Reporter
109
110       $obj->trace([LEVEL])
111
112           See "Error handling" in Mail::Reporter
113
114       $obj->warnings
115
116           See "Error handling" in Mail::Reporter
117
118       Cleanup
119
120       $obj->DESTROY
121
122           See "Cleanup" in Mail::Reporter
123
124       $obj->inGlobalDestruction
125
126           See "Cleanup" in Mail::Reporter
127

DIAGNOSTICS

129       Warning: Avoid program abuse: specify an absolute path for $exec.
130
131       Specifying explicit locations for executables of email transfer agents
132       should only be done with absolute file names, to avoid various pon‐
133       tential security problems.
134
135       Warning: Executable $exec does not exist.
136
137       The explicitly indicated mail transfer agent does not exists. The nor‐
138       mal settings are used to find the correct location.
139
140       Error: Package $package does not implement $method.
141
142       Fatal error: the specific package (or one of its superclasses) does not
143       implement this method where it should. This message means that some
144       other related classes do implement this method however the class at
145       hand does not.  Probably you should investigate this and probably
146       inform the author of the package.
147

LICENSE

153       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
154       ChangeLog.
155
156       This program is free software; you can redistribute it and/or modify it
157       under the same terms as Perl itself.  See
158       http://www.perl.com/perl/misc/Artistic.html
159
160
161
162perl v5.8.8                       2007-03-25       Mail::Transport::Receive(3)