[Bps-public-commit] r16401 - in Net-IMAP-Server: lib/Net/IMAP/Server

[alexmv at bestpractical.com]

Author: alexmv
Date: Mon Oct 20 16:30:24 2008
New Revision: 16401

Modified:
   Net-IMAP-Server/   (props changed)
   Net-IMAP-Server/lib/Net/IMAP/Server/DefaultModel.pm

Log:
 r38396 at kohr-ah:  chmrr | 2008-10-20 16:28:12 -0400
  * Add missing doc for root and auth of model


Modified: Net-IMAP-Server/lib/Net/IMAP/Server/DefaultModel.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/DefaultModel.pm	(original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/DefaultModel.pm	Mon Oct 20 16:30:24 2008
@@ -64,6 +64,20 @@
     return $self;
 }
 
+=head2 root MAILBOX
+
+Gets or sets the root L<Net::IMAP::Server::Mailbox> for this model.
+The root mailbox should contain no messages, and have no name -- it
+exists purely to contain sub-mailboxes, like C<INBOX>.  The L</init>
+method is resposible for setting up the appropriate root mailbox, and
+all sub-mailboxes for the model.
+
+=head2 auth
+
+Returns the L<Net::IMAP::Server::DefaultAuth> object for this model;
+this is set by the connection when the model is created, and will
+always reference a valid authentication object.
+
 =head2 close
 
 Called when this model's connection closes, for any reason.  By