Box::Net(3)

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

CLASS HIERARCHY
 Mail::Box::Net
 is a Mail::Box
 is a Mail::Reporter

SYNOPSIS
 # Do not instantiate this object yourself

DESCRIPTION
This documentation describes how directory organized mailboxes work. Please read "Mail::Box-Overview" first.

At the moment, this object is extended by

* MH
* Maildir

METHOD INDEX
Methods prefixed with an abbreviation are described in Mail::Box (MB), Mail::Reporter (MR).

The general methods for "Mail::Box::Net" objects:

   MB addMessage  MESSAGE               MB messageId MESSAGE-ID [,MESS...
   MB addMessages MESSAGE [, MESS...    MB messageIds
   MB close OPTIONS                     MB messages ['ALL',RANGE,'ACTI...
   MB copyTo FOLDER, OPTIONS            MB modified [BOOLEAN]
   MB create FOLDERNAME [, OPTIONS]     MB name
   MB current [NUMBER|MESSAGE|MES...       new OPTIONS
   MB delete                            MB openSubFolder NAME [,OPTIONS]
   MR errors                            MR report [LEVEL]
   MB find MESSAGE-ID                   MR reportAll [LEVEL]
   MB listSubFolders OPTIONS            MR trace [LEVEL]
   MB locker                            MR warnings
   MR log [LEVEL [,STRINGS]]            MB writable
   MB message INDEX [,MESSAGE]

The extra methods for extension writers:

   MR AUTOLOAD                          MB organization
   MB DESTROY                           MB read OPTIONS
   MB appendMessages OPTIONS            MB readMessages OPTIONS
   MB clone OPTIONS                     MB scanForMessages MESSAGE, ME...
   MB coerce MESSAGE                    MB sort PREPARE, COMPARE, LIST
   MB determineBodyType MESSAGE, ...    MB storeMessage MESSAGE
   MB folderdir [DIR]                   MB timespan2seconds TIME
   MB foundIn [FOLDERNAME], OPTIONS     MB toBeThreaded MESSAGES
   MR inGlobalDestruction               MB toBeUnthreaded MESSAGES
   MB lineSeparator [STRING|'CR'|...    MB update OPTIONS
   MR logPriority LEVEL                 MB updateMessages OPTIONS
   MR logSettings                       MB write OPTIONS
   MR notImplemented                    MB writeMessages
   MB openRelatedFolder OPTIONS

METHODS

new OPTIONS
    Create a new folder. The are many options which are taken from other objects. For some, different options are set. For MH-specific options see below, but first the full list.

     OPTION            DEFINED BY         DEFAULT
     access            Mail::Box          'r'
     create            Mail::Box          0
     folder            Mail::Box          $ENV{MAIL}
     folderdir         Mail::Box          undef
     head_wrap         Mail::Box          72
     keep_dups         Mail::Box          0
     extract           Mail::Box          10kB
     lock_type         Mail::Box          'DOTLOCK'
     lock_file         Mail::Box          foldername.'/.lock'
     lock_timeout      Mail::Box          3600    (1 hour)
     lock_wait         Mail::Box          10      (seconds)
     log               Mail::Reporter     'WARNINGS'
     password          Mail::Box::Net     undef
     remove_when_empty Mail::Box          1
     save_on_exit      Mail::Box          1
     server_name       Mail::Box::Net     undef
     server_port       Mail::Box::Net     undef
     trace             Mail::Reporter     'WARNINGS'
     trusted           Mail::Box          <depends on folder location>
     username          Mail::Box::Net     undef

    Only useful to write extension to "Mail::Box::Net". Common users of folders you will not specify these:

     OPTION            DEFINED BY         DEFAULT
     body_type         Mail::Box::Net     'Mail::Message::Body::Lines'
     body_delayed_type Mail::Box          'Mail::Message::Body::Delayed'
     coerce_options    Mail::Box          []
     field_type        Mail::Box          undef
     head_type         Mail::Box          'Mail::Message::Head::Complete'
     head_delayed_type Mail::Box          'Mail::Message::Head::Delayed'
     locker            Mail::Box          undef
     multipart_type    Mail::Box          'Mail::Message::Body::Multipart'
     manager           Mail::Box          undef
     message_type      Mail::Box          'Mail::Box::Net::Message'
     realhead_type     Mail::Box          'Mail::Message::Head'

    For each of the following options, extensions of this class may have usefull defaults.

    * hostname => HOSTNAME
        The name of the host which contains the remote mail server.

    * password => STRING
        The password which is required to contact the remote server.

    * username => STRING
        The username which is to be used for the remote server.

    * port => INTEGER
        Portnumber in use by the server application.

SEE ALSO
Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR
Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION
This code is beta, version 2.018.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.