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

[alexmv at bestpractical.com]

Author: alexmv
Date: Thu Apr 16 23:42:29 2009
New Revision: 19267

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

Log:
 r44372 at kohr-ah:  chmrr | 2009-04-16 19:46:14 -0400
 Documentation of "BAD message" and "NO message" via die()


Modified: Net-IMAP-Server/lib/Net/IMAP/Server/Connection.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/Connection.pm	(original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/Connection.pm	Thu Apr 16 23:42:29 2009
@@ -212,7 +212,12 @@
 
 Handles a single line from the client.  This is not quite the same as
 handling a command, because of client literals and continuation
-commands.
+commands.  This also handles dispatch of client commands to
+L<Net::IMAP::Server::Command> subclasses (see L</class_for>).
+
+Any errors generated while running commands will cause a C<NO Server
+error> to be sent to the client -- unless the error message starts
+with C<NO> or c<BAD>, in which case it will be relayed to the client.
 
 =cut
 
@@ -259,7 +264,8 @@
 
 =head2 class_for COMMAND
 
-Returns the package name that implements the given C<COMMAND>.
+Returns the package name that implements the given C<COMMAND>.  See
+L<Net::IMAP::Server/add_command>.
 
 =cut
 

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	Thu Apr 16 23:42:29 2009
@@ -25,6 +25,10 @@
 subclasses are expected to override L</init> to set up their folder
 structure.
 
+Methods in the model can C<die> with messages which start with "NO" or
+"BAD", which will be propagated back to the client immediately.  See
+L<Net::IMAP::Server::Connection/handle_command>.
+
 =head1 METHODS
 
 =head2 new