Mail::Box::Net(3pm)

1Mail::Box::Net(3)     User Contributed Perl Documentation    Mail::Box::Net(3)
2
3
4

NAME

6       Mail::Box::Net - handle folders which are stored remote.
7

INHERITANCE

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

SYNOPSIS

18        # Do not instantiate this object directly
19

DESCRIPTION

21       At the moment, this object is extended by
22
23       * Mail::Box::POP3
24           Implements the POP3 protocol.
25
26       * Mail::Box::IMAP4
27           Implements the IMAP4 protocol.  UNDER DEVELOPMENT
28

OVERLOADED

30       overload: ""
31
32           See "OVERLOADED" in Mail::Box
33
34       overload: @{}
35
36           See "OVERLOADED" in Mail::Box
37
38       overload: cmp
39
40           See "OVERLOADED" in Mail::Box
41

METHODS

43       Constructors
44
45       Mail::Box::Net->new(OPTIONS)
46
47        Option           --Defined in     --Default
48        access             Mail::Box        'r'
49        body_delayed_type  Mail::Box        Mail::Message::Body::Delayed
50        body_type          Mail::Box        Mail::Message::Body::Lines
51        coerce_options     Mail::Box        []
52        create             Mail::Box        <false>
53        extract            Mail::Box        10240
54        field_type         Mail::Box        undef
55        fix_headers        Mail::Box        <false>
56        folder             Mail::Box        '/'
57        folderdir          Mail::Box        <not used>
58        head_delayed_type  Mail::Box        Mail::Message::Head::Delayed
59        head_type          Mail::Box        Mail::Message::Head::Complete
60        keep_dups          Mail::Box        <false>
61        lock_file          Mail::Box        undef
62        lock_timeout       Mail::Box        1 hour
63        lock_type          Mail::Box        'NONE'
64        lock_wait          Mail::Box        10 seconds
65        locker             Mail::Box        undef
66        log                Mail::Reporter   'WARNINGS'
67        manager            Mail::Box        undef
68        message_type       Mail::Box        Mail::Box::Message
69        multipart_type     Mail::Box        Mail::Message::Body::Multipart
70        password                            undef
71        remove_when_empty  Mail::Box        <false>
72        save_on_exit       Mail::Box        <true>
73        server_name                         undef
74        server_port                         undef
75        trace              Mail::Reporter   'WARNINGS'
76        trusted            Mail::Box        <false>
77        username                            undef
78
79           . access MODE
80
81           . body_delayed_type CLASS
82
83           . body_type CLASS⎪CODE
84
85           . coerce_options ARRAY
86
87           . create BOOLEAN
88
89           . extract INTEGER ⎪ CODE ⎪ METHOD ⎪ 'LAZY'⎪'ALWAYS'
90
91           . field_type CLASS
92
93           . fix_headers BOOLEAN
94
95           . folder FOLDERNAME
96
97           . folderdir DIRECTORY
98
99           . head_delayed_type CLASS
100
101           . head_type CLASS
102
103           . keep_dups BOOLEAN
104
105           . lock_file FILENAME
106
107           . lock_timeout SECONDS
108
109           . lock_type CLASS⎪STRING⎪ARRAY
110
111           . lock_wait SECONDS
112
113           . locker OBJECT
114
115           . log LEVEL
116
117           . manager MANAGER
118
119           . message_type CLASS
120
121           . multipart_type CLASS
122
123           . password STRING
124
125               The password which is required to contact the remote server.
126
127           . remove_when_empty BOOLEAN
128
129           . save_on_exit BOOLEAN
130
131           . server_name HOSTNAME
132
133               The name of the host which contains the remote mail server.
134
135           . server_port INTEGER
136
137               Port number in use by the server application.
138
139           . trace LEVEL
140
141           . trusted BOOLEAN
142
143           . username STRING
144
145               The username which is to be used for the remote server.
146
147       The folder
148
149       $obj->addMessage(MESSAGE, OPTIONS)
150
151           See "The folder" in Mail::Box
152
153       $obj->addMessages(MESSAGE [, MESSAGE, ...])
154
155           See "The folder" in Mail::Box
156
157       Mail::Box::Net->appendMessages(OPTIONS)
158
159           See "The folder" in Mail::Box
160
161       $obj->close(OPTIONS)
162
163           See "The folder" in Mail::Box
164
165       $obj->copyTo(FOLDER, OPTIONS)
166
167           See "The folder" in Mail::Box
168
169       $obj->delete(OPTIONS)
170
171           See "The folder" in Mail::Box
172
173       $obj->folderdir([DIRECTORY])
174
175           Not applicatable for folders on a remote server, so will always
176           return the "undef".
177
178       $obj->name
179
180           See "The folder" in Mail::Box
181
182       $obj->organization
183
184           See "The folder" in Mail::Box
185
186       $obj->size
187
188           See "The folder" in Mail::Box
189
190       $obj->type
191
192           See "The folder" in Mail::Box
193
194       $obj->update(OPTIONS)
195
196           See "The folder" in Mail::Box
197
198       $obj->url
199
200           See "The folder" in Mail::Box
201
202       Folder flags
203
204       $obj->access
205
206           See "Folder flags" in Mail::Box
207
208       $obj->isModified
209
210           See "Folder flags" in Mail::Box
211
212       $obj->modified([BOOLEAN])
213
214           See "Folder flags" in Mail::Box
215
216       $obj->writable
217
218           See "Folder flags" in Mail::Box
219
220       The messages
221
222       $obj->current([NUMBER⎪MESSAGE⎪MESSAGE-ID])
223
224           See "The messages" in Mail::Box
225
226       $obj->find(MESSAGE-ID)
227
228           See "The messages" in Mail::Box
229
230       $obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
231
232           See "The messages" in Mail::Box
233
234       $obj->message(INDEX [,MESSAGE])
235
236           See "The messages" in Mail::Box
237
238       $obj->messageId(MESSAGE-ID [,MESSAGE])
239
240           See "The messages" in Mail::Box
241
242       $obj->messageIds
243
244           See "The messages" in Mail::Box
245
246       $obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
247
248           See "The messages" in Mail::Box
249
250       $obj->nrMessages(OPTIONS)
251
252           See "The messages" in Mail::Box
253
254       $obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
255
256           See "The messages" in Mail::Box
257
258       Sub-folders
259
260       $obj->listSubFolders(OPTIONS)
261
262       Mail::Box::Net->listSubFolders(OPTIONS)
263
264           See "Sub-folders" in Mail::Box
265
266       $obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
267
268       Mail::Box::Net->nameOfSubFolder(SUBNAME, [PARENTNAME])
269
270           See "Sub-folders" in Mail::Box
271
272       $obj->openRelatedFolder(OPTIONS)
273
274           See "Sub-folders" in Mail::Box
275
276       $obj->openSubFolder(SUBNAME, OPTIONS)
277
278           See "Sub-folders" in Mail::Box
279
280       $obj->topFolderWithMessages
281
282       Mail::Box::Net->topFolderWithMessages
283
284           See "Sub-folders" in Mail::Box
285
286       Internals
287
288       $obj->coerce(MESSAGE, OPTIONS)
289
290           See "Internals" in Mail::Box
291
292       $obj->create(FOLDER, OPTIONS)
293
294       Mail::Box::Net->create(FOLDER, OPTIONS)
295
296           Create a new folder on the remote server.
297
298            Option   --Defined in--Default
299            folderdir  Mail::Box   <not used>
300
301           . folderdir DIRECTORY
302
303       $obj->determineBodyType(MESSAGE, HEAD)
304
305           See "Internals" in Mail::Box
306
307       Mail::Box::Net->foundIn([FOLDERNAME], OPTIONS)
308
309           See "Internals" in Mail::Box
310
311       $obj->lineSeparator([STRING⎪'CR'⎪'LF'⎪'CRLF'])
312
313           See "Internals" in Mail::Box
314
315       $obj->locker
316
317           See "Internals" in Mail::Box
318
319       $obj->read(OPTIONS)
320
321           See "Internals" in Mail::Box
322
323       $obj->readMessages(OPTIONS)
324
325           See "Internals" in Mail::Box
326
327       $obj->storeMessage(MESSAGE)
328
329           See "Internals" in Mail::Box
330
331       $obj->toBeThreaded(MESSAGES)
332
333           See "Internals" in Mail::Box
334
335       $obj->toBeUnthreaded(MESSAGES)
336
337           See "Internals" in Mail::Box
338
339       $obj->updateMessages(OPTIONS)
340
341           See "Internals" in Mail::Box
342
343       $obj->write(OPTIONS)
344
345           See "Internals" in Mail::Box
346
347       $obj->writeMessages(OPTIONS)
348
349           See "Internals" in Mail::Box
350
351       Other methods
352
353       $obj->timespan2seconds(TIME)
354
355       Mail::Box::Net->timespan2seconds(TIME)
356
357           See "Other methods" in Mail::Box
358
359       Error handling
360
361       $obj->AUTOLOAD
362
363           See "Error handling" in Mail::Reporter
364
365       $obj->addReport(OBJECT)
366
367           See "Error handling" in Mail::Reporter
368
369       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
370
371       Mail::Box::Net->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL,
372       CALLBACK])
373
374           See "Error handling" in Mail::Reporter
375
376       $obj->errors
377
378           See "Error handling" in Mail::Reporter
379
380       $obj->log([LEVEL [,STRINGS]])
381
382       Mail::Box::Net->log([LEVEL [,STRINGS]])
383
384           See "Error handling" in Mail::Reporter
385
386       $obj->logPriority(LEVEL)
387
388       Mail::Box::Net->logPriority(LEVEL)
389
390           See "Error handling" in Mail::Reporter
391
392       $obj->logSettings
393
394           See "Error handling" in Mail::Reporter
395
396       $obj->notImplemented
397
398           See "Error handling" in Mail::Reporter
399
400       $obj->report([LEVEL])
401
402           See "Error handling" in Mail::Reporter
403
404       $obj->reportAll([LEVEL])
405
406           See "Error handling" in Mail::Reporter
407
408       $obj->trace([LEVEL])
409
410           See "Error handling" in Mail::Reporter
411
412       $obj->warnings
413
414           See "Error handling" in Mail::Reporter
415
416       Cleanup
417
418       $obj->DESTROY
419
420           See "Cleanup" in Mail::Box
421
422       $obj->inGlobalDestruction
423
424           See "Cleanup" in Mail::Reporter
425

