1Mail::Box::POP3s(3) User Contributed Perl Documentation Mail::Box::POP3s(3)
2
6 Mail::Box::POP3s - handle secure POP3 folders as client
7
9 Mail::Box::POP3s
10 is a Mail::Box::POP3
11 is a Mail::Box::Net
12 is a Mail::Box
13 is a Mail::Reporter
14
16 use Mail::Box::POP3s;
17 my $folder = Mail::Box::POP3s->new(folder => $ENV{MAIL}, ...);
18
20 This module mainly extends Mail::Box::POP3.
21 Extends "DESCRIPTION" in Mail::Box::POP3.
23
25 Extends "OVERLOADED" in Mail::Box::POP3.
26 overload: ""
28 Inherited, see "OVERLOADED" in Mail::Box
29 overload: @{}
31 Inherited, see "OVERLOADED" in Mail::Box
32 overload: cmp
34 Inherited, see "OVERLOADED" in Mail::Box
35
37 Extends "METHODS" in Mail::Box::POP3.
38 Constructors
40 Extends "Constructors" in Mail::Box::POP3.
41 Mail::Box::POP3s->new(%options)
43 -Option --Defined in --Default
44 access Mail::Box 'r'
45 authenticate Mail::Box::POP3 'AUTO'
46 body_delayed_type Mail::Box Mail::Message::Body::Delayed
47 body_type Mail::Box Mail::Message::Body::Lines
48 coerce_options Mail::Box []
49 create Mail::Box <not applicable>
50 extract Mail::Box 10240
51 field_type Mail::Box undef
52 fix_headers Mail::Box <false>
53 folder Mail::Box <not applicable>
54 folderdir Mail::Box <network location>
55 head_delayed_type Mail::Box Mail::Message::Head::Delayed
56 head_type Mail::Box Mail::Message::Head::Complete
57 keep_dups Mail::Box <false>
58 lock_file Mail::Box undef
59 lock_timeout Mail::Box 1 hour
60 lock_type Mail::Box 'NONE'
61 lock_wait Mail::Box 10 seconds
62 locker Mail::Box undef
63 log Mail::Reporter 'WARNINGS'
64 manager Mail::Box undef
65 message_type Mail::Box Mail::Box::POP3::Message
66 multipart_type Mail::Box Mail::Message::Body::Multipart
67 password Mail::Box::Net undef
68 pop_client Mail::Box::POP3 undef
69 remove_when_empty Mail::Box <false>
70 save_on_exit Mail::Box <true>
71 server_name Mail::Box::Net undef
72 server_port Mail::Box::Net 995
73 trace Mail::Reporter 'WARNINGS'
74 trusted Mail::Box <false>
75 username Mail::Box::Net undef
76 access => MODE
78 authenticate => 'LOGIN'|'APOP'|'AUTO'
79 body_delayed_type => CLASS
80 body_type => CLASS|CODE
81 coerce_options => ARRAY
82 create => BOOLEAN
83 extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
84 field_type => CLASS
85 fix_headers => BOOLEAN
86 folder => FOLDERNAME
87 folderdir => DIRECTORY
88 head_delayed_type => CLASS
89 head_type => CLASS
90 keep_dups => BOOLEAN
91 lock_file => FILENAME
92 lock_timeout => SECONDS
93 lock_type => CLASS|STRING|ARRAY
94 lock_wait => SECONDS
95 locker => OBJECT
96 log => LEVEL
97 manager => MANAGER
98 message_type => CLASS
99 multipart_type => CLASS
100 password => STRING
101 pop_client => OBJECT
102 remove_when_empty => BOOLEAN
103 save_on_exit => BOOLEAN
104 server_name => HOSTNAME
105 server_port => INTEGER
106 trace => LEVEL
107 trusted => BOOLEAN
108 username => STRING
109 The folder
111 Extends "The folder" in Mail::Box::POP3.
112 $obj->addMessage($message)
114 Inherited, see "METHODS" in Mail::Box::POP3
115 $obj->addMessages($messages)
117 Inherited, see "METHODS" in Mail::Box::POP3
118 Mail::Box::POP3s->appendMessages(%options)
120 Inherited, see "The folder" in Mail::Box
121 $obj->close(%options)
123 Inherited, see "The folder" in Mail::Box
124 $obj->copyTo($folder, %options)
126 Inherited, see "The folder" in Mail::Box
127 $obj->delete(%options)
129 Inherited, see "METHODS" in Mail::Box::POP3
130 $obj->folderdir( [$directory] )
132 Inherited, see "The folder" in Mail::Box
133 $obj->name()
135 Inherited, see "The folder" in Mail::Box
136 $obj->organization()
138 Inherited, see "The folder" in Mail::Box
139 $obj->size()
141 Inherited, see "The folder" in Mail::Box
142 $obj->type()
144 Inherited, see "The folder" in Mail::Box
145 $obj->update()
147 Inherited, see "METHODS" in Mail::Box::POP3
148 $obj->url()
150 Inherited, see "The folder" in Mail::Box
151 Folder flags
153 Extends "Folder flags" in Mail::Box::POP3.
154 $obj->access()
156 Inherited, see "Folder flags" in Mail::Box
157 $obj->isModified()
159 Inherited, see "Folder flags" in Mail::Box
160 $obj->modified( [BOOLEAN] )
162 Inherited, see "Folder flags" in Mail::Box
163 $obj->writable()
165 Inherited, see "Folder flags" in Mail::Box
166 The messages
168 Extends "The messages" in Mail::Box::POP3.
169 $obj->current( [$number|$message|$message_id] )
171 Inherited, see "The messages" in Mail::Box
172 $obj->find($message_id)
174 Inherited, see "The messages" in Mail::Box
175 $obj->findFirstLabeled( $label, [BOOLEAN, [$msgs]] )
177 Inherited, see "The messages" in Mail::Box
178 $obj->message( $index, [$message] )
180 Inherited, see "The messages" in Mail::Box
181 $obj->messageId( $message_id, [$message] )
183 Inherited, see "The messages" in Mail::Box
184 $obj->messageIds()
186 Inherited, see "The messages" in Mail::Box
187 $obj->messages( <'ALL'|$range|'ACTIVE'|'DELETED'|$label|
189 !$label|$filter> )
190 Inherited, see "The messages" in Mail::Box
191 $obj->nrMessages(%options)
193 Inherited, see "The messages" in Mail::Box
194 $obj->scanForMessages($message, $message_ids, $timespan, $window)
196 Inherited, see "The messages" in Mail::Box
197 Sub-folders
199 Extends "Sub-folders" in Mail::Box::POP3.
200 $obj->listSubFolders(%options)
202 Mail::Box::POP3s->listSubFolders(%options)
203 Inherited, see "METHODS" in Mail::Box::POP3
204 $obj->nameOfSubFolder( $subname, [$parentname] )
206 Mail::Box::POP3s->nameOfSubFolder( $subname, [$parentname] )
207 Inherited, see "Sub-folders" in Mail::Box
208 $obj->openRelatedFolder(%options)
210 Inherited, see "Sub-folders" in Mail::Box
211 $obj->openSubFolder(%options)
213 Inherited, see "METHODS" in Mail::Box::POP3
214 $obj->topFolderWithMessages()
216 Mail::Box::POP3s->topFolderWithMessages()
217 Inherited, see "Sub-folders" in Mail::Box
218 Internals
220 Extends "Internals" in Mail::Box::POP3.
221 $obj->coerce($message, %options)
223 Inherited, see "Internals" in Mail::Box
224 $obj->create($folder, %options)
226 Mail::Box::POP3s->create($folder, %options)
227 Inherited, see "METHODS" in Mail::Box::POP3
228 $obj->determineBodyType($message, $head)
230 Inherited, see "Internals" in Mail::Box
231 Mail::Box::POP3s->foundIn( [$foldername], %options )
233 Inherited, see "Internals" in Mail::Box
234 $obj->getHead($message)
236 Inherited, see "Internals" in Mail::Box::POP3
237 $obj->getHeadAndBody($message)
239 Inherited, see "Internals" in Mail::Box::POP3
240 $obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] )
242 Inherited, see "Internals" in Mail::Box
243 $obj->locker()
245 Inherited, see "Internals" in Mail::Box
246 $obj->popClient(%options)
248 Inherited, see "Internals" in Mail::Box::POP3
249 $obj->read(%options)
251 Inherited, see "Internals" in Mail::Box
252 $obj->readMessages(%options)
254 Inherited, see "Internals" in Mail::Box
255 $obj->storeMessage($message)
257 Inherited, see "Internals" in Mail::Box
258 $obj->toBeThreaded($messages)
260 Inherited, see "Internals" in Mail::Box
261 $obj->toBeUnthreaded($messages)
263 Inherited, see "Internals" in Mail::Box
264 $obj->updateMessages(%options)
266 Inherited, see "Internals" in Mail::Box
267 $obj->write(%options)
269 Inherited, see "Internals" in Mail::Box
270 $obj->writeMessages(%options)
272 Inherited, see "Internals" in Mail::Box::POP3
273 Other methods
275 Extends "Other methods" in Mail::Box::POP3.
276 $obj->timespan2seconds($time)
278 Mail::Box::POP3s->timespan2seconds($time)
279 Inherited, see "Other methods" in Mail::Box
280 Error handling
282 Extends "Error handling" in Mail::Box::POP3.
283 $obj->AUTOLOAD()
285 Inherited, see "Error handling" in Mail::Reporter
286 $obj->addReport($object)
288 Inherited, see "Error handling" in Mail::Reporter
289 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
291 $callback] )
292 Mail::Box::POP3s->defaultTrace( [$level]|[$loglevel,
293 $tracelevel]|[$level, $callback] )
294 Inherited, see "Error handling" in Mail::Reporter
295 $obj->errors()
297 Inherited, see "Error handling" in Mail::Reporter
298 $obj->log( [$level, [$strings]] )
300 Mail::Box::POP3s->log( [$level, [$strings]] )
301 Inherited, see "Error handling" in Mail::Reporter
302 $obj->logPriority($level)
304 Mail::Box::POP3s->logPriority($level)
305 Inherited, see "Error handling" in Mail::Reporter
306 $obj->logSettings()
308 Inherited, see "Error handling" in Mail::Reporter
309 $obj->notImplemented()
311 Inherited, see "Error handling" in Mail::Reporter
312 $obj->report( [$level] )
314 Inherited, see "Error handling" in Mail::Reporter
315 $obj->reportAll( [$level] )
317 Inherited, see "Error handling" in Mail::Reporter
318 $obj->trace( [$level] )
320 Inherited, see "Error handling" in Mail::Reporter
321 $obj->warnings()
323 Inherited, see "Error handling" in Mail::Reporter
324 Cleanup
326 Extends "Cleanup" in Mail::Box::POP3.
327 $obj->DESTROY()
329 Inherited, see "Cleanup" in Mail::Box
330
332 Extends "DETAILS" in Mail::Box::POP3.
333
335 Error: Cannot create POP3 client for $name.
336 The connection to the POP3 server cannot be established. You may
337 see more, related, error messages about the failure.
338 Error: Cannot find head back for $uidl on POP3 server $name.
340 The server told to have this message, but when asked for its
341 headers, no single line was returned. Did the message get
342 destroyed?
343 Error: Cannot read body for $uidl on POP3 server $name.
345 The message's headers are retrieved from the server, but the body
346 seems to be lost. Did the message get destroyed between reading
347 the header and reading the body?
348 Warning: Changes not written to read-only folder $self.
350 You have opened the folder read-only --which is the default set by
351 new(access)--, made modifications, and now want to close it. Set
352 close(force) if you want to overrule the access mode, or close the
353 folder with close(write) set to "NEVER".
354 Error: Copying failed for one message.
356 For some reason, for instance disc full, removed by external
357 process, or read-protection, it is impossible to copy one of the
358 messages. Copying will proceed for the other messages.
359 Error: Destination folder $name is not writable.
361 The folder where the messages are copied to is not opened with
362 write access (see new(access)). This has no relation with write
363 permission to the folder which is controlled by your operating
364 system.
365 Warning: Different messages with id $msgid
367 The message id is discovered more than once within the same folder,
368 but the content of the message seems to be different. This should
369 not be possible: each message must be unique.
370 Error: Folder $name is opened read-only
372 You can not write to this folder unless you have opened the folder
373 to write or append with new(access), or the "force" option is set
374 true.
375 Error: Invalid timespan '$timespan' specified.
377 The string does not follow the strict rules of the time span syntax
378 which is permitted as parameter.
379 Warning: Message $uidl on POP3 server $name disappeared.
381 The server indicated the existence of this message before, however
382 it has no information about the message anymore.
383 Warning: Message-id '$msgid' does not contain a domain.
385 According to the RFCs, message-ids need to contain a unique random
386 part, then an "@", and then a domain name. This is made to avoid
387 the creation of two messages with the same id. The warning emerges
388 when the "@" is missing from the string.
389 Warning: POP3 folders cannot be deleted.
391 Each user has only one POP3 folder on a server. This folder is
392 created and deleted by the server's administrator only.
393 Error: Package $package does not implement $method.
395 Fatal error: the specific package (or one of its superclasses) does
396 not implement this method where it should. This message means that
397 some other related classes do implement this method however the
398 class at hand does not. Probably you should investigate this and
399 probably inform the author of the package.
400 Error: Unable to create subfolder $name of $folder.
402 The copy includes the subfolders, but for some reason it was not
403 possible to copy one of these. Copying will proceed for all other
404 sub-folders.
405 Error: Update of $nr messages ignored for POP3 folder $name.
407 The standard POP3 implementation does not support writing from
408 client back to the server. Therefore, modifications may be lost.
409 Error: Writing folder $name failed
411 For some reason (you probably got more error messages about this
412 problem) it is impossible to write the folder, although you should
413 because there were changes made.
414 Error: You cannot write a message to a pop server (yet)
416 Some extensions to the POP3 protocol do permit writing messages to
417 the server, but the standard protocol only implements retreival.
418 Feel invited to extend our implementation with writing.
419
421 This module is part of Mail-Box-POP3 distribution version 3.005, built
422 on May 03, 2019. Website: http://perl.overmeer.net/CPAN/
423
425 Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
426 ChangeLog.
427 This program is free software; you can redistribute it and/or modify it
429 under the same terms as Perl itself. See http://dev.perl.org/licenses/
430perl v5.30.1 2020-01-30 Mail::Box::POP3s(3)