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 = new Mail::Box::POP3s folder => $ENV{MAIL}, ...;
18
20 This module mainly extends Mail::Box::POP3.
21
23 overload: ""
24 See "OVERLOADED" in Mail::Box
25 overload: @{}
27 See "OVERLOADED" in Mail::Box
28 overload: cmp
30 See "OVERLOADED" in Mail::Box
31
33 Constructors
34 Mail::Box::POP3s->new(OPTIONS)
35 -Option --Defined in --Default
36 access Mail::Box 'r'
37 authenticate Mail::Box::POP3 'AUTO'
38 body_delayed_type Mail::Box Mail::Message::Body::Delayed
39 body_type Mail::Box Mail::Message::Body::Lines
40 coerce_options Mail::Box []
41 create Mail::Box <not applicable>
42 extract Mail::Box 10240
43 field_type Mail::Box undef
44 fix_headers Mail::Box <false>
45 folder Mail::Box <not applicable>
46 folderdir Mail::Box <not used>
47 head_delayed_type Mail::Box Mail::Message::Head::Delayed
48 head_type Mail::Box Mail::Message::Head::Complete
49 keep_dups Mail::Box <false>
50 lock_file Mail::Box undef
51 lock_timeout Mail::Box 1 hour
52 lock_type Mail::Box 'NONE'
53 lock_wait Mail::Box 10 seconds
54 locker Mail::Box undef
55 log Mail::Reporter 'WARNINGS'
56 manager Mail::Box undef
57 message_type Mail::Box Mail::Box::POP3::Message
58 multipart_type Mail::Box Mail::Message::Body::Multipart
59 password Mail::Box::Net undef
60 pop_client Mail::Box::POP3 undef
61 remove_when_empty Mail::Box <false>
62 save_on_exit Mail::Box <true>
63 server_name Mail::Box::Net undef
64 server_port Mail::Box::Net 995
65 trace Mail::Reporter 'WARNINGS'
66 trusted Mail::Box <false>
67 username Mail::Box::Net undef
68 access => MODE
70 authenticate => 'LOGIN'|'APOP'|'AUTO'
71 body_delayed_type => CLASS
72 body_type => CLASS|CODE
73 coerce_options => ARRAY
74 create => BOOLEAN
75 extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
76 field_type => CLASS
77 fix_headers => BOOLEAN
78 folder => FOLDERNAME
79 folderdir => DIRECTORY
80 head_delayed_type => CLASS
81 head_type => CLASS
82 keep_dups => BOOLEAN
83 lock_file => FILENAME
84 lock_timeout => SECONDS
85 lock_type => CLASS|STRING|ARRAY
86 lock_wait => SECONDS
87 locker => OBJECT
88 log => LEVEL
89 manager => MANAGER
90 message_type => CLASS
91 multipart_type => CLASS
92 password => STRING
93 pop_client => OBJECT
94 remove_when_empty => BOOLEAN
95 save_on_exit => BOOLEAN
96 server_name => HOSTNAME
97 server_port => INTEGER
98 trace => LEVEL
99 trusted => BOOLEAN
100 username => STRING
101 The folder
103 $obj->addMessage(MESSAGE)
104 See "METHODS" in Mail::Box::POP3
105 $obj->addMessages(MESSAGES)
107 See "METHODS" in Mail::Box::POP3
108 Mail::Box::POP3s->appendMessages(OPTIONS)
110 See "The folder" in Mail::Box
111 $obj->close(OPTIONS)
113 See "The folder" in Mail::Box
114 $obj->copyTo(FOLDER, OPTIONS)
116 See "The folder" in Mail::Box
117 $obj->delete(OPTIONS)
119 See "METHODS" in Mail::Box::POP3
120 $obj->folderdir([DIRECTORY])
122 See "METHODS" in Mail::Box::Net
123 $obj->name
125 See "The folder" in Mail::Box
126 $obj->organization
128 See "The folder" in Mail::Box
129 $obj->size
131 See "The folder" in Mail::Box
132 $obj->type
134 See "The folder" in Mail::Box
135 $obj->update
137 See "METHODS" in Mail::Box::POP3
138 $obj->url
140 See "The folder" in Mail::Box
141 Folder flags
143 $obj->access
144 See "Folder flags" in Mail::Box
145 $obj->isModified
147 See "Folder flags" in Mail::Box
148 $obj->modified([BOOLEAN])
150 See "Folder flags" in Mail::Box
151 $obj->writable
153 See "Folder flags" in Mail::Box
154 The messages
156 $obj->current([NUMBER|MESSAGE|MESSAGE-ID])
157 See "The messages" in Mail::Box
158 $obj->find(MESSAGE-ID)
160 See "The messages" in Mail::Box
161 $obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
163 See "The messages" in Mail::Box
164 $obj->message(INDEX [,MESSAGE])
166 See "The messages" in Mail::Box
167 $obj->messageId(MESSAGE-ID [,MESSAGE])
169 See "The messages" in Mail::Box
170 $obj->messageIds
172 See "The messages" in Mail::Box
173 $obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
175 See "The messages" in Mail::Box
176 $obj->nrMessages(OPTIONS)
178 See "The messages" in Mail::Box
179 $obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
181 See "The messages" in Mail::Box
182 Sub-folders
184 $obj->listSubFolders(OPTIONS)
185 Mail::Box::POP3s->listSubFolders(OPTIONS)
186 See "METHODS" in Mail::Box::POP3
188 $obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
190 Mail::Box::POP3s->nameOfSubFolder(SUBNAME, [PARENTNAME])
191 See "Sub-folders" in Mail::Box
193 $obj->openRelatedFolder(OPTIONS)
195 See "Sub-folders" in Mail::Box
196 $obj->openSubFolder(OPTIONS)
198 See "METHODS" in Mail::Box::POP3
199 $obj->topFolderWithMessages
201 Mail::Box::POP3s->topFolderWithMessages
202 See "Sub-folders" in Mail::Box
204 Internals
206 $obj->coerce(MESSAGE, OPTIONS)
207 See "Internals" in Mail::Box
208 $obj->create(FOLDER, OPTIONS)
210 Mail::Box::POP3s->create(FOLDER, OPTIONS)
211 See "METHODS" in Mail::Box::POP3
213 $obj->determineBodyType(MESSAGE, HEAD)
215 See "Internals" in Mail::Box
216 Mail::Box::POP3s->foundIn([FOLDERNAME], OPTIONS)
218 See "Internals" in Mail::Box
219 $obj->getHead(MESSAGE)
221 See "Internals" in Mail::Box::POP3
222 $obj->getHeadAndBody(MESSAGE)
224 See "Internals" in Mail::Box::POP3
225 $obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
227 See "Internals" in Mail::Box
228 $obj->locker
230 See "Internals" in Mail::Box
231 $obj->popClient(OPTIONS)
233 See "Internals" in Mail::Box::POP3
234 $obj->read(OPTIONS)
236 See "Internals" in Mail::Box
237 $obj->readMessages(OPTIONS)
239 See "Internals" in Mail::Box
240 $obj->storeMessage(MESSAGE)
242 See "Internals" in Mail::Box
243 $obj->toBeThreaded(MESSAGES)
245 See "Internals" in Mail::Box
246 $obj->toBeUnthreaded(MESSAGES)
248 See "Internals" in Mail::Box
249 $obj->updateMessages(OPTIONS)
251 See "Internals" in Mail::Box
252 $obj->write(OPTIONS)
254 See "Internals" in Mail::Box
255 $obj->writeMessages(OPTIONS)
257 See "Internals" in Mail::Box::POP3
258 Other methods
260 $obj->timespan2seconds(TIME)
261 Mail::Box::POP3s->timespan2seconds(TIME)
262 See "Other methods" in Mail::Box
264 Error handling
266 $obj->AUTOLOAD
267 See "Error handling" in Mail::Reporter
268 $obj->addReport(OBJECT)
270 See "Error handling" in Mail::Reporter
271 $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
273 Mail::Box::POP3s->defaultTrace([LEVEL]|[LOGLEVEL,
274 TRACELEVEL]|[LEVEL, CALLBACK])
275 See "Error handling" in Mail::Reporter
277 $obj->errors
279 See "Error handling" in Mail::Reporter
280 $obj->log([LEVEL [,STRINGS]])
282 Mail::Box::POP3s->log([LEVEL [,STRINGS]])
283 See "Error handling" in Mail::Reporter
285 $obj->logPriority(LEVEL)
287 Mail::Box::POP3s->logPriority(LEVEL)
288 See "Error handling" in Mail::Reporter
290 $obj->logSettings
292 See "Error handling" in Mail::Reporter
293 $obj->notImplemented
295 See "Error handling" in Mail::Reporter
296 $obj->report([LEVEL])
298 See "Error handling" in Mail::Reporter
299 $obj->reportAll([LEVEL])
301 See "Error handling" in Mail::Reporter
302 $obj->trace([LEVEL])
304 See "Error handling" in Mail::Reporter
305 $obj->warnings
307 See "Error handling" in Mail::Reporter
308 Cleanup
310 $obj->DESTROY
311 See "Cleanup" in Mail::Box
312 $obj->inGlobalDestruction
314 See "Cleanup" in Mail::Reporter
315
317 Error: Cannot create POP3 client for $name.
318 The connection to the POP3 server cannot be established. You may
319 see more, related, error messages about the failure.
320 Error: Cannot find head back for $uidl on POP3 server $name.
322 The server told to have this message, but when asked for its
323 headers, no single line was returned. Did the message get
324 destroyed?
325 Error: Cannot read body for $uidl on POP3 server $name.
327 The message's headers are retreived from the server, but the body
328 seems to be lost. Did the message get destroyed between reading
329 the header and reading the body?
330 Warning: Changes not written to read-only folder $self.
332 You have opened the folder read-only --which is the default set by
333 new(access)--, made modifications, and now want to close it. Set
334 close(force) if you want to overrule the access mode, or close the
335 folder with close(write) set to "NEVER".
336 Error: Copying failed for one message.
338 For some reason, for instance disc full, removed by external
339 process, or read-protection, it is impossible to copy one of the
340 messages. Copying will proceed for the other messages.
341 Error: Destination folder $name is not writable.
343 The folder where the messages are copied to is not opened with
344 write access (see new(access)). This has no relation with write
345 permission to the folder which is controled by your operating
346 system.
347 Warning: Different messages with id $msgid
349 The message id is discovered more than once within the same folder,
350 but the content of the message seems to be different. This should
351 not be possible: each message must be unique.
352 Error: Folder $name is opened read-only
354 You can not write to this folder unless you have opened the folder
355 to write or append with new(access), or the "force" option is set
356 true.
357 Error: Invalid timespan '$timespan' specified.
359 The string does not follow the strict rules of the time span syntax
360 which is permitted as parameter.
361 Warning: Message $uidl on POP3 server $name disappeared.
363 The server indicated the existence of this message before, however
364 it has no information about the message anymore.
365 Warning: Message-id '$msgid' does not contain a domain.
367 According to the RFCs, message-ids need to contain a unique random
368 part, then an "@", and then a domain name. This is made to avoid
369 the creation of two messages with the same id. The warning emerges
370 when the "@" is missing from the string.
371 Warning: POP3 folders cannot be deleted.
373 Each user has only one POP3 folder on a server. This folder is
374 created and deleted by the server's administrator only.
375 Error: Package $package does not implement $method.
377 Fatal error: the specific package (or one of its superclasses) does
378 not implement this method where it should. This message means that
379 some other related classes do implement this method however the
380 class at hand does not. Probably you should investigate this and
381 probably inform the author of the package.
382 Error: Unable to create subfolder $name of $folder.
384 The copy includes the subfolders, but for some reason it was not
385 possible to copy one of these. Copying will proceed for all other
386 sub-folders.
387 Error: Update of $nr messages ignored for POP3 folder $name.
389 The standard POP3 implementation does not support writing from
390 client back to the server. Therefore, modifications may be lost.
391 Error: Writing folder $name failed
393 For some reason (you probably got more error messages about this
394 problem) it is impossible to write the folder, although you should
395 because there were changes made.
396 Error: You cannot write a message to a pop server (yet)
398 Some extensions to the POP3 protocol do permit writing messages to
399 the server, but the standard protocol only implements retreival.
400 Feel invited to extend our implementation with writing.
401
403 This module is part of Mail-Box distribution version 2.097, built on
404 January 26, 2011. Website: http://perl.overmeer.net/mailbox/
405
407 Copyrights 2001-2011 by Mark Overmeer. For other contributors see
408 ChangeLog.
409 This program is free software; you can redistribute it and/or modify it
411 under the same terms as Perl itself. See
412 http://www.perl.com/perl/misc/Artistic.html
413perl v5.12.3 2011-01-26 Mail::Box::POP3s(3)