DETAILS

DIAGNOSTICS

428       Warning: Changes not written to read-only folder $self.
429
430       You have opened the folder read-only --which is the default set by
431       new(access)--, made modifications, and now want to close it.  Set
432       close(force) if you want to overrule the access mode, or close the
433       folder with close(write) set to "NEVER".
434
435       Error: Copying failed for one message.
436
437       For some reason, for instance disc full, removed by external process,
438       or read-protection, it is impossible to copy one of the messages.
439       Copying will proceed for the other messages.
440
441       Error: Destination folder $name is not writable.
442
443       The folder where the messages are copied to is not opened with write
444       access (see new(access)).  This has no relation with write permission
445       to the folder which is controled by your operating system.
446
447       Warning: Different messages with id $msgid
448
449       The message id is discovered more than once within the same folder, but
450       the content of the message seems to be different.  This should not be
451       possible: each message must be unique.
452
453       Error: Folder $name is opened read-only
454
455       You can not write to this folder unless you have opened the folder to
456       write or append with new(access), or the "force" option is set true.
457
458       Error: Folder $name not deleted: not writable.
459
460       The folder must be opened with write access via new(access), otherwise
461       removing it will be refused.  So, you may have write-access according
462       to the operating system, but that will not automatically mean that this
463       "delete" method permits you to.  The reverse remark is valid as well.
464
465       Error: Invalid timespan '$timespan' specified.
466
467       The string does not follow the strict rules of the time span syntax
468       which is permitted as parameter.
469
470       Warning: Message-id '$msgid' does not contain a domain.
471
472       According to the RFCs, message-ids need to contain a unique random
473       part, then an "@", and then a domain name.  This is made to avoid the
474       creation of two messages with the same id.  The warning emerges when
475       the "@" is missing from the string.
476
477       Error: Package $package does not implement $method.
478
479       Fatal error: the specific package (or one of its superclasses) does not
480       implement this method where it should. This message means that some
481       other related classes do implement this method however the class at
482       hand does not.  Probably you should investigate this and probably
483       inform the author of the package.
484
485       Error: Unable to create subfolder $name of $folder.
486
487       The copy includes the subfolders, but for some reason it was not possi‐
488       ble to copy one of these.  Copying will proceed for all other sub-fold‐
489       ers.
490
491       Error: Writing folder $name failed
492
493       For some reason (you probably got more error messages about this prob‐
494       lem) it is impossible to write the folder, although you should because
495       there were changes made.
496

LICENSE

502       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
503       ChangeLog.
504
505       This program is free software; you can redistribute it and/or modify it
506       under the same terms as Perl itself.  See
507       http://www.perl.com/perl/misc/Artistic.html
508
509
510
511perl v5.8.8                       2007-03-25                 Mail::Box::Net(3)