From: Timo Sirainen <tss@iki.fi>
Date: Fri, 1 Oct 2010 15:19:10 +0000 (+0100)
Subject: mail-storage.h comments updated.
X-Git-Tag: 2.0.5~11
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fa8f3c6818f6b900e078c8b0378abad486fadecb;p=thirdparty%2Fdovecot%2Fcore.git

mail-storage.h comments updated.
---

diff --git a/src/lib-storage/mail-storage.h b/src/lib-storage/mail-storage.h
index 9755b5a799..f68f79ff1a 100644
--- a/src/lib-storage/mail-storage.h
+++ b/src/lib-storage/mail-storage.h
@@ -254,6 +254,7 @@ struct mail {
 	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 @@ int mail_get_first_header(struct mail *mail, const char *field,
    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.