1Mail::Box::Net(3) User Contributed Perl Documentation Mail::Box::Net(3)
2
6 Mail::Box::Net - handle folders which are stored remote.
7
9 Mail::Box::Net
10 is a Mail::Box
11 is a Mail::Reporter
12 Mail::Box::Net is extended by
14 Mail::Box::IMAP4
15 Mail::Box::POP3
16
18 # Do not instantiate this object directly
19
21 At the moment, this object is extended by
22 · Mail::Box::POP3
24 Implements the POP3 protocol.
26 · Mail::Box::IMAP4
28 Implements the IMAP4 protocol. UNDER DEVELOPMENT
30
32 overload: ""
33 See "OVERLOADED" in Mail::Box
34 overload: @{}
36 See "OVERLOADED" in Mail::Box
37 overload: cmp
39 See "OVERLOADED" in Mail::Box
40
42 Constructors
43 Mail::Box::Net->new(OPTIONS)
44 -Option --Defined in --Default
45 access Mail::Box 'r'
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 <false>
50 extract Mail::Box 10240
51 field_type Mail::Box undef
52 fix_headers Mail::Box <false>
53 folder Mail::Box '/'
54 folderdir Mail::Box <not used>
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::Message
66 multipart_type Mail::Box Mail::Message::Body::Multipart
67 password undef
68 remove_when_empty Mail::Box <false>
69 save_on_exit Mail::Box <true>
70 server_name undef
71 server_port undef
72 trace Mail::Reporter 'WARNINGS'
73 trusted Mail::Box <false>
74 username undef
75 access => MODE
77 body_delayed_type => CLASS
78 body_type => CLASS|CODE
79 coerce_options => ARRAY
80 create => BOOLEAN
81 extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
82 field_type => CLASS
83 fix_headers => BOOLEAN
84 folder => FOLDERNAME
85 folderdir => DIRECTORY
86 head_delayed_type => CLASS
87 head_type => CLASS
88 keep_dups => BOOLEAN
89 lock_file => FILENAME
90 lock_timeout => SECONDS
91 lock_type => CLASS|STRING|ARRAY
92 lock_wait => SECONDS
93 locker => OBJECT
94 log => LEVEL
95 manager => MANAGER
96 message_type => CLASS
97 multipart_type => CLASS
98 password => STRING
99 The password which is required to contact the remote server.
100 remove_when_empty => BOOLEAN
102 save_on_exit => BOOLEAN
103 server_name => HOSTNAME
104 The name of the host which contains the remote mail server.
105 server_port => INTEGER
107 Port number in use by the server application.
108 trace => LEVEL
110 trusted => BOOLEAN
111 username => STRING
112 The username which is to be used for the remote server.
113 The folder
115 $obj->addMessage(MESSAGE, OPTIONS)
116 See "The folder" in Mail::Box
117 $obj->addMessages(MESSAGE [, MESSAGE, ...])
119 See "The folder" in Mail::Box
120 Mail::Box::Net->appendMessages(OPTIONS)
122 See "The folder" in Mail::Box
123 $obj->close(OPTIONS)
125 See "The folder" in Mail::Box
126 $obj->copyTo(FOLDER, OPTIONS)
128 See "The folder" in Mail::Box
129 $obj->delete(OPTIONS)
131 See "The folder" in Mail::Box
132 $obj->folderdir([DIRECTORY])
134 Not applicatable for folders on a remote server, so will always
135 return the "undef".
136 $obj->name
138 See "The folder" in Mail::Box
139 $obj->organization
141 See "The folder" in Mail::Box
142 $obj->size
144 See "The folder" in Mail::Box
145 $obj->type
147 See "The folder" in Mail::Box
148 $obj->update(OPTIONS)
150 See "The folder" in Mail::Box
151 $obj->url
153 See "The folder" in Mail::Box
154 Folder flags
156 $obj->access
157 See "Folder flags" in Mail::Box
158 $obj->isModified
160 See "Folder flags" in Mail::Box
161 $obj->modified([BOOLEAN])
163 See "Folder flags" in Mail::Box
164 $obj->writable
166 See "Folder flags" in Mail::Box
167 The messages
169 $obj->current([NUMBER|MESSAGE|MESSAGE-ID])
170 See "The messages" in Mail::Box
171 $obj->find(MESSAGE-ID)
173 See "The messages" in Mail::Box
174 $obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
176 See "The messages" in Mail::Box
177 $obj->message(INDEX [,MESSAGE])
179 See "The messages" in Mail::Box
180 $obj->messageId(MESSAGE-ID [,MESSAGE])
182 See "The messages" in Mail::Box
183 $obj->messageIds
185 See "The messages" in Mail::Box
186 $obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
188 See "The messages" in Mail::Box
189 $obj->nrMessages(OPTIONS)
191 See "The messages" in Mail::Box
192 $obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
194 See "The messages" in Mail::Box
195 Sub-folders
197 $obj->listSubFolders(OPTIONS)
198 Mail::Box::Net->listSubFolders(OPTIONS)
199 See "Sub-folders" in Mail::Box
201 $obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
203 Mail::Box::Net->nameOfSubFolder(SUBNAME, [PARENTNAME])
204 See "Sub-folders" in Mail::Box
206 $obj->openRelatedFolder(OPTIONS)
208 See "Sub-folders" in Mail::Box
209 $obj->openSubFolder(SUBNAME, OPTIONS)
211 See "Sub-folders" in Mail::Box
212 $obj->topFolderWithMessages
214 Mail::Box::Net->topFolderWithMessages
215 See "Sub-folders" in Mail::Box
217 Internals
219 $obj->coerce(MESSAGE, OPTIONS)
220 See "Internals" in Mail::Box
221 $obj->create(FOLDER, OPTIONS)
223 Mail::Box::Net->create(FOLDER, OPTIONS)
224 Create a new folder on the remote server.
226 -Option --Defined in--Default
228 folderdir Mail::Box <not used>
229 folderdir => DIRECTORY
231 $obj->determineBodyType(MESSAGE, HEAD)
232 See "Internals" in Mail::Box
233 Mail::Box::Net->foundIn([FOLDERNAME], OPTIONS)
235 See "Internals" in Mail::Box
236 $obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
238 See "Internals" in Mail::Box
239 $obj->locker
241 See "Internals" in Mail::Box
242 $obj->read(OPTIONS)
244 See "Internals" in Mail::Box
245 $obj->readMessages(OPTIONS)
247 See "Internals" in Mail::Box
248 $obj->storeMessage(MESSAGE)
250 See "Internals" in Mail::Box
251 $obj->toBeThreaded(MESSAGES)
253 See "Internals" in Mail::Box
254 $obj->toBeUnthreaded(MESSAGES)
256 See "Internals" in Mail::Box
257 $obj->updateMessages(OPTIONS)
259 See "Internals" in Mail::Box
260 $obj->write(OPTIONS)
262 See "Internals" in Mail::Box
263 $obj->writeMessages(OPTIONS)
265 See "Internals" in Mail::Box
266 Other methods
268 $obj->timespan2seconds(TIME)
269 Mail::Box::Net->timespan2seconds(TIME)
270 See "Other methods" in Mail::Box
272 Error handling
274 $obj->AUTOLOAD
275 See "Error handling" in Mail::Reporter
276 $obj->addReport(OBJECT)
278 See "Error handling" in Mail::Reporter
279 $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
281 Mail::Box::Net->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL,
282 CALLBACK])
283 See "Error handling" in Mail::Reporter
285 $obj->errors
287 See "Error handling" in Mail::Reporter
288 $obj->log([LEVEL [,STRINGS]])
290 Mail::Box::Net->log([LEVEL [,STRINGS]])
291 See "Error handling" in Mail::Reporter
293 $obj->logPriority(LEVEL)
295 Mail::Box::Net->logPriority(LEVEL)
296 See "Error handling" in Mail::Reporter
298 $obj->logSettings
300 See "Error handling" in Mail::Reporter
301 $obj->notImplemented
303 See "Error handling" in Mail::Reporter
304 $obj->report([LEVEL])
306 See "Error handling" in Mail::Reporter
307 $obj->reportAll([LEVEL])
309 See "Error handling" in Mail::Reporter
310 $obj->trace([LEVEL])
312 See "Error handling" in Mail::Reporter
313 $obj->warnings
315 See "Error handling" in Mail::Reporter
316 Cleanup
318 $obj->DESTROY
319 See "Cleanup" in Mail::Box
320 $obj->inGlobalDestruction
322 See "Cleanup" in Mail::Reporter
323
325 Warning: Changes not written to read-only folder $self.
326 You have opened the folder read-only --which is the default set by
327 new(access)--, made modifications, and now want to close it. Set
328 close(force) if you want to overrule the access mode, or close the
329 folder with close(write) set to "NEVER".
330 Error: Copying failed for one message.
332 For some reason, for instance disc full, removed by external
333 process, or read-protection, it is impossible to copy one of the
334 messages. Copying will proceed for the other messages.
335 Error: Destination folder $name is not writable.
337 The folder where the messages are copied to is not opened with
338 write access (see new(access)). This has no relation with write
339 permission to the folder which is controled by your operating
340 system.
341 Warning: Different messages with id $msgid
343 The message id is discovered more than once within the same folder,
344 but the content of the message seems to be different. This should
345 not be possible: each message must be unique.
346 Error: Folder $name is opened read-only
348 You can not write to this folder unless you have opened the folder
349 to write or append with new(access), or the "force" option is set
350 true.
351 Error: Folder $name not deleted: not writable.
353 The folder must be opened with write access via new(access),
354 otherwise removing it will be refused. So, you may have write-
355 access according to the operating system, but that will not
356 automatically mean that this "delete" method permits you to. The
357 reverse remark is valid as well.
358 Error: Invalid timespan '$timespan' specified.
360 The string does not follow the strict rules of the time span syntax
361 which is permitted as parameter.
362 Warning: Message-id '$msgid' does not contain a domain.
364 According to the RFCs, message-ids need to contain a unique random
365 part, then an "@", and then a domain name. This is made to avoid
366 the creation of two messages with the same id. The warning emerges
367 when the "@" is missing from the string.
368 Error: Package $package does not implement $method.
370 Fatal error: the specific package (or one of its superclasses) does
371 not implement this method where it should. This message means that
372 some other related classes do implement this method however the
373 class at hand does not. Probably you should investigate this and
374 probably inform the author of the package.
375 Error: Unable to create subfolder $name of $folder.
377 The copy includes the subfolders, but for some reason it was not
378 possible to copy one of these. Copying will proceed for all other
379 sub-folders.
380 Error: Writing folder $name failed
382 For some reason (you probably got more error messages about this
383 problem) it is impossible to write the folder, although you should
384 because there were changes made.
385
387 This module is part of Mail-Box distribution version 2.097, built on
388 January 26, 2011. Website: http://perl.overmeer.net/mailbox/
389
391 Copyrights 2001-2011 by Mark Overmeer. For other contributors see
392 ChangeLog.
393 This program is free software; you can redistribute it and/or modify it
395 under the same terms as Perl itself. See
396 http://www.perl.com/perl/misc/Artistic.html
397perl v5.12.3 2011-01-26 Mail::Box::Net(3)