imap-client.h: Updated comments.

--HG--
branch : HEAD

diff --git a/src/imap/imap-client.h b/src/imap/imap-client.h
index 40818dd00b385b2a6b93dc05c7f67a70fb4db292..dff070828b54c0ee4113088c2f8884e399f495b4 100644 (file)
--- a/src/imap/imap-client.h
+++ b/src/imap/imap-client.h
@@ -164,10 +164,13 @@ void client_disconnect_with_error(struct client *client, const char *msg);
 /* Send a line of data to client. Returns 1 if ok, 0 if buffer is getting full,
    -1 if error */
 int client_send_line(struct client *client, const char *data);
-/* Send line of data to client, prefixed with client->tag */
+/* Send line of data to client, prefixed with client->tag. You need to prefix
+   the data with "OK ", "NO " or "BAD ". */
 void client_send_tagline(struct client_command_context *cmd, const char *data);
 
-/* Send BAD command error to client. msg can be NULL. */
+/* Send a BAD command reply to client via client_send_tagline(). If there have
+   been too many command errors, the client is disconnected. msg may be NULL,
+   in which case the error is looked up from imap_parser. */
 void client_send_command_error(struct client_command_context *cmd,
                               const char *msg);