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
25           Implements the POP3 protocol.
26
27       ·   Mail::Box::IMAP4
28
29           Implements the IMAP4 protocol.  UNDER DEVELOPMENT
30
31       Extends "DESCRIPTION" in Mail::Box.
32

OVERLOADED

34       Extends "OVERLOADED" in Mail::Box.
35
36       overload: ""
37           Inherited, see "OVERLOADED" in Mail::Box
38
39       overload: @{}
40           Inherited, see "OVERLOADED" in Mail::Box
41
42       overload: cmp
43           Inherited, see "OVERLOADED" in Mail::Box
44

METHODS

46       Extends "METHODS" in Mail::Box.
47
48   Constructors
49       Extends "Constructors" in Mail::Box.
50
51       Mail::Box::Net->new(%options)
52            -Option           --Defined in     --Default
53             access             Mail::Box        'r'
54             body_delayed_type  Mail::Box        Mail::Message::Body::Delayed
55             body_type          Mail::Box        Mail::Message::Body::Lines
56             coerce_options     Mail::Box        []
57             create             Mail::Box        <false>
58             extract            Mail::Box        10240
59             field_type         Mail::Box        undef
60             fix_headers        Mail::Box        <false>
61             folder             Mail::Box        '/'
62             folderdir          Mail::Box        <network location>
63             head_delayed_type  Mail::Box        Mail::Message::Head::Delayed
64             head_type          Mail::Box        Mail::Message::Head::Complete
65             keep_dups          Mail::Box        <false>
66             lock_file          Mail::Box        undef
67             lock_timeout       Mail::Box        1 hour
68             lock_type          Mail::Box        'NONE'
69             lock_wait          Mail::Box        10 seconds
70             locker             Mail::Box        undef
71             log                Mail::Reporter   'WARNINGS'
72             manager            Mail::Box        undef
73             message_type       Mail::Box        <folder-class>::Message
74             multipart_type     Mail::Box        Mail::Message::Body::Multipart
75             password                            undef
76             remove_when_empty  Mail::Box        <false>
77             save_on_exit       Mail::Box        <true>
78             server_name                         undef
79             server_port                         undef
80             trace              Mail::Reporter   'WARNINGS'
81             trusted            Mail::Box        <false>
82             username                            undef
83
84           access => MODE
85           body_delayed_type => CLASS
86           body_type => CLASS|CODE
87           coerce_options => ARRAY
88           create => BOOLEAN
89           extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
90           field_type => CLASS
91           fix_headers => BOOLEAN
92           folder => FOLDERNAME
93           folderdir => DIRECTORY
94           head_delayed_type => CLASS
95           head_type => CLASS
96           keep_dups => BOOLEAN
97           lock_file => FILENAME
98           lock_timeout => SECONDS
99           lock_type => CLASS|STRING|ARRAY
100           lock_wait => SECONDS
101           locker => OBJECT
102           log => LEVEL
103           manager => MANAGER
104           message_type => CLASS
105           multipart_type => CLASS
106           password => STRING
107             The password which is required to contact the remote server.
108
109           remove_when_empty => BOOLEAN
110           save_on_exit => BOOLEAN
111           server_name => HOSTNAME
112             The name of the host which contains the remote mail server.
113
114           server_port => INTEGER
115             Port number in use by the server application.
116
117           trace => LEVEL
118           trusted => BOOLEAN
119           username => STRING
120             The username which is to be used for the remote server.
121
122   The folder
123       Extends "The folder" in Mail::Box.
124
125       $obj->addMessage($message, %options)
126           Inherited, see "The folder" in Mail::Box
127
128       $obj->addMessages(@messages)
129           Inherited, see "The folder" in Mail::Box
130
131       Mail::Box::Net->appendMessages(%options)
132           Inherited, see "The folder" in Mail::Box
133
134       $obj->close(%options)
135           Inherited, see "The folder" in Mail::Box
136
137       $obj->copyTo($folder, %options)
138           Inherited, see "The folder" in Mail::Box
139
140       $obj->delete(%options)
141           Inherited, see "The folder" in Mail::Box
142
143       $obj->folderdir( [$directory] )
144           Inherited, see "The folder" in Mail::Box
145
146       $obj->name()
147           Inherited, see "The folder" in Mail::Box
148
149       $obj->organization()
150           Inherited, see "The folder" in Mail::Box
151
152       $obj->size()
153           Inherited, see "The folder" in Mail::Box
154
155       $obj->type()
156           Inherited, see "The folder" in Mail::Box
157
158       $obj->update(%options)
159           Inherited, see "The folder" in Mail::Box
160
161       $obj->url()
162           Inherited, see "The folder" in Mail::Box
163
164   Folder flags
165       Extends "Folder flags" in Mail::Box.
166
167       $obj->access()
168           Inherited, see "Folder flags" in Mail::Box
169
170       $obj->isModified()
171           Inherited, see "Folder flags" in Mail::Box
172
173       $obj->modified( [BOOLEAN] )
174           Inherited, see "Folder flags" in Mail::Box
175
176       $obj->writable()
177           Inherited, see "Folder flags" in Mail::Box
178
179   The messages
180       Extends "The messages" in Mail::Box.
181
182       $obj->current( [$number|$message|$message_id] )
183           Inherited, see "The messages" in Mail::Box
184
185       $obj->find($message_id)
186           Inherited, see "The messages" in Mail::Box
187
188       $obj->findFirstLabeled( $label, [BOOLEAN, [$msgs]] )
189           Inherited, see "The messages" in Mail::Box
190
191       $obj->message( $index, [$message] )
192           Inherited, see "The messages" in Mail::Box
193
194       $obj->messageId( $message_id, [$message] )
195           Inherited, see "The messages" in Mail::Box
196
197       $obj->messageIds()
198           Inherited, see "The messages" in Mail::Box
199
200       $obj->messages( <'ALL'|$range|'ACTIVE'|'DELETED'|$label|
201       !$label|$filter> )
202           Inherited, see "The messages" in Mail::Box
203
204       $obj->nrMessages(%options)
205           Inherited, see "The messages" in Mail::Box
206
207       $obj->scanForMessages($message, $message_ids, $timespan, $window)
208           Inherited, see "The messages" in Mail::Box
209
210   Sub-folders
211       Extends "Sub-folders" in Mail::Box.
212
213       $obj->listSubFolders(%options)
214       Mail::Box::Net->listSubFolders(%options)
215           Inherited, see "Sub-folders" in Mail::Box
216
217       $obj->nameOfSubFolder( $subname, [$parentname] )
218       Mail::Box::Net->nameOfSubFolder( $subname, [$parentname] )
219           Inherited, see "Sub-folders" in Mail::Box
220
221       $obj->openRelatedFolder(%options)
222           Inherited, see "Sub-folders" in Mail::Box
223
224       $obj->openSubFolder($subname, %options)
225           Inherited, see "Sub-folders" in Mail::Box
226
227       $obj->topFolderWithMessages()
228       Mail::Box::Net->topFolderWithMessages()
229           Inherited, see "Sub-folders" in Mail::Box
230
231   Internals
232       Extends "Internals" in Mail::Box.
233
234       $obj->coerce($message, %options)
235           Inherited, see "Internals" in Mail::Box
236
237       $obj->create($folder, %options)
238       Mail::Box::Net->create($folder, %options)
239           Create a new folder on the remote server.
240
241            -Option   --Defined in--Default
242             folderdir  Mail::Box   undef
243
244           folderdir => DIRECTORY
245       $obj->determineBodyType($message, $head)
246           Inherited, see "Internals" in Mail::Box
247
248       Mail::Box::Net->foundIn( [$foldername], %options )
249           Inherited, see "Internals" in Mail::Box
250
251       $obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] )
252           Inherited, see "Internals" in Mail::Box
253
254       $obj->locker()
255           Inherited, see "Internals" in Mail::Box
256
257       $obj->read(%options)
258           Inherited, see "Internals" in Mail::Box
259
260       $obj->readMessages(%options)
261           Inherited, see "Internals" in Mail::Box
262
263       $obj->storeMessage($message)
264           Inherited, see "Internals" in Mail::Box
265
266       $obj->toBeThreaded($messages)
267           Inherited, see "Internals" in Mail::Box
268
269       $obj->toBeUnthreaded($messages)
270           Inherited, see "Internals" in Mail::Box
271
272       $obj->updateMessages(%options)
273           Inherited, see "Internals" in Mail::Box
274
275       $obj->write(%options)
276           Inherited, see "Internals" in Mail::Box
277
278       $obj->writeMessages(%options)
279           Inherited, see "Internals" in Mail::Box
280
281   Other methods
282       Extends "Other methods" in Mail::Box.
283
284       $obj->timespan2seconds($time)
285       Mail::Box::Net->timespan2seconds($time)
286           Inherited, see "Other methods" in Mail::Box
287
288   Error handling
289       Extends "Error handling" in Mail::Box.
290
291       $obj->AUTOLOAD()
292           Inherited, see "Error handling" in Mail::Reporter
293
294       $obj->addReport($object)
295           Inherited, see "Error handling" in Mail::Reporter
296
297       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
298       $callback] )
299       Mail::Box::Net->defaultTrace( [$level]|[$loglevel,
300       $tracelevel]|[$level, $callback] )
301           Inherited, see "Error handling" in Mail::Reporter
302
303       $obj->errors()
304           Inherited, see "Error handling" in Mail::Reporter
305
306       $obj->log( [$level, [$strings]] )
307       Mail::Box::Net->log( [$level, [$strings]] )
308           Inherited, see "Error handling" in Mail::Reporter
309
310       $obj->logPriority($level)
311       Mail::Box::Net->logPriority($level)
312           Inherited, see "Error handling" in Mail::Reporter
313
314       $obj->logSettings()
315           Inherited, see "Error handling" in Mail::Reporter
316
317       $obj->notImplemented()
318           Inherited, see "Error handling" in Mail::Reporter
319
320       $obj->report( [$level] )
321           Inherited, see "Error handling" in Mail::Reporter
322
323       $obj->reportAll( [$level] )
324           Inherited, see "Error handling" in Mail::Reporter
325
326       $obj->trace( [$level] )
327           Inherited, see "Error handling" in Mail::Reporter
328
329       $obj->warnings()
330           Inherited, see "Error handling" in Mail::Reporter
331
332   Cleanup
333       Extends "Cleanup" in Mail::Box.
334
335       $obj->DESTROY()
336           Inherited, see "Cleanup" in Mail::Box
337

