dovecot-2.0: mail-storage.h comments updated.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.0/rev/d48456c46a49
changeset: 12220:d48456c46a49
user:      Timo Sirainen <tss at iki.fi>
date:      Fri Oct 01 16:19:10 2010 +0100
description:
mail-storage.h comments updated.

diffstat:

 src/lib-storage/mail-storage.h |  4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diffs (21 lines):

diff -r 0da6f86c0ef5 -r d48456c46a49 src/lib-storage/mail-storage.h
--- a/src/lib-storage/mail-storage.h	Fri Oct 01 16:14:08 2010 +0100
+++ b/src/lib-storage/mail-storage.h	Fri Oct 01 16:19:10 2010 +0100
@@ -254,6 +254,7 @@
 	unsigned int has_nuls:1; /* message data is known to contain NULs */
 	unsigned int has_no_nuls:1; /* -''- known to not contain NULs */
 
+	/* If the lookup is aborted, error is set to MAIL_ERROR_NOTPOSSIBLE */
 	enum mail_lookup_abort lookup_abort;
 };
 
@@ -641,7 +642,8 @@
    Also multiline headers are returned unfolded. */
 int mail_get_first_header_utf8(struct mail *mail, const char *field,
 			       const char **value_r);
-/* Return a NULL-terminated list of values for each found field. */
+/* Return a NULL-terminated list of values for each found field.
+   Returns -1 if error, 0 otherwise (with or without headers found). */
 int mail_get_headers(struct mail *mail, const char *field,
 		     const char *const **value_r);
 /* Like mail_get_headers(), but decode MIME encoded words to UTF-8.