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
31           Implements the POP3 protocol.  See also Mail::Box::POP3.
32
33       Extends "DESCRIPTION" in Mail::Transport.
34

METHODS

36       Extends "METHODS" in Mail::Transport.
37
38   Constructors
39       Extends "Constructors" in Mail::Transport.
40
41       Mail::Transport::Receive->new(%options)
42           Inherited, see "METHODS" in Mail::Transport
43
44   Receiving mail
45       $obj->receive( [$unique_message_id] )
46           Receive one message from the remote server.  Some receivers will
47           provide the next message automatically, other are random access and
48           use the specified ID.
49
50   Server connection
51       Extends "Server connection" in Mail::Transport.
52
53       $obj->findBinary( $name, [@directories] )
54           Inherited, see "Server connection" in Mail::Transport
55
56       $obj->remoteHost()
57           Inherited, see "Server connection" in Mail::Transport
58
59       $obj->retry()
60           Inherited, see "Server connection" in Mail::Transport
61
62   Error handling
63       Extends "Error handling" in Mail::Transport.
64
65       $obj->AUTOLOAD()
66           Inherited, see "Error handling" in Mail::Reporter
67
68       $obj->addReport($object)
69           Inherited, see "Error handling" in Mail::Reporter
70
71       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
72       $callback] )
73       Mail::Transport::Receive->defaultTrace( [$level]|[$loglevel,
74       $tracelevel]|[$level, $callback] )
75           Inherited, see "Error handling" in Mail::Reporter
76
77       $obj->errors()
78           Inherited, see "Error handling" in Mail::Reporter
79
80       $obj->log( [$level, [$strings]] )
81       Mail::Transport::Receive->log( [$level, [$strings]] )
82           Inherited, see "Error handling" in Mail::Reporter
83
84       $obj->logPriority($level)
85       Mail::Transport::Receive->logPriority($level)
86           Inherited, see "Error handling" in Mail::Reporter
87
88       $obj->logSettings()
89           Inherited, see "Error handling" in Mail::Reporter
90
91       $obj->notImplemented()
92           Inherited, see "Error handling" in Mail::Reporter
93
94       $obj->report( [$level] )
95           Inherited, see "Error handling" in Mail::Reporter
96
97       $obj->reportAll( [$level] )
98           Inherited, see "Error handling" in Mail::Reporter
99
100       $obj->trace( [$level] )
101           Inherited, see "Error handling" in Mail::Reporter
102
103       $obj->warnings()
104           Inherited, see "Error handling" in Mail::Reporter
105
106   Cleanup
107       Extends "Cleanup" in Mail::Transport.
108
109       $obj->DESTROY()
110           Inherited, see "Cleanup" in Mail::Reporter
111

DIAGNOSTICS

113       Warning: Avoid program abuse: specify an absolute path for $exec.
114           Specifying explicit locations for executables of email transfer
115           agents should only be done with absolute file names, to avoid
116           various pontential security problems.
117
118       Warning: Executable $exec does not exist.
119           The explicitly indicated mail transfer agent does not exists. The
120           normal settings are used to find the correct location.
121
122       Error: Package $package does not implement $method.
123           Fatal error: the specific package (or one of its superclasses) does
124           not implement this method where it should. This message means that
125           some other related classes do implement this method however the
126           class at hand does not.  Probably you should investigate this and
127           probably inform the author of the package.
128

LICENSE

134       Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see
135       ChangeLog.
136
137       This program is free software; you can redistribute it and/or modify it
138       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
139
140
141
142perl v5.36.0                      2023-01-20       Mail::Transport::Receive(3)