aboutsummaryrefslogtreecommitdiffstats
path: root/fetchmail.h
diff options
context:
space:
mode:
authorMatthias Andree <matthias.andree@gmx.de>2022-10-12 23:43:33 +0200
committerMatthias Andree <matthias.andree@gmx.de>2022-10-12 23:43:33 +0200
commit06716e9aa549a9e24b4cfe4b25e94e1a439a645d (patch)
tree8cc90e2d9c13e8f7fe04bd0916c30687c540a95a /fetchmail.h
parentb9282e7658c50b21e3c23726f8f6f262db79ec9c (diff)
downloadfetchmail-06716e9aa549a9e24b4cfe4b25e94e1a439a645d.tar.gz
fetchmail-06716e9aa549a9e24b4cfe4b25e94e1a439a645d.tar.bz2
fetchmail-06716e9aa549a9e24b4cfe4b25e94e1a439a645d.zip
Document close_sink return value logic.
TRUE means successful delivery to SMTP/LMTP/MDA, => delete mail on upstream POP3/IMAP server.
Diffstat (limited to 'fetchmail.h')
-rw-r--r--fetchmail.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/fetchmail.h b/fetchmail.h
index a1b77468..a7edaf3f 100644
--- a/fetchmail.h
+++ b/fetchmail.h
@@ -587,7 +587,7 @@ char *rcpt_address(struct query *, const char *, int);
int stuffline(struct query *, char *);
int open_sink(struct query*, struct msgblk *, int*, int*);
void release_sink(struct query *);
-int close_sink(struct query *, struct msgblk *, flag);
+int close_sink(struct query *, struct msgblk *, flag); /**< \returns TRUE for successful delivery and FALSE for failure. */
int open_warning_by_mail(struct query *);
#if defined(HAVE_STDARG_H)
void stuff_warning(const char *,