DETAILS

339       Extends "DETAILS" in Mail::Box.
340

DIAGNOSTICS

342       Warning: Changes not written to read-only folder $self.
343           You have opened the folder read-only --which is the default set by
344           new(access)--, made modifications, and now want to close it.  Set
345           close(force) if you want to overrule the access mode, or close the
346           folder with close(write) set to "NEVER".
347
348       Error: Copying failed for one message.
349           For some reason, for instance disc full, removed by external
350           process, or read-protection, it is impossible to copy one of the
351           messages.  Copying will proceed for the other messages.
352
353       Error: Destination folder $name is not writable.
354           The folder where the messages are copied to is not opened with
355           write access (see new(access)).  This has no relation with write
356           permission to the folder which is controlled by your operating
357           system.
358
359       Warning: Different messages with id $msgid
360           The message id is discovered more than once within the same folder,
361           but the content of the message seems to be different.  This should
362           not be possible: each message must be unique.
363
364       Error: Folder $name is opened read-only
365           You can not write to this folder unless you have opened the folder
366           to write or append with new(access), or the "force" option is set
367           true.
368
369       Error: Folder $name not deleted: not writable.
370           The folder must be opened with write access via new(access),
371           otherwise removing it will be refused.  So, you may have write-
372           access according to the operating system, but that will not
373           automatically mean that this "delete" method permits you to.  The
374           reverse remark is valid as well.
375
376       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
380       Warning: Message-id '$msgid' does not contain a domain.
381           According to the RFCs, message-ids need to contain a unique random
382           part, then an "@", and then a domain name.  This is made to avoid
383           the creation of two messages with the same id.  The warning emerges
384           when the "@" is missing from the string.
385
386       Error: Package $package does not implement $method.
387           Fatal error: the specific package (or one of its superclasses) does
388           not implement this method where it should. This message means that
389           some other related classes do implement this method however the
390           class at hand does not.  Probably you should investigate this and
391           probably inform the author of the package.
392
393       Error: Unable to create subfolder $name of $folder.
394           The copy includes the subfolders, but for some reason it was not
395           possible to copy one of these.  Copying will proceed for all other
396           sub-folders.
397
398       Error: Writing folder $name failed
399           For some reason (you probably got more error messages about this
400           problem) it is impossible to write the folder, although you should
401           because there were changes made.
402

SEE ALSO

404       This module is part of Mail-Box distribution version 3.006, built on
405       February 15, 2019. Website: http://perl.overmeer.net/CPAN/
406

LICENSE

408       Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
409       ChangeLog.
410
411       This program is free software; you can redistribute it and/or modify it
412       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
413
414
415
416perl v5.28.1                      2019-02-15                 Mail::Box::Net(3)
Impressum