lib-storage: API comment update

diff --git a/src/lib-storage/mail-storage.h b/src/lib-storage/mail-storage.h
index 7c54047cb78610f3bd03609a49311ac7e195e7ed..6997a074e3cfdf099bcfb9542e1de507904d535f 100644 (file)
--- a/src/lib-storage/mail-storage.h
+++ b/src/lib-storage/mail-storage.h
@@ -870,7 +870,10 @@ int mail_get_headers(struct mail *mail, const char *field,
    Do not use for structured fields (see mail_get_first_header_utf8()). */
 int mail_get_headers_utf8(struct mail *mail, const char *field,
                          const char *const **value_r);
-/* Returns stream containing specified headers. */
+/* Returns stream containing specified headers. The returned stream will be
+   automatically freed when the mail is closed, or when another
+   mail_get_header_stream() call is made (so you can't have multiple header
+   streams open at the same time). */
 int mail_get_header_stream(struct mail *mail,
                           struct mailbox_header_lookup_ctx *headers,
                           struct istream **stream_r);