-GNU General Public License
-==========================
+The GNU General Public License, Version 2, June 1991 (GPLv2)
+============================================================
-_Version 2, June 1991_
_Copyright © 1989, 1991 Free Software Foundation, Inc.,_
_51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_
/* The current connection is a new connection */
if (!adata)
{
- /* The current connection is a new connection */
adata = imap_adata_new();
conn->data = adata;
adata->conn = conn;
*/
struct ImapCommand
{
- char seq[SEQLEN + 1];
- int state;
+ char seq[SEQLEN + 1]; ///< Command tag, e.g. 'a0001'
+ int state; ///< Command state, e.g. #IMAP_CMD_NEW
};
/**
* it's just no fun to get the same information twice */
char *capstr;
unsigned char capabilities[(CAPMAX + 7) / 8];
- unsigned int seqno;
+ unsigned int seqno; ///< tag sequence number, e.g. 'a0001'
time_t lastread; /**< last time we read a command for the server */
char *buf;
size_t blen;
* @param[in,out] ps String to convert
* @param[in] from Current character set
* @param[in] to Target character set
- * @param[in] flags Flags, e.g.
+ * @param[in] flags Flags, e.g. #MUTT_ICONV_HOOK_FROM
* @retval 0 Success
* @retval -1 Invalid arguments or failure to open an iconv channel
* @retval errno Failure in iconv conversion
/**
* mx_path_probe - Find a mailbox that understands a path
* @param[in] path Path to examine
- * @param[out] st stat buffer (OPTIONAL, for local filesystems)
+ * @param[out] st stat buffer (OPTIONAL, for local mailboxes)
* @retval num Type, e.g. #MUTT_IMAP
*/
int mx_path_probe(const char *path, struct stat *st)
*/
struct MxOps
{
- const int magic;
- const char *name;
+ const int magic; ///< Mailbox type, e.g. #MUTT_IMAP
+ const char *name; ///< Mailbox name, e.g. "imap"
/**
* mbox_open - Open a mailbox
* @param ctx Mailbox to open
* @param ctx If fp is NULL, the context containing the header with the template
* @param newhdr The template is read into this Header
* @param e The message to recall/resend
- * @param resend Set if resending (as opposed to recalling a postponed msg).
+ * @param resend Set if resending (as opposed to recalling a postponed msg)
* Resent messages enable header weeding, and also
- * discard any existing Message-ID and Mail-Followup-To.
+ * discard any existing Message-ID and Mail-Followup-To
* @retval 0 Success
* @retval -1 Error
*/