[Bps-public-commit] r18904 - in Net-IMAP-Server: lib/Net/IMAP lib/Net/IMAP/Server
alexmv at bestpractical.com
alexmv at bestpractical.com
Sat Mar 21 15:01:24 EDT 2009
Author: alexmv
Date: Sat Mar 21 15:01:23 2009
New Revision: 18904
Modified:
Net-IMAP-Server/ (props changed)
Net-IMAP-Server/lib/Net/IMAP/Server.pm
Net-IMAP-Server/lib/Net/IMAP/Server/Command.pm
Net-IMAP-Server/lib/Net/IMAP/Server/Connection.pm
Net-IMAP-Server/lib/Net/IMAP/Server/DefaultAuth.pm
Net-IMAP-Server/lib/Net/IMAP/Server/DefaultModel.pm
Net-IMAP-Server/lib/Net/IMAP/Server/Mailbox.pm
Net-IMAP-Server/lib/Net/IMAP/Server/Message.pm
Log:
r43565 at kohr-ah: chmrr | 2009-03-21 15:01:16 -0400
Documentation typo fixes
Modified: Net-IMAP-Server/lib/Net/IMAP/Server.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server.pm (original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server.pm Sat Mar 21 15:01:23 2009
@@ -103,7 +103,7 @@
defaults to the current user. Note that privileges are dropped after
binding to the port and reading the certificates, so escalated
privileges should not be needed. Running as your C<nobody> user or
-equivilent is suggested.
+equivalent is suggested.
=item group
@@ -128,7 +128,7 @@
=item auth_idle
-How long, in seconds, to wait before disconnecting authentiated
+How long, in seconds, to wait before disconnecting authenticated
connections. By RFC specification, this B<must> be longer than 30
minutes. The default is an hour; set to zero to disable.
@@ -184,7 +184,7 @@
Starts the server; this method shouldn't be expected to return.
Within this method, C<$Net::IMAP::Server::Server> is set to the object
-that this was called on; thus, all IMAP objecst have a way of
+that this was called on; thus, all IMAP objects have a way of
referring to the server -- and though L</connection>, whatever parts
of the IMAP internals they need.
Modified: Net-IMAP-Server/lib/Net/IMAP/Server/Command.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/Command.pm (original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/Command.pm Sat Mar 21 15:01:23 2009
@@ -82,7 +82,7 @@
=head2 has_literal
Analyzes the options line, and returns true if the line has literals
-(as defined in the FRC, a literal is of the form C<{42}>). If the
+(as defined in the RFC, a literal is of the form C<{42}>). If the
line has literals, installs a L<Net::IMAP::Server::Connection/pending>
callback to continue the parsing, and returns true.
@@ -183,7 +183,7 @@
=head2 options_str
-Returns the flat string represetnation of the options the client gave.
+Returns the flat string representation of the options the client gave.
=cut
@@ -196,7 +196,7 @@
=item *
-Array references are converted into "paranthesized lists," and each
+Array references are converted into "parenthesized lists," and each
element is recursively output.
=item *
@@ -213,11 +213,11 @@
=item *
-Purely numerical scalra values are output with no change
+Purely numerical scalar values are output with no change
=item *
-All other scalar values are ouput within quotes.
+All other scalar values are output within quotes.
=back
@@ -284,8 +284,8 @@
=head2 poll_after
-Returns a true value if the command should send untagged updates abou
-tthe selected mailbox after the command completes. Defaults to always
+Returns a true value if the command should send untagged updates about
+the selected mailbox after the command completes. Defaults to always
true.
=cut
@@ -362,7 +362,7 @@
=head2 bad_command REASON
Sends any untagged updates to the client using L</send_untagged>, then
-sents a tagged C<BAD> response with the given C<REASON>.
+sends a tagged C<BAD> response with the given C<REASON>.
=cut
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 Sat Mar 21 15:01:23 2009
@@ -54,7 +54,7 @@
=head2 coro
Returns the L<Coro> process associated with this connection. For
-things interacting with this conneciton, it will probably be the
+things interacting with this connection, it will probably be the
current coroutine, except for interactions coming from event loops.
=head2 io_handle
@@ -294,7 +294,7 @@
=head2 parse_command LINE
-Parses the line into the C<tag>, C<ommand>, and C<options>. Returns
+Parses the line into the C<tag>, C<command>, and C<options>. Returns
undef if parsing fails for some reason.
=cut
@@ -431,13 +431,13 @@
if ( $args{expunged} ) {
-# Make sure that they know of at least the existance of what's being expunged.
+# Make sure that they know of at least the existence of what's being expunged.
my $max = 0;
$max = $max < $_ ? $_ : $max for @{ $self->untagged_expunge };
$self->untagged_response("$max EXISTS")
if $max > $self->previous_exists;
- # Send the expnges, clear out the temporary message store
+ # Send the expunges, clear out the temporary message store
$self->previous_exists(
$self->previous_exists - @{ $self->untagged_expunge } );
$self->untagged_response( map {"$_ EXPUNGE"}
@@ -562,7 +562,7 @@
=head2 out STRING
-Sends the mesage to the client. If the client's connection has
+Sends the message to the client. If the client's connection has
dropped, or the send fails for whatever reason, L</close> the
connection and then die, which is caught by L</handle_lines>.
Modified: Net-IMAP-Server/lib/Net/IMAP/Server/DefaultAuth.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/DefaultAuth.pm (original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/DefaultAuth.pm Sat Mar 21 15:01:23 2009
@@ -15,8 +15,8 @@
IMAP credentials are passed in one of two ways: using the L<LOGIN>
command, or the C<AUTHENTICATE> command. L<LOGIN> sends the password
-unencrpyted; note, however, that L<Net::IMAP::Server> will not allow
-the LOGIN command unless the connection is protected by eiher SSL or
+unencrypted; note, however, that L<Net::IMAP::Server> will not allow
+the LOGIN command unless the connection is protected by either SSL or
TLS. Thus, even when the C<LOGIN> command is used, the password is
not sent in the clear.
@@ -75,7 +75,7 @@
=head2 sasl_plain
Called when the client requests C<PLAIN> SASL authentication. This
-parses the SASL protocal, and defers to L</auth_plain> to determine if
+parses the SASL protocol, and defers to L</auth_plain> to determine if
the username and password is actually allowed to log in.
=cut
@@ -94,7 +94,7 @@
=head1 IMPLEMENTING NEW SASL METHODS
The L</sasl_plain> method is a simple example of implementing a SASL
-protocol, albeat a very simple one. SASL authentication methods
+protocol, albeit a very simple one. SASL authentication methods
should expect to be called with no arguments, and should return an
anonymous function, which will be called each time the client
transmits more information.
@@ -103,8 +103,8 @@
already have been base-64 decoded (the exception being the first time
it is called, when it will be called with the empty string).
-If the fnuction returns a scalar reference, the scalar will be base-64
-encoded and transmitted to the client. Anthing which is not a scalar
+If the function returns a scalar reference, the scalar will be base-64
+encoded and transmitted to the client. Anything which is not a scalar
reference will be interpreted as a boolean, as to whether the
authentication was successful. Successful authentications should be
sure to set L</user> themselves.
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 Sat Mar 21 15:01:23 2009
@@ -44,7 +44,7 @@
=head2 init
Called when the class is instantiated, with no arguments. Subclasses
-should override this methtod to inspect the L</auth> object, and
+should override this method to inspect the L</auth> object, and
determine what folders the user should have. The primary purpose of
this method is to set L</root> to the top level of the mailbox tree.
The root is expected to contain a mailbox named C<INBOX>.
@@ -72,7 +72,7 @@
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
+method is responsible for setting up the appropriate root mailbox, and
all sub-mailboxes for the model.
=head2 auth
@@ -94,7 +94,7 @@
=head2 split PATH
Utility method which splits a given C<PATH> according to the mailbox
-separator, as determinded by the
+separator, as determined by the
L<Net::IMAP::Server::Mailbox/separator> of the L</root>. May C<die>
if the path (which is expected to be encoded using IMAP-UTF-7) is
invalid. See L<Encode::IMAPUTF7>.
Modified: Net-IMAP-Server/lib/Net/IMAP/Server/Mailbox.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/Mailbox.pm (original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/Mailbox.pm Sat Mar 21 15:01:23 2009
@@ -141,7 +141,7 @@
=head3 add_message MESSAGE
-Adds the gven L<Net::IMAP::Server::Message> C<MESSAGE> to the mailbox,
+Adds the given L<Net::IMAP::Server::Message> C<MESSAGE> to the mailbox,
setting its L<Net::IMAP::Server::Message/sequence> and
L<Net::IMAP::Server::Message/mailbox>.
L<Net::IMAP::Server::Message/uid> is set to L</uidnext> if the message
@@ -211,7 +211,7 @@
=head3 reparent MAILBOX
Reparents this mailbox to be a child of the given
-L<Net::IMAP::Server::Mailbox> C<MAILBOX>. Shold return 0 if the
+L<Net::IMAP::Server::Mailbox> C<MAILBOX>. Should return 0 if the
reparenting is denied or fails.
=cut
Modified: Net-IMAP-Server/lib/Net/IMAP/Server/Message.pm
==============================================================================
--- Net-IMAP-Server/lib/Net/IMAP/Server/Message.pm (original)
+++ Net-IMAP-Server/lib/Net/IMAP/Server/Message.pm Sat Mar 21 15:01:23 2009
@@ -62,7 +62,7 @@
=head2 internaldate [STRING]
-Gets ot sets the string representing when the message was recieved by
+Gets or sets the string representing when the message was received by
the server. According to RFC specification, this must be formatted as
C<01-Jan-2008 15:42 -0500>.
@@ -70,7 +70,7 @@
Marks the message as expunged -- this is called by
L<Net::IMAP::Server::Mailbox/expunge>, which deals with actually
-removing the mesage from the appropriate places..
+removing the message from the appropriate places..
=cut
@@ -277,7 +277,7 @@
=head2 fetch SPEC
-Takes C<SPEC>, which is either a string or an array refence of
+Takes C<SPEC>, which is either a string or an array reference of
strings, and returns a list of strings or data structures which match
the specification. The specification is defined by section 7.4.2 of
RFC 3501.
@@ -424,7 +424,7 @@
if ( $data->{discrete} eq "multipart" ) {
- # The first element is a binch of lists, which looks like
+ # The first element is a bunch of lists, which looks like
# (...)(...) -- note the lack of space! RFC 3501, how do we
# hate thee. Make the mime structures, hack them into the
# IMAP format, concat them, and insert their reference so they
More information about the Bps-public-commit
mailing list