# HG changeset patch
# User Timo Sirainen <tss@iki.fi>
# Date 1265557068 -7200
# Node ID bd06d9b159fa9bf25025f971e0a9c1af95bd1e6f
# Parent  56b1d4dd9c7d8720cb0532a9b3ca3558274a06a7
imap-client.h: Updated comments.

diff -r 56b1d4dd9c7d -r bd06d9b159fa src/imap/imap-client.h
--- a/src/imap/imap-client.h	Sun Feb 07 17:30:24 2010 +0200
+++ b/src/imap/imap-client.h	Sun Feb 07 17:37:48 2010 +0200
@@ -164,10 +164,13 @@
 /* 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);