Fetchmail Release Notes ======================= This file is in Unicode charset with UTF-8 encoding. All dates are in Universal Time unless otherwise noted. (The `lines' figures total .c, .h, .l, and .y files under version control. Abbreviations in parentheses are the maintainers who committed the respective change. MA = Matthias Andree, ESR = Eric S. Raymond, RF = Rob Funk.) # ADVANCE WARNING OF FEATURES TO BE REMOVED OR CHANGED IN FUTURE VERSIONS (There are no plans to remove features from a 6.3.X release, but they may be removed from a 6.4.0 or newer release.) * The MX and host alias DNS lookups that fetchmail performs in multidrop mode are based on assumptions that are rarely met in practice, somewhat defective, deprecated and may be removed from a future fetchmail version. They have never supported IPv6 (including IPv6-mapped IPv4). Non-DNS based alias keywords such as "aka" will remain in fetchmail. * The monitor and interface options may be removed from a future fetchmail version as they are not reasonably portable across operating systems. * POP2 is obsolete, support will be removed from a future fetchmail version. * RPOP is obsolete, support will be removed from a future fetchmail release. * --sslcertck will become a default setting in a future fetchmail version. * The multidrop To/Cc guessing code along with the fragile duplicate suppressor is deprecated and may be removed from a future release. * The "envelope Received" option may be removed from a future release, because the Received header was never meant to be machine-readable, the format varies widely, and various other differences in behavior make parsing Received an unreliable undertaking. The envelope option as such will remain though, in order to support Delivered-To, X-Envelope-To, X-Original-To and similar. See also . * The --enable-fallback (fall back to MDA if MTA unavailable) will be removed from a future fetchmail release, because it makes fetchmail's behavior inconsistent and confusing. * The "protocol auto" default inside fetchmail may be removed from a future fetchmail release. Explicit configuration of the protocol is recommended. * Kerberos IV support may be removed from a future fetchmail release. * SIGHUP wakeup support may be removed from a future fetchmail release and cause fetchmail to terminate - it was broken for many years. * Support for operating systems that are not sufficiently POSIX compliant may be removed or operation on such systems may be suboptimal for future releases. This means that fetchmail may only continue to work on C99 and POSIX 2001 based systems. * The maintainer may migrate fetchmail to C++ with STL or C#, and impose further requirements (dependencies), such as Boost or other class libraries. * The softbounce option default will change to "false" in the next release. -------------------------------------------------------------------------------- fetchmail 6.3.13 (released 2009-10-30, 25333 LoC): # REGRESSION FIXES * The multiline SMTP error fix in release 6.3.12 caused fetchmail to lose message codes 400..599 and treat all of these as temporary error. This would cause messages to be left on the server even if softbounce was turned off. Reported by Thomas Jarosch. # TRANSLATION UPDATES * [cs] Czech, by Petr Pisar * [zh_CN] Chinese (simplified), by Ji ZhengYu * [nl] Dutch, by Erwin Poeze * [id] Indonesian, by Andhika Padmawan * [ja] Japanese, by Takeshi Hamasaki * [pl] Polish, by Jakub Bogusz * [es] Spanish (Castilian), by Franciso Molinero * [vi] Vietnamese, by Clytie Siddall fetchmail 6.3.12 (released 2009-10-05): # REGRESSION FIXES * The CVS-2009-2666 fix in fetchmail release 6.3.11 caused a free() of unallocated memory on SSL connections, which caused crashes or program aborts on some systems (depending on how initialization and free() of unallocated memory is handled in compiler and libc). Workaround for older versions: run in verbose mode. Patch courtesy of Thomas Heinz, fixes Gentoo Bug #280760. This regression affected only the 6.3.11 release, but not the patch that was part of the security announcement fetchmail-SA-2009-01. # BUG FIXES * Fix error reporting for GSSAPI on Heimdal (h5l) Kerberos. * Look for MD5_Init in libcrypto rather than libssl, fixes Gentoo Kerberos builds; fixes upstream parts of Gentoo Bugs #231400 and #185652, and fixes BerliOS Bug #16134. * Report multiline SMTP errors properly, reported by Earl Chew; fixes Debian Bug #569899, reported by Akihiro Terasaki. Note: This fix introduced a regression, fixed in 6.3.13. * Replace control characters in SMTP replies by '?'. * Fetchmailconf: Fix descriptions for smtpaddress and smtpname options; smtpaddress is for RCPT TO, not MAIL FROM. Found by Gerard Seibert. # TRANSLATION UPDATES AND ADDITIONS (ordered by language name): * [ca] Catalan (Ernest Adrogué Calveras) * [zh_CN] Chinese/Simplified (Ji ZhengYu) * [cs] Czech (Petr Pisar) * [ja] Japanese (Takeshi Hamasaki) * [pl] Polish (Jakub Bogusz) * [es] Spanish/Castilian (Francisco Molinero) * [vi] Vietnamese (Clytie Siddall) fetchmail 6.3.11 (released 2009-08-06): # SECURITY BUGFIXES * CVE-2009-2666: SSL NUL prefix impersonation attack through NULs in a part of a X.509 certificate's CommonName and subjectAltName fields. These fields use opaque strings with a separate length field, so that the NUL character isn't a special character inside the certificate. Fetchmail, being written in the C language, used to treat these strings as C strings nonetheless, so that the domain comparison would end at the first embedded NUL character, rather than at the real end of the string. Fetchmail will now abort certificate verification as failed if NULs are encountered inside either of these fields regardless of their position, and drop the connection even if --sslcertck is not used, because NUL is not a valid character in legitimate DNS names. See fetchmail-SA-2009-01.txt for details, including a minimal patch. # BUGFIXES * Remove the spurious message "message delimiter found while scanning headers". RFC-5322 syntax states that the delimiter is part of the body, and the body is optional. * Convert all non-printable characters in certificate Subject/Issuer Common Name or Subject Alternative Name fields to ANSI-C hex escapes (\xnn, where nn are hex digits). Note that this change introduces a regression, fixed in 6.3.12. See the 6.3.12 documentation above for details and a workaround. # TRANSLATION UPDATES AND ADDITIONS (ordered by language name): * [zh_CN] Chinese/Simplified (Ji ZhengYu) * [es] Spanish/Castilian (Francisco Molinero) fetchmail 6.3.10 (released 2009-07-02): # INCOMPATIBLE BUGFIXES AND CHANGES * Fetchmail no longer drops permanently undelivered messages by default, to match historic documentation. It does this by adding a new "softbounce" option, see below. Fixes Debian Bug#471283, demotes Debian Bug#494418 to wishlist. * There is a new "softbounce" global option that prevents the deletion of messages that have not been forwarded. It defaults to "true" for fetchmail 6.3.X in order to match historic documentation. This may change its default in the next major release. # BUGFIXES * Fix misuse of canonical autoconf target as _TARGET when it should have been _HOST. Report and patch courtesy of Diego E. "Flameeyes" Pettenò. Details: http://blog.flameeyes.eu/2009/01/01/the-canonical-target * Do not lose PS_MAXFETCH (13) exit status when hitting maxpoll. Reported by Michelle Konzack, Debian Bug#508667. * Do not overlap source and destination fields in snprintf() in interface.c. Courtesy of Nico Golde, Debian. * When a pre- or post-connect command fails, now report the exit status or termination signal properly through sys/wait.h macros. * When acquiring a body, understand NIL ("no such data item"), as returned by some MS Exchange versions. Fixes BerliOS Bug #11980 by KB Sriram. * Make progress tickers (-v/--showdots) consistent, and update documentation accordingly ("." for each 1024 octets read, "#" for a header written, and "*" for each body line written.) The conditions under which these had been printed were inconsistent, illogical, and documentation hadn't matched real behaviour for long. * For NTLM authentication, use dynamically allocated buffers. Fixes Debian Bug#449179, reported by Stepan Golosunov. * Non-delivery notice ("bounce mail") now mentions the original reason again, before the address list. This fixes a regression introduced in 6.3.0. * Several compiler warnings were fixed. * The minimum recommended SMTP (RFC-5321) timeouts are enforced to leave sufficient time for the listener to respond. Some synchronous listeners, particularly when used with spam filtering and other policy enforcement services, take extended amounts of time to process messages after the sender, recipient, or data block and EOM line. This can cause fetchmail to not wait long enough for the "250 Ok" and make fetchmail believe the message wasn't properly delivered when in fact it was; fetchmail would then retry the download next time and never make progress. Fixes Berlios Bug #10972, reported by Viktor Binzberger. * The ESMTP/LMTP client will now apply an application-specific timeout while waiting for the EHLO/LHLO response, rather than wait for the server or TCP connection timeout. * Treat 530 errors as temporary, so as not to delete messages on configuration errors. Partially taken from Petr Cerny's patch in Novell Bugzilla #246829. The 501 part of said patch was not added, as the maintainer is not convinced 501 is a temporary condition, and softbounce takes care of this anyways. # CHANGES * Make the comparison of the SSL fingerprints case insensitive, to ease its use. Suggested by Daniel Richard G. * Proper precedence ordering for the syslog and logfile options. If the logfile option is effective (i. e. we're in daemon mode and nodetach isn't used), reset the syslog option. If logfile is ineffective (we're not in daemon mode, or nodetach is set), syslog takes precedence. * The sleeping at/awakened at messages appear in logfiles and syslog only if verbose mode is enabled. On the console, they will still appear without verbose mode. Fixes Debian Bug#282259. * fetchmail only requests IPv6 addresses via name service if at least one is configured on the local host, likewise for IPv4. (AI_ADDRCONFIG flag to getaddrinfo()) Extended version of Redhat's patch. * If the server name contains "yahoo.com", offers the "ID" capability, and we're polling via IMAP, send an ID ("guid" "1") transaction first, ignoring its result. This appears needed to be able to log into Yahoo's Zimbra servers, but there are open issues (such as being only able to download one message and server certificate mismatches). # CHANGES TO CONTRIB * Fix bashism in contrib/fetchsetup. Fixes Debian Bug#530081. # DOCUMENTATION * Some parts of the the manual page were revised for clarity, accuracy, and updated recommendations (particularly SSL/TLS) and formatting conventions from man-pages(7). * The README and README.SSL documents were updated. * A document, README.SSL-SERVER, was added to describe server-side requirements for proper SSL and/or TLS service offerings. These are not specific to fetchmail. * Documentation on how to make "NOMAIL" (exit code 1) not treated an error has been added to the EXIT CODES section of the manpage and to the FAQ as item C8. The suggested solution uses a tiny POSIX shell script fragment. Fixes Debian Bug #530749, filed by Reuben Thomas. # TRANSLATION UPDATES AND ADDITIONS (ordered by language name): * [cs] Czech (Petr Pisar) * [en_GB] English/British * [de] German * [id] Indonesian (Andhika Padmawan) * [it] Italian (Vincenzo Campanella) * [ja] Japanese (Takeshi Hamasaki) * [pl] Polish (Jakub Bogusz) * [ru] Russian (Pavel Maryanov), fixing Debian Bug #531925 * [es] Spanish/Castilian (Francisco Molinero) * [zh_CN] Chinese/Simplified (Ji ZhengYu) fetchmail 6.3.9 (released 2008-11-16): # SECURITY AND CRITICAL BUG FIXES: * CVE-2007-4565: Denial of service: When fetchmail tries to inject a warning message it created itself, and the message is refused by the SMTP listener, fetchmail dereferences a NULL pointer and crashes. Report & fix by Earl Chew. Note while this is theoretically a remote denial of service attack vector, fetchmail by default talks SMTP to the localhost, so the overall risk is rather low. This bug was apparently introduced on 1998-11-27 when the bouncemail facility was modularized. The bug then made its appearance in fetchmail release 4.6.8. See also fetchmail-SA-2007-02.txt. * CVE-2008-2711: Denial of service: When fetchmail logs data blobs (for instance, a To: header in -v -v verbose mode) in excess of 2048 bytes, it will crash, because it hands an uninitialized argument pointer (not the format string though) to vsnprintf and reads a random memory location (it calls va_arg() too often without resetting it with va_start()). Based on a patch (BerliOS patch #2492) by Petr Uzel, fixes Novell Bug #354291. Note 6.3.9-rc1 did not completely fix this issue, so it was redrawn a few hours after its release. See also fetchmail-SA-2008-01.txt. * When expunging, mark the right messages as seen to avoid message loss in "keep flush" configurations. Workaround for previous versions: "expunge 0". Report and patch by Alexander Cherepanov - thanks a lot, Berlios Bug #11797, "imap_mark_seen doesn't consider expunged messages". * SSL fix: close memory leak when SSL connection fails; fetchmail used to forget calling SSL_free() on the SSL context, leaking in excess of 500 kB RAM on a x86_64 system per failed SSL connection attempt. Bug reported and patch provided by Seiichi Ikarashi, Fujitsu. # BUG FIXES: * The configure script will additionally check for 'dn_skipname', to fix build failures with µClibc. The new check still recognizes the resolver libraries on Ubuntu 7.04, openSUSE 10.2, Solaris 8, NetBSD 4.0_BETA2 and FreeBSD 6.2. Fixes Gentoo bug #134187. NOTE: this is a bit of a hack, since we twist the HAVE_RES_SEARCH result, but res_search() and dn_skipname() are only used together and scheduled for removal in future versions, so this is probably fine. * No longer complain about invalid sslproto "" when POP3 CAPA probe fails. Fixes Debian Bug#421446 (Holger Leskien), Novell Bug #247233 (Jon Nelson). Thanks to Matthias Strauß for a configuration to reproduce the issue. * Allow .fetchmailrc and .fetchids to be symlinks, as the manpage does not document they aren't allowed - fixes Debian Bug #452907 (Roger Leigh). TOCTOU race persists. * fetchmailconf quotes mailbox (folder) names when writing the configuration. Fixes BerliOS Bug #13207 (reported + fix suggested by Terry Brown). * Only print "Deleting fetchids file" if there actually is one. Fixes Debian Bug#374514, reported by Dan Jacobson. * SSL fix: check and report if SSL_set_fd fails. # CHANGES: * autoconf 2.60 is now required to build fetchmail; it uses AC_USE_SYSTEM_EXTENSIONS to replace AC_AIX, AC_MINIX, and the like. * Removed dead FETCHMAIL_DEBUG code from fetchmail.h that was disabled by default with no switches in configure to enable it. However, the macro would have been prone to a symlink attack. Found by Nico Golde. * Removed dead FORCE_STUFFING code from socket.c that was disabled by default with no switches in configure to enable it. * Include the typedef for int16 in the #ifndef _AIX in smbencrypt.c (Peter O'Gorman) * Correct check for u_int32_t in configure.ac (seems to be typedef'ed in namser.h on some platforms.) (Peter O'Gorman) * In configure.ac change all CPFLAGS to CPPFLAGS, CEFLAGS to CFLAGS and LDEFLAGS to LDFLAGS otherwise the results of some tests (additional -L and -I flags) do not get used for later tests causing incorrect configure results. Makefile.am was also changed to reflect this. (Peter O'Gorman) * m4/gethostbyname_r.m4 does AC_TRY_COMPILE, which unfortunately can pass even if there is no gethostbyname_r. Changed to AC_TRY_LINK. (Peter O'Gorman) * Revise getnameinfo check to ensure NULL is defined and the result is properly evaluated, to avoid bogus results on for instance FreeBSD and redefinitions of NI_* at compile time. (Matthias Andree). * __attribute__ ((unused)) is a gccism, removed from libesmtp/gethostbyname.c. (Peter O'Gorman) * In KAME/getnameinfo.c it's best to use the correct argument to inet_ntoa. (Peter O'Gorman) * In verbose mode, log if --check mode is enabled. * Add sslcommonname option (rcfile and commandline) as a way to work around misconfigured upstream SSL servers that use the wrong certificate name. It specifies which CommonName fetchmail expects and logs. (Daniel Richard G.) * Changed CRLF to LF line endings in contrib/delete-later (reporter: Petr Uzel) * SSL change: enable all workarounds with SSL_CTX_set_options(ctx,SSL_OP_ALL) * All translations have been re-enabled, in an attempt to rekindle translator or user interest. # DOCUMENTATION: * Add fetchmail-SA-2007-02.txt and fetchmail-SA-2008-01.txt. * Re-add two lines to the manual page that had accidentally become comments to nroff. One was part of the --sslproto documentation, and one in the "Awakening the background daemon" section. * The manual page no longer asserts that .fetchids were for exclusive POP3 use, since it is planned to use the file with IMAP4 later. * Add grammar fixes from Dan Jacobson to fetchmail.man. Debian Bug #461642. * The manual page now mentions that user descriptions need to come before user options. Reported by Francensco Pontortì, to fix Debian Bug #467010. * The manual page no longer hints that multi-user declarations per server were only useful in daemon mode running as root, to avoid hinting people to doing that. * Several manual page rcfile examples now include "ssl". * The manual page hints that option arguments beginning with numbers can be enclosed in quotes. * The manual page now mentions that the --logfile must already exist before fetchmail is run. * The FAQ now recommends (#I9) not to use Google Mail for their disregard to the protocols they claim to support. * Documentation and program output now /consistently/ claim that the rcfile must not have more than 0700 (u=rwx,g=,o=) permissions, but fetchmail will still silently accept additional g=x permissions for compatibility with previous 6.2.X and 6.3.X versions. Inconsistency (program 0710, manpage 0600) reported by Petr Uzel. * The --logfile documentation is now clearer about requiring detached daemon mode. # TRANSLATION UPDATES AND ADDITIONS (ordered by language name): * [sq] Albanian (Besnik Bleta) * [zh_CN] Chinese, simplified (Ji Zheng-Yu) * [cs] Czech (Petr Pisar) * [da] Danish (Byrial Ole Jensen) - outdated, but newer than in 6.3.8 * [nl] Dutch (Tony Vroon, Benno Schulenberg) * [en_GB] English, British * [fi] Finnish (Lauri Nurmi) * [de] German * [id] Indonesian (Andhika Padmawan) * [ja] Japanese (Takeshi Hamasaki) * [pl] Polish (Jakub Bogusz) * [ru] Russian (Pavel Maryanov) * [es] Spanish (Javier Fernández-Sanguino Peña, Matthias Andree) * [tr] Turkish (Engin Gündüz) - outdated, but newer than in 6.3.8 * [vi] Vietnamese (Clytie Siddall) fetchmail 6.3.8 (released 2007-04-06): # SECURITY STRENGTHENING: * Make the APOP challenge parser more distrustful and have it reject challenges that do not conform to RFC-822 msg-id format, in the hope to make mounting man-in-the-middle attacks (MITM) against APOP a bit more difficult. (CVE-2007-1558, reported by Gaëtan Leurent, published 2007-04-02 on Bugtraq) APOP is claimed insecure by Gaëtan Leurent for MITM scenarios for typical setups: based on MD5 collisions, it is purportedly possible to recover the first three characters of the shared secret (password), which would then make recovery of the shared secret a matter of hours or minutes; this would then enable the attacker to impersonate the client vis-à-vis the server. For further details, check * Gaëtan Leurent, "Message Freedom in MD4 and MD5 Collisions: Application to APOP", Fast Software Encryption 2007, Luxembourg. (Proceedings to appear in Springer's Lecture Notes on Computer Science.) * The mailing list discussion thread at # BUG FIXES: * Fix pluralization of oversized-message warning mails. * Fix manual page: --sslcheck -> --sslcertck, and do not set trailing "recommended:" in bold. Fixes Debian Bug #413059, reported by Rafal Czlonka. * Repoll immediately if a protocol error happens during the authentication attempt after a failed opportunistic TLS upgrade. Fixes comment #9 in Gentoo Bug #163782, reported by Takuto Matsuu. * Fix rendering of the "24 - 26, 28, 29" paragraph in the exit codes section. Reported by Nico Golde. * If SOCKS support was compiled in, add 'socks' to the feature_options Python list emitted in --configdump. Reported by Rob MacGregor. * Do not crash with a null pointer dereference when opening the BSMTP file fails. Improve error checking and reporting. Reported by Reto Schüttel, Debian Bug#416625. Fix based on a patch by Nico Golde. * Make BSMTP output actually work, it would persistently fail with SOCKET error after writing the first header. Bug independently found and reported in excellent detail by Reto Schüttel, Debian Bug#416812. # DOCUMENTATION: * Add fetchmail-SA-2007-01.txt * Extend --mda documentation, discourage use of qmail-inject. Based on a patch by Rob MacGregor. * Document SOCKS configuration facility (SOCKS_CONF environment variable). Thanks to Jochen Hayek, Michael Shuldman and Rob MacGregor. * Use envelope option in multidrop example. Patch by Rob MacGregor. * Document expected Received: line format when parsing for envelope addressees. * Stripped option documentation from sample.rcfile, since this is bound to go out of synch with the manual page, which is the only reference on options. * Mention that --limit default is 0 bytes, which is special for "no limit". * Corrected Robert M. Funk's name that I misspelled. My sincere apologies -- Matthias Andree. # CONTRIB: * Add delete-later and delete-later.README, a script and documentation for a MySQL/Tcl-based client-side "delete-after" feature. Kindly donated by Yoo GmbH, Großvoigtsberg, Germany (Carsten Ralle). # KNOWN BUGS AND WORKAROUNDS: (this section floats upwards through the NEWS file so it stays with the current release information) * fetchmail does not handle messages without Message-ID header well (See sourceforge.net bug #780933) * BSMTP is mostly untested and errors can cause corrupt output. * Sun Workshop 6 (SPARC) is known to miscompile the configuration file lexer in 64-bit mode. Either compile 32-bit code or use GCC to compile 64-bit fetchmail. Note that fetchmail doesn't take advantage of 64-bit code, so compiling 32-bit SPARC code should not cause any difficulties. * fetchmail does not track pending deletes over crashes * the command line interface is a bit narrow-minded sometimes, for instance, fetchmail -s doesn't work with a running daemon * some of the logging output is not very helpful * some of the documentation is still not up to date fetchmail 6.3.7 (released 2007-02-18): # FIXES FOR REGRESSIONS IN 6.3.6 * Fix KPOP. Patch by Miloslav Trmac. * Fix repoll when server disconnects after opportunistic TLS failed for POP3. Berlios Bug #10133 = Gentoo Bug #163782 reported by Andrej Kacian. # TRANSLATION UPDATES * Japanese (Takeshi Hamasaki), Polish (Jakub Bogusz) # CHANGES * Consider getaddrinfo() on Darwin 9 (Mac OS X 10.5 "Leopard") thread-safe. Reported by Uli Zappe. fetchmail 6.3.6 (released 2007-01-04): # SECURITY FIXES: * CVE-2006-5867, fetchmail-SA-2006-02.txt: Password disclosure vulnerability fixed. This has several aspects: - Fetchmail now implies sslproto 'tls1' if the sslfingerprint or sslcertck options are used and the ssl option is not used, in order to be sure that fetchmail gets a certificate from the mail server. - Fetchmail breaks the connection if the TLS negotiation (or verification, if requested) fails with sslproto 'tls1', sslfingerprint or sslcheck enabled. - POP3 connections now use STLS reliably. They used to ignore STLS altogether for serveral values of the "auth" option, when fetchmail forget to probe server capabilities - see fetchmail-SA-2006-02.txt for details. - POP3 connections will no longer fall back USER/PASS authentication if strong challenge-response authenticators such as CRAM-MD5 are configured but the server does not advertise these in its CAPA response. - POP2 is obsolete and does not support STLS or anything beyond password-based authentication. The attempt to use STLS or strong authenticators now causes connection abort. Configurations using both ssl and sslcertck however have been semi-safe in that they would send the password in the clear. The USER/PASS fallback problem however applies to these too, so that the password was only safe on trustworthy servers. * CVE-2006-5974, fetchmail-SA-2006-03.txt: Repairs a regression in 6.3.5 that crashes fetchmail when a message with invalid headers is found while fetchmail's mda option is in use. BerliOS bugs #9364, #9412, #9449. Stack backtrace provided by Neil Hoggarth - thanks. # REGRESSION FIXES (recently introduced bugs) * Repair --logfile, broken in 6.3.5. BerliOS Bug #9059, reported by Brian Harring. * Repair --user, broken in 6.3.5 (as a side effect of the authenticate external patch): using SSL certificate/key authentication overrode the --user option. Now the latter takes precedence, and only defaults to the certificate's common name. Debian Bug #400950, reported by Jorgen Schaefer . # BUG FIXES (long-standing bugs): * RPOP: used to log the password locally rather than an asterisk as the other protocols do. The password is now shrouded in the local logs. * POP3: Probes capabilities now when Kerberos V5 is enabled, so that we can actually detect if the server supports it. * Robustness: If a stale lockfile cannot be deleted, truncate it so that fetchmail doesn't later believe itself to be running if the PID is recycled by a non-fetchmail process. * DNS: Detect /etc/resolv.conf changes: On systems that have res_search(), assume we also have res_init() and call it (suggested by Ulrich Drepper, glibc bug #3675) in order to make libc or libresolv reread the resolver configuration at the beginning of a poll cycle. This is important when fetchmail is in daemon mode and /etc/resolv.conf is changed later by dhcpcd, dhclient, pppd, openvpn or other ip-up/ipchange scripts. Should fix Debian Bug#389270, Bug#391698. * Robustness: Fix crash on systems that do not provide strdup(), the crash happens only in out-of-memory conditions when fetchmail cannot proceed anyways. Patch by Andreas Krennmair. * Robustness: When HOME and FETCHMAILHOME are unset, be sure to copy user database information, so it is not trashed later. Patch by Jim Correia. # CHANGES: * Workaround: Improve handling of IMAP IDLE, some servers do not reset their time counters after sending information asynchronously. Patch by Sunil Shetye, after report from Andrew Baumann. * Usability: When requesting Kerberos or GSSAPI, complain and exit with syntax error if any of these requested features has not been compiled in. This is to fail early and with precise error message. Reported by Isaac Wilcox. * --version will now add +KRB4 or +KRB5 if Kerberos v4 or v5, respectively, have been compiled in. Reported missing by Isaac Wilcox. # TRANSLATIONS: * New en_GB (British English) translation by David Lodge. * Update Japanese (Takeshi Hamasaki), Polish (Jakub Bogusz), Russian (Pavel Maryanov) and Vietnamese (Clytie Siddall) translations. ! Note that not all these translations are complete -- this isn't the translators' fault though, but due to delays at the BerliOS hosting site and the translation project handlers. You may see a few untranslated messages. # DOCUMENTATION: * Dropped exit status 15 from manual page, it's not used by fetchmail. Reported by Isaac Wilcox. * Documented exit codes 24 - 29 as internal. fetchmail 6.3.5 (released 2006-10-09): # BUG FIXES: * For protocols such as IMAP that are not delimited by "." lines, truncate the input buffer when the message has been completely read, to avoid taking trailing garbage into the message if the terminal CRLF is missing. Fixes Debian Bug#312415. (Patch suggested by Mike Jones, Manchester Univ.). * When using NTLM authentication, use regular IMAP response code handler after completing NTLM handshake, for robustness and consistency. (Taken from the NetBSD portable packages collection, patch-ac.) * Support Kerberos installations where krb5.h and perhaps roken.h are in .../include/krb5. Taken from NetBSD portable packages collection patch-ae. * On NetBSD, link against -lroken -lcom_err if --with-kerberos is enabled. * Drop #include from Kerberos 5 header file, fixes compile error on SUSE Linux 10.0. * Fix des_pcbc_encrypt compile warnings in kerberos.c line 246. * If krb5-config provides gssapi library information, use that rather than guessing. * Improve --with-gssapi auto detection for /usr-based GSSAPI installs. * Fix --with-gssapi builds for NetBSD 3.0. * Improve KAME/getnameinfo.c portability to Linux libc5 systems. Based on a patch by Dan Fandrich. * Provide INET6 to KAME/getnameinfo.c (only useful on IPv6-enabled systems that lack getnameinfo, and there only visible in some Received: headers). Found by Dan Fandrich. * POP3: some UID flags may not be set properly on UIDL lists. (Sunil Shetye) * Make IMAP4 IDLE work on servers that do not update RECENT counts. Reported by Lars Tewes. * IMAP4 patch by Sunil Shetye: - do not depend on server updating RECENT counts at all - also enter IDLE loop when messages are present on the server. * Fix --flush description in the manual page, fetchmail does not mark messages seen unless it has successfully delivered them. Suggested by Frederic Marchal. * Fetchmail no longer attempts to stat the "-" file in daemon mode -- this is a special name to read the RC file from stdin, and cannot always be re-read anyways. BerliOS bug #7858. * When looking up ports for a service, the lookup succeeds and the returned address family isn't IPv4 or IPv6, properly free the allocated memory from the service lookup. Found by Uli Zappe. * When looking up ports for a service, only look up TCP ports. * Avoid compiling empty files, to avoid diagnostics from strict compilers. * If the lockfile ends before the process ID, treat it as stale and unlink it. Reported by Justin Pryzby, Debian Bug #376603. * SIGHUP wake-up behavior was broken since 5.9.13's Cygwin changes, in that for non-root users, SIGHUP would abort the first poll and subsequently interfere with new polls, and SIGHUP would be ignored for root users. SIGHUP now matches documented behavior. SIGUSR1 has always been a wakeup signal for both root (undocumented) and non-root users. See also the deprecation warning above. * Track getaddrinfo() results to properly free them after timeouts and make sure that getaddrinfo() isn't interrupted by a timeout (which breaks on MacOS X), reported by Uli Zappe. This should fix Debian Bug#294547 and Bug#377135. * --logfile is now handled more carefully, errors opening the logfile are now reported to the TTY where fetchmail was started from. * fetchmail now complains and aborts when it cannot properly daemonize itself. * fix compilation on systems that don't know struct addrinfo (Solaris 2.6). * ignore SIGPIPE signals and rely on functions to return EPIPE instead. This is necessary because the former longjmp() from the signal handler is unsafe and makes the whole fetchmail behavior undefined after the event. * Avoid crash in env.c/host_fqdn if we cannot canonicalize our own hostname. Reported by Alexander Holler. * SSL fix by Miloslav Trmac (Red Hat): free the SSL contexts after the connection, to avoid from growing SSL certpaths without bounds, avoid using SSL contexts for unrelated connections, and to fix Red Hat Bug #206346. # CHANGES: * Rename all fetchmail-internal lock_* functions to fm_lock_*. Obsoletes NetBSD portable packages collection patch-ah, patch-ai and patch-aj. * Configure prints a warning (but proceeds) if Kerberos IV support is enabled. * In verbose mode, log every IP fetchmail tries to connect to, to avoid misleading the user. Suppress EAFNOSUPPORT errors from socket() call, too. Fixes Debian Bug #361825, reported by Daniel Baur. * In idle mode, fetchmail complains about the fetchall option. * When a connection fails, log not only the IP address, but also host and service name and the port number. Log the latter when trying to connect in verbose mode, too. * Keep syslog output at one line per message (this works if no errors occur). * Fetchmail in verbose mode now logs if it opportunistically upgrades a POP3 or IMAP connection to TLS security with STLS/STARTTLS. * fetchmail now supports foo@example.org=bar user mappings for multidrop boxes. * switch setjmp/longjmp to sigsetjmp/siglongjmp * IMAP now supports the EXTERNAL authentication method, courtesy of Götz 'nimrill' Babin-Ebell, BerliOS patch #1095 with minor changes. Note that this change causes --sslcert to override --user. * The sslproto keywords are now case insensitive, courtesy of Götz 'nimrill' Babin-Ebell, BerliOS patch #1095. * When going to sleep, log for how long. Suggested by Claudia Ludwig. * When the server name cannot be canonicalized, log the gai_strerror value. # TRANSLATION UPDATES: * Catalan/ca (Ernest Adrogué Calveras), Japanese/ja (Takeshi Hamasaki) - also made gettext 0.15 ready, Polish/pl (Jakub Bogusz), Russian/ru (Pavel Maryanov), Spanish/es (Héctor García Álvarez), Vietnamese/vi (Clytie Siddall) # CONTRIBUTED SCRIPTS: * PopDel.py was revised by Joshua Crawford to display the From: address and list every email, even if it has no Subject: header; and not delete the wrong message in the presence of mail without Subject: headers. fetchmail 6.3.4 (released 2006-04-14): # BUG FIXES: * configure: detect res_* functions properly with newer glibc ABIs. Patch by Miloslav Trmac. * tracepolls: add folder information if available. Reported by Terry Brown. * lexer: add %option noyywrap to avoid link errors about missing yywrap(). * a few more type fixes for report/snprintf, patch by Miloslav Trmac. * bouncing: fetchmail would still send "General SMTP/ESMTP error." bounces in spite of "no bouncemail" configuration. * SSL/TLS: if, for a certain server, an sslfingerprint is specified and sslcertck is NOT set, suppress printing SSL certificate mismatch errors. (Reported by Hannes Erven.) * SSL/TLS: always print if the sslfingerprint mismatches, even in silent mode. (This is for consistency with certificate verification errors.) # TRANSLATION UPDATES: * German/de (Matthias Andree), French/fr (Matthias Andree), Spanish/es (Héctor García), Polish/pl (Jakub Bogusz), Japanese/ja (Takeshi Hamasaki) * New Vietnamese/vi translation (Clytie Siddall). * Updated French descriptions for the .spec file (Stéphane Schildknecht, Luc Pionchon, Matthias Andree). # CHANGES: * pidfile: there is a new command-line (--pidfile PATH) and global option for the rcfile (set pidfile [=] "/path/to/pidfile") option to allow overriding the default location of the PID file. Requested by Héctor García, Debian maintainer. * specgen.sh: Converted to UTF-8 to support translated texts better. fetchmail 6.3.3 (released 2006-03-30): # BUG FIXES: * SEGFAULT: Do not attempt to overwrite the netrc password if none has been specified. This fixes a segmentation fault bug introduced into 6.3.2. Fixes BerliOS bug #6234. BerliOS patch #804 by Craig Leres. The patch, as accepted into fetchmail, was available separately from * SEGFAULT: Work around C libraries that return a NULL in getaddrinfo()'s ai_canonname record, to avoid a segfault. Affects for instance FreeBSD 4.10, 4.11 and 5.3 when dotted quads are given as server names. Analysis and fix by Vladimir Olegovich Ravodin (Владимир Олегович Раводин). * IMAP: fix hangs in NOOP-based IDLE emulation. Reported by Casper Gripenberg and Brendan Lynch, fix by Sunil Shetye (his patch was merged) and Brendan Lynch. * IMAP: Handle other clients concurrently accessing IMAP mailboxes better. Fetchmail quits the poll if the EXPUNGE count does not match expectations, and servers not updating RECENT counts after EXPUNGE are handled in a better way. (Patch by Sunil Shetye.) * IMAP: Stop sending EXPUNGE after NOOP-idling (patch by Sunil Shetye). * POP3: fetchmail can now use UIDL in fetchall keep mode, to avoid re-fetching the same messages again when the fetchall keyword is removed. Patch by Sunil Shetye. For details, please see * LMTP: fix bug in LMTP port validation (patch by Miloslav Trmac). * SDPS: fetchmail no longer replaces the local user ID for an empty envelope sender when using the proprietary SDPS extension for POP3. Fixes Debian Bug#353575, reported by Roger Lynn. * SDPS: Warn and disable SDPS if POP3 is disabled to avoid compilation errors. * fetchmail no longer prints empty lines in verbose mode when using syslog. * fetchmail no longer prints UID lists in verbose mode when using syslog. * ./configure --quiet is now quieter (no SSL and fallback-related output). * Miloslav Trmac's patch (with minor changes) to fix char * sign consistency, unused arguments and variables. * More signedness, unused argument/variable and other warning fixes. # CHANGES: * --idle can now be specified on the command line, too. * --fetchall is now supported on the command-line. * POP3: Lower default fastuidl span to 4 (i. e. every 4th run fetches the whole UIDL list), patch by Sunil Shetye. # DOCUMENTATION: * "ssl" is a user option rather than a server option. Patch by Nico Golde. Fixes Debian Bug#354661, reported by Keith Hellman. * The manual page now suggests "--" before the addresses in the sendmail MDA example, for safety. * The FAQ item X9, Domino IMAP omits Content-Transfer-Encoding header, was added. Information provided by Anthony Kim on the fetchmail-friends list in March 2006. * Credit Chris Boyle with the NOOP emulation code for IDLE in fetchmail 6.2.4. Eric forgot to credit Chris, thanks to Sunil Shetye for providing these links: http://lists.ccil.org/pipermail/fetchmail-friends/2003-July/007705.html http://lists.ccil.org/pipermail/fetchmail-friends/2003-July/007713.html * Added a section about RETR vs. TOP to the manual page. * Changed section/subsection levels in some areas. fetchmail 6.3.2 (released 2006-01-22): Unless otherwise noted, changes to this release were made by Matthias Andree. # SECURITY FIX IN THIS RELEASE * CVE-2006-0321: Fix segfault or bus error after bouncing a message. This bug was introduced into 6.3.0 when removing alloca(); it caused fetchmail to free random memory. Reported by Nathaniel W. Turner, Debian Bug#348747. See fetchmail-SA-2006-01.txt # INCOMPATIBLE CHANGE: * Automatically disable the POP3 TOP command if the greeting string contains "Maillennium POP3/PROXY server", which is used by comcast and known to truncate messages after 80 kByte. Fall back to RETR, and complain if we had used TOP otherwise (the warning is printed only once per server in daemon mode). Suggested by Ed Wilts. *Note* that this means messages are marked read on these servers, which is a deviation from how 6.3.1 behaved, but we have no alternative, comcast haven't fixed this bug in years. Preventing the loss of the remainder of the message justifies this incompatible fix. * fetchmail, since 6.3.0, requires write permission to the directory holding the idfile. See the amendment in the 6.3.0 MAJOR INCOMPATIBLE CHANGES section below for details. The manual page was updated. # CHANGES RELEVANT TO PACKAGERS: * The outdated BUGS document was removed from the distribution. * Added fetchmail-SA-2006-01.txt to the distribution. # BUG FIXES: * SMTP/LMTP cleanup to fix these two bugs: - switch back to SMTP after having tried LMTP hosts (multiple smtphost hosts) - switch back to LMTP after sending a bounce. The patch removes the global state variable that was the root of this problem. Patch by Sunil Shetye. (MA) * Don't complain about fetchall keep in --configdump mode. Bug introduced in 6.3.0. * fetchmailconf.py: Fix novice help for Poll interval and fetchall. Reported by Justin Pryzby, Debian Bug #344978. * Some verbose output disappeared in debug mode. Adding further -v options would alternate between verbose and debug mode. debug mode now comprises all verbose output, and adding more -v options does not switch back from debug to verbose mode. * fetchmail.man: Fix accented characters in Héctor García's name. Merged from downstream debian/patches/01_man_page.dpatch. * Add missing --help text for "--sslcertck" option. * fetchmailconf.py: Accept --help and --version. * fetchmail --version now prints the copyright notice. * don't complain about READ-ONLY IMAP folders in --fetchall --keep mode. Reported Alexander Zangerl, Debian Bug#348964. * the RPM .spec file now generates a -debuginfo package on newer RPM versions. fetchmail 6.3.1 (released 2005-12-19): # SECURITY FIX IN THIS RELEASE * CVE-2005-4348 Fix segmentation fault (null pointer dereference) in multidrop mode with headerless email. See fetchmail-SA-2005-03.txt. Reported by Daniel Drake, patch by Sunil Shetye. (MA) # OTHER BUG FIXES, DOCUMENTATION AND TRANSLATION UPDATES * Fix broken default port in POP2. Patch by Stanislav Brabec, SUSE [CZ]. (MA) * Fix manual page, some lines starting with ' were escaped by \&. Reported by Simon Barner. (MA) * Ship with gettext-0.14.3 again, as 6.2.9-rc10 did. Found by Sunil Shetye. (MA) * Actually set default SSL certificate path if --sslcertpath is unset. Reported by Heino Tiedemann and Rob MacGregor. (MA) * Remove bogus Netscape IMAP4rev1 Service >= 3.6 warning about BODY[TEXT] that we are not using. Patch by Sunil Shetye. (MA) * Plug potential memory and socket leak when polling multiple folders or when the upstream sends bogus message sizes. Patch by Sunil Shetye. (MA) * Update Catalan translation, by Ernest Adrogué Calveras. (MA) * Fix segfault (null pointer dereference) on some operating systems with fetchmail's obsolete DNS MX/host alias lookups in multidrop mode. Patch by Dr.-Ing. Andreas Haakh. (MA) * Close SMTP sockets early, to reduce resource usage, trigger earlier delivery with some MTAs and avoid SIGPIPE (SIG 13) when the SMTP listener gets bored and drops the connection after timeout. Patch by Sunil Shetye. (MA) * Don't treat hitting a fetch limit as error. Patch by Sunil Shetye. (MA) * Fix negative "messages left on server" on idle/repoll with fetchlimit. Patch by Sunil Shetye. (MA) * Properly track logout stage. Patch by Sunil Shetye. (MA) * Preserve error conditions across postconnect script. Sunil Shetye. (MA) * Do not trash destination domain if multiple messages are forwarded into the same SMTP/LMTP connection. Reported by Joachim Feise, Berlios Bug #5849. (MA) * Manual page: Add "-md5" to "openssl x509" example in --sslfingerprint documentation, since OpenSSL 0.9.8 changed the default to SHA1. Suggested by Jason White. (MA) * Cope with servers that return UID information in response to non-UID RFC822.{SIZE|HEADER} requests. Reported by Jason White. Patch suggestion by by Sunil Shetye, simplified by MA. fetchmail 6.3.0 (released 2005-11-30): # SECURITY FIXES IN THIS RELEASE * CVE-2005-2335: The POP3 UIDL code doesn't sufficiently validate/truncate the input length, so a (malicious or compromised) server that sends UIDs longer than 128 bytes can corrupt fetchmail's stack and crash fetchmail. This vulnerability is remotely exploitable to inject code run in a root shell. Edward J. Shornock, Ludwig Nussel. fetchmail-SA-2005-01.txt * CVE-2005-3088: fetchmailconf now changes the output file to mode 0600 BEFORE writing to it, so there is no window where passwords could be read by the world. Matthias Andree. fetchmail-SA-2005-02.txt # MAJOR INCOMPATIBLE CHANGES * Remove support for --netsec/-T options, the required inet6_apps library is no longer available. http://www.inner.net/pub/ipv6/ states, as of 2005-07-03: "/pub/ipv6 Our IPv6 software is now long defunct. Please find a more modern source." I haven't been able to find a more modern source. Matthias Andree * Operating systems that do not conform to the Single Unix Specification v2 (1997) or v3 (2001, aka IEEE Std 1003.1-2001) are no longer supported. They may continue to work and non-intrusive patches to support them may be accepted. Matthias Andree * The default for --smtphost is now always "localhost" regardless of authentication types and protocols, so as to simplify configurations for workstations where the SMTP daemon only listens on the loopback interface. Sunil Shetye & Matthias Andree Amendment, 2006-01-04: * fetchmail's idfile (.fetchids) is no longer written directly, but the ids are written to a temporary file which is renamed into place after being written completely. This is to avoid writing incomplete idfiles when running out of space, which would cause excessive duplicate refetches of messages, this might make matters even worse. This means that fetchmail requires write permission on the directory holding the idfile. This will usually affect system-global daemons only, for instance, Debian. Found by Dan Jacobson. Matthias Andree. Escalated to "incompatible", 2006-01-13: * Try to obtain FQDN as our own host by default, rather than using "localhost". If hostname cannot be qualified, complain noisily and continue, unless Kerberos, ODMR or ETRN are used (these have always required an FQDN). Partial fix of Debian Bug#150137. Fixes Debian Bug#316454. Matthias Andree # CHANGES RELEVANT TO PACKAGERS AND USERS * fetchmailconf is now a shell wrapper that calls the byte-compiled fetchmailconf.py script, which is now installed in the regular python directory. Matthias Andree. * The --enable-inet6 configure option was removed. The code is mostly protocol agnostic, a fully IPv6 aware OS is expected to provide getaddrinfo(), getnameinfo() and the macro AF_INET6. Matthias Andree. * gettext (intl/) has been removed from the fetchmail package. Install GNU gettext 0.14 separately for NLS (i18n). Matthias Andree * Added Russian translation, courtesy of Pavel Maryanov of the Russian translation team. (MA) * Updated and re-enabled Czech
# Doxyfile 1.5.3

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file that 
# follow. The default is UTF-8 which is also the encoding used for all text before 
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
# possible encodings.

DOXYFILE_ENCODING      = UTF-8

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
# by quotes) that should identify the project.

PROJECT_NAME           = fetchmail

# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
# This could be handy for archiving the generated documentation or 
# if some version control system is used.

PROJECT_NUMBER         = BRANCH_6-3

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
# base path where the generated documentation will be put. 
# If a relative path is entered, it will be relative to the location 
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = dox

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
# 4096 sub-directories (in 2 levels) under the output directory of each output 
# format and will distribute the generated files over these directories. 
# Enabling this option can be useful when feeding doxygen a huge amount of 
# source files, where putting all generated files in the same directory would 
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
# documentation generated by doxygen is written. Doxygen will use this 
# information to generate all constant output in the proper language. 
# The default language is English, other supported languages are: 
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.

OUTPUT_LANGUAGE        = English

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
# include brief member descriptions after the members that are listed in 
# the file and class documentation (similar to JavaDoc). 
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
# the brief description of a member or function before the detailed description. 
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator 
# that is used to form the text in various listings. Each string 
# in this list, if found as the leading text of the brief description, will be 
# stripped from the text and the result after processing the whole list, is 
# used as the annotated text. Otherwise, the brief description is used as-is. 
# If left blank, the following values are used ("$name" is automatically 
# replaced with the name of the entity): "The $name class" "The $name widget" 
# "The $name file" "is" "provides" "specifies" "contains" 
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = 

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
# Doxygen will generate a detailed section even if there is only a brief 
# description.

ALWAYS_DETAILED_SEC    = NO

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
# inherited members of a class in the documentation of that class as if those 
# members were ordinary class members. Constructors, destructors and assignment 
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
# path before files name in the file list and in the header files. If set 
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
# can be used to strip a user-defined part of the path. Stripping is 
# only done if one of the specified strings matches the left-hand part of 
# the path. The tag can be used to show relative paths in the file list. 
# If left blank the directory from which doxygen is run is used as the 
# path to strip.

STRIP_FROM_PATH        = 

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
# the path mentioned in the documentation of a class, which tells 
# the reader which header file to include in order to use a class. 
# If left blank only the name of the header file containing the class 
# definition is used. Otherwise one should specify the include paths that 
# are normally passed to the compiler using the -I flag.

STRIP_FROM_INC_PATH    = 

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
# (but less readable) file names. This can be useful is your file systems 
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
# will interpret the first line (until the first dot) of a JavaDoc-style 
# comment as the brief description. If set to NO, the JavaDoc 
# comments will behave just like regular Qt-style comments 
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
# interpret the first line (until the first dot) of a Qt-style 
# comment as the brief description. If set to NO, the comments 
# will behave just like regular Qt-style comments (thus requiring 
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
# comments) as a brief description. This used to be the default behaviour. 
# The new default is to treat a multi-line C++ comment block as a detailed 
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member 
# documentation.

DETAILS_AT_TOP         = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
# member inherits the documentation from any documented member that it 
# re-implements.

INHERIT_DOCS           = YES

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
# a new page for each member. If set to NO, the documentation of a member will 
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

# This tag can be used to specify a number of aliases that acts 
# as commands in the documentation. An alias has the form "name=value". 
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
# put the command \sideeffect (or @sideeffect) in the documentation, which 
# will result in a user-defined paragraph with heading "Side Effects:". 
# You can put \n's in the value part of an alias to insert newlines.

ALIASES                = 

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
# sources only. Doxygen will then generate output that is more tailored for C. 
# For instance, some of the names that are used will be different. The list 
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
# sources only. Doxygen will then generate output that is more tailored for Java. 
# For instance, namespaces will be presented as packages, qualified scopes 
# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
# include (a tag file for) the STL sources as input, then you should 
# set this tag to YES in order to let doxygen match functions declarations and 
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
# func(std::string) {}). This also make the inheritance and collaboration 
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.

CPP_CLI_SUPPORT        = NO

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
# tag is set to YES, then doxygen will reuse the documentation of the first 
# member in the group (if any) for the other members of the group. By default 
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
# the same type (for instance a group of public functions) to be put as a 
# subgroup of that type (e.g. under the Public Functions section). Set it to 
# NO to prevent subgrouping. Alternatively, this can be done per class using 
# the \nosubgrouping command.

SUBGROUPING            = YES

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
# documentation are documented, even if no documentation was available. 
# Private class members and static file members will be hidden unless 
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

# If the EXTRACT_STATIC tag is set to YES all static members of a file 
# will be included in the documentation.

EXTRACT_STATIC         = NO

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
# defined locally in source files will be included in the documentation. 
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

# This flag is only useful for Objective-C code. When set to YES local 
# methods, which are defined in the implementation section but not in 
# the interface are included in the documentation. 
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

# If this flag is set to YES, the members of anonymous namespaces will be extracted 
# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
# where file will be replaced with the base name of the file that contains the anonymous 
# namespace. By default anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
# undocumented members of documented classes, files or namespaces. 
# If set to NO (the default) these members will be included in the 
# various overviews, but no documentation section is generated. 
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
# undocumented classes that are normally visible in the class hierarchy. 
# If set to NO (the default) these classes will be included in the various 
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
# friend (class|struct|union) declarations. 
# If set to NO (the default) these declarations will be included in the 
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
# documentation blocks found inside the body of a function. 
# If set to NO (the default) these blocks will be appended to the 
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
# file names in lower-case letters. If set to YES upper-case letters are also 
# allowed. This is useful if you have classes or files whose names only differ 
# in case and if your file system supports case sensitive file names. Windows 
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
# will show members with their full class and namespace scopes in the 
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
# will put a list of the files that are included by a file in the documentation 
# of that file.

SHOW_INCLUDE_FILES     = YES

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
# will sort the (detailed) documentation of file and class members 
# alphabetically by member name. If set to NO the members will appear in 
# declaration order.

SORT_MEMBER_DOCS       = YES

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
# brief documentation of file, namespace and class members alphabetically 
# by member name. If set to NO (the default) the members will appear in 
# declaration order.

SORT_BRIEF_DOCS        = NO

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
# sorted by fully-qualified names, including namespaces. If set to 
# NO (the default), the class list will be sorted only by class name, 
# not including the namespace part. 
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the 
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

# The GENERATE_TODOLIST tag can be used to enable (YES) or 
# disable (NO) the todo list. This list is created by putting \todo 
# commands in the documentation.

GENERATE_TODOLIST      = YES

# The GENERATE_TESTLIST tag can be used to enable (YES) or 
# disable (NO) the test list. This list is created by putting \test 
# commands in the documentation.

GENERATE_TESTLIST      = YES

# The GENERATE_BUGLIST tag can be used to enable (YES) or 
# disable (NO) the bug list. This list is created by putting \bug 
# commands in the documentation.

GENERATE_BUGLIST       = YES

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
# disable (NO) the deprecated list. This list is created by putting 
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

# The ENABLED_SECTIONS tag can be used to enable conditional 
# documentation sections, marked by \if sectionname ... \endif.

ENABLED_SECTIONS       = 

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
# the initial value of a variable or define consists of for it to appear in 
# the documentation. If the initializer consists of more lines than specified 
# here it will be hidden. Use a value of 0 to hide initializers completely. 
# The appearance of the initializer of individual var