Mercurial > dovecot > core-2.2
changeset 16957:63a9b750027b
lib-storage: API comment update
| author | Timo Sirainen <tss@iki.fi> |
|---|---|
| date | Sat, 16 Nov 2013 19:35:10 +0200 |
| parents | 03bf99704fe5 |
| children | 00fc1e040603 |
| files | src/lib-storage/mail-storage.h |
| diffstat | 1 files changed, 4 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/lib-storage/mail-storage.h Sat Nov 16 19:34:57 2013 +0200 +++ b/src/lib-storage/mail-storage.h Sat Nov 16 19:35:10 2013 +0200 @@ -870,7 +870,10 @@ 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);