Mercurial > dovecot > core-2.2
changeset 10661:bd06d9b159fa HEAD
imap-client.h: Updated comments.
| author | Timo Sirainen <tss@iki.fi> |
|---|---|
| date | Sun, 07 Feb 2010 17:37:48 +0200 |
| parents | 56b1d4dd9c7d |
| children | 8b138b29dc01 |
| files | src/imap/imap-client.h |
| diffstat | 1 files changed, 5 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- 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);