]> granicus.if.org Git - neomutt/commitdiff
doxy: unify MXAPI comments
authorRichard Russon <rich@flatcap.org>
Fri, 5 Jul 2019 15:46:26 +0000 (16:46 +0100)
committerRichard Russon <rich@flatcap.org>
Sat, 6 Jul 2019 11:45:40 +0000 (12:45 +0100)
compress.c
imap/imap.c
imap/message.c
maildir/maildir.c
maildir/mh.c
maildir/shared.c
mbox/mbox.c
mx.h
nntp/nntp.c
notmuch/mutt_notmuch.c
pop/pop.c

index 2aebfae02d7186c303d49170e92942960a1fd802..5320d8dc456e3b0ef47731fe573438aa44f0a2ec 100644 (file)
@@ -428,7 +428,7 @@ int mutt_comp_valid_command(const char *cmd)
 }
 
 /**
- * comp_ac_find - Find an Account that matches a Mailbox path
+ * comp_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *comp_ac_find(struct Account *a, const char *path)
 {
@@ -436,7 +436,7 @@ struct Account *comp_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * comp_ac_add - Add a Mailbox to an Account
+ * comp_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int comp_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -452,7 +452,7 @@ int comp_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * comp_mbox_open - Implements MxOps::mbox_open()
+ * comp_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  *
  * Set up a compressed mailbox to be read.
  * Decompress the mailbox and set up the paths and hooks needed.
@@ -515,7 +515,7 @@ cmo_fail:
 }
 
 /**
- * comp_mbox_open_append - Implements MxOps::mbox_open_append()
+ * comp_mbox_open_append - Open a Mailbox for appending - Implements MxOps::mbox_open_append()
  *
  * flags may also contain #MUTT_NEWFOLDER
  *
@@ -595,7 +595,7 @@ cmoa_fail1:
 }
 
 /**
- * comp_mbox_check - Implements MxOps::mbox_check()
+ * comp_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  * @param m          Mailbox
  * @param index_hint Currently selected mailbox
  * @retval 0              Mailbox OK
@@ -640,7 +640,7 @@ static int comp_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * comp_mbox_sync - Implements MxOps::mbox_sync()
+ * comp_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  *
  * Changes in NeoMutt only affect the tmp file.
  * Calling comp_mbox_sync() will commit them to the compressed file.
@@ -692,7 +692,7 @@ sync_cleanup:
 }
 
 /**
- * comp_mbox_close - Implements MxOps::mbox_close()
+ * comp_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  *
  * If the mailbox has been changed then re-compress the tmp file.
  * Then delete the tmp file.
@@ -761,7 +761,7 @@ static int comp_mbox_close(struct Mailbox *m)
 }
 
 /**
- * comp_msg_open - Implements MxOps::msg_open()
+ * comp_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int comp_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -779,7 +779,7 @@ static int comp_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * comp_msg_open_new - Implements MxOps::msg_open_new()
+ * comp_msg_open_new - Open a new message in a Mailbox - Implements MxOps::msg_open_new()
  */
 static int comp_msg_open_new(struct Mailbox *m, struct Message *msg, struct Email *e)
 {
@@ -797,7 +797,7 @@ static int comp_msg_open_new(struct Mailbox *m, struct Message *msg, struct Emai
 }
 
 /**
- * comp_msg_commit - Implements MxOps::msg_commit()
+ * comp_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  */
 static int comp_msg_commit(struct Mailbox *m, struct Message *msg)
 {
@@ -815,7 +815,7 @@ static int comp_msg_commit(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * comp_msg_close - Implements MxOps::msg_close()
+ * comp_msg_close - Close an email - Implements MxOps::msg_close()
  */
 static int comp_msg_close(struct Mailbox *m, struct Message *msg)
 {
@@ -867,7 +867,7 @@ static int comp_msg_save_hcache(struct Mailbox *m, struct Email *e)
 }
 
 /**
- * comp_tags_edit - Implements MxOps::tags_edit()
+ * comp_tags_edit - Prompt and validate new messages tags - Implements MxOps::tags_edit()
  */
 static int comp_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t buflen)
 {
@@ -884,7 +884,7 @@ static int comp_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t
 }
 
 /**
- * comp_tags_commit - Implements MxOps::tags_commit()
+ * comp_tags_commit - Save the tags to a message - Implements MxOps::tags_commit()
  */
 static int comp_tags_commit(struct Mailbox *m, struct Email *e, char *buf)
 {
@@ -901,7 +901,7 @@ static int comp_tags_commit(struct Mailbox *m, struct Email *e, char *buf)
 }
 
 /**
- * comp_path_probe - Is this a compressed mailbox? - Implements MxOps::path_probe()
+ * comp_path_probe - Is this a compressed Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType comp_path_probe(const char *path, const struct stat *st)
 {
@@ -918,7 +918,7 @@ enum MailboxType comp_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * comp_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * comp_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int comp_path_canon(char *buf, size_t buflen)
 {
@@ -930,7 +930,7 @@ int comp_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * comp_path_pretty - Implements MxOps::path_pretty()
+ * comp_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int comp_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -947,7 +947,7 @@ int comp_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * comp_path_parent - Implements MxOps::path_parent()
+ * comp_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int comp_path_parent(char *buf, size_t buflen)
 {
@@ -968,7 +968,7 @@ int comp_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * MxCompOps - Compressed mailbox - Implements ::MxOps
+ * MxCompOps - Compressed Mailbox - Implements ::MxOps
  *
  * Compress only uses open, close and check.
  * The message functions are delegated to mbox.
index f04f63df4a613ad0609c938b9617ee90c9128cf2..2c1c4059a94ed55a789cbc8be68f2da6c7304380 100644 (file)
@@ -1289,7 +1289,7 @@ static int imap_status(struct ImapAccountData *adata, struct ImapMboxData *mdata
 }
 
 /**
- * imap_mbox_check_stats - Implements MxOps::mbox_check_stats()
+ * imap_mbox_check_stats - Check the Mailbox statistics - Implements MxOps::mbox_check_stats()
  */
 int imap_mbox_check_stats(struct Mailbox *m, int flags)
 {
@@ -1810,7 +1810,7 @@ int imap_sync_mailbox(struct Mailbox *m, bool expunge, bool close)
 }
 
 /**
- * imap_ac_find - Find an Account that matches a Mailbox path
+ * imap_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *imap_ac_find(struct Account *a, const char *path)
 {
@@ -1833,7 +1833,7 @@ struct Account *imap_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * imap_ac_add - Add a Mailbox to an Account
+ * imap_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int imap_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -1944,7 +1944,7 @@ int imap_login(struct ImapAccountData *adata)
 }
 
 /**
- * imap_mbox_open - Implements MxOps::mbox_open()
+ * imap_mbox_open - Open a mailbox - Implements MxOps::mbox_open()
  */
 static int imap_mbox_open(struct Mailbox *m)
 {
@@ -2153,7 +2153,7 @@ fail:
 }
 
 /**
- * imap_mbox_open_append - Implements MxOps::mbox_open_append()
+ * imap_mbox_open_append - Open a Mailbox for appending - Implements MxOps::mbox_open_append()
  */
 static int imap_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 {
@@ -2183,7 +2183,7 @@ static int imap_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 }
 
 /**
- * imap_mbox_check - Implements MxOps::mbox_check()
+ * imap_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  * @param m          Mailbox
  * @param index_hint Remember our place in the index
  * @retval >0 Success, e.g. #MUTT_REOPENED
@@ -2204,7 +2204,7 @@ static int imap_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * imap_mbox_close - Implements MxOps::mbox_close()
+ * imap_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  */
 static int imap_mbox_close(struct Mailbox *m)
 {
@@ -2246,7 +2246,7 @@ static int imap_mbox_close(struct Mailbox *m)
 }
 
 /**
- * imap_msg_open_new - Implements MxOps::msg_open_new()
+ * imap_msg_open_new - Open a new message in a Mailbox - Implements MxOps::msg_open_new()
  */
 static int imap_msg_open_new(struct Mailbox *m, struct Message *msg, struct Email *e)
 {
@@ -2264,7 +2264,7 @@ static int imap_msg_open_new(struct Mailbox *m, struct Message *msg, struct Emai
 }
 
 /**
- * imap_tags_edit - Implements MxOps::tags_edit()
+ * imap_tags_edit - Prompt and validate new messages tags - Implements MxOps::tags_edit()
  */
 static int imap_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t buflen)
 {
@@ -2343,7 +2343,7 @@ static int imap_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t
 }
 
 /**
- * imap_tags_commit - Implements MxOps::tags_commit()
+ * imap_tags_commit - Save the tags to a message - Implements MxOps::tags_commit()
  *
  * This method update the server flags on the server by
  * removing the last know custom flags of a header
@@ -2425,7 +2425,7 @@ static int imap_tags_commit(struct Mailbox *m, struct Email *e, char *buf)
 }
 
 /**
- * imap_path_probe - Is this an IMAP mailbox? - Implements MxOps::path_probe()
+ * imap_path_probe - Is this an IMAP Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType imap_path_probe(const char *path, const struct stat *st)
 {
@@ -2442,7 +2442,7 @@ enum MailboxType imap_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * imap_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * imap_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int imap_path_canon(char *buf, size_t buflen)
 {
@@ -2480,7 +2480,7 @@ int imap_expand_path(struct Buffer *buf)
 }
 
 /**
- * imap_path_pretty - Implements MxOps::path_pretty()
+ * imap_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int imap_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -2492,7 +2492,7 @@ int imap_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * imap_path_parent - Implements MxOps::path_parent()
+ * imap_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int imap_path_parent(char *buf, size_t buflen)
 {
@@ -2505,7 +2505,7 @@ int imap_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * MxImapOps - IMAP mailbox - Implements ::MxOps
+ * MxImapOps - IMAP Mailbox - Implements ::MxOps
  */
 struct MxOps MxImapOps = {
   .magic            = MUTT_IMAP,
index 1dc0613e2660a421c561ef76c75beaa090ae7089..05bc19e4fff1db0d7af1a4b94cb712dfd470395f 100644 (file)
@@ -1840,7 +1840,7 @@ char *imap_set_flags(struct Mailbox *m, struct Email *e, char *s, bool *server_c
 }
 
 /**
- * imap_msg_open - Implements MxOps::msg_open()
+ * imap_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 int imap_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -2044,7 +2044,7 @@ bail:
 }
 
 /**
- * imap_msg_commit - Implements MxOps::msg_commit()
+ * imap_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  *
  * @note May also return EOF Failure, see errno
  */
@@ -2058,7 +2058,7 @@ int imap_msg_commit(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * imap_msg_close - Implements MxOps::msg_close()
+ * imap_msg_close - Close an email - Implements MxOps::msg_close()
  *
  * @note May also return EOF Failure, see errno
  */
index ef972ae0234ebeb75935d319d6a53363e472f9df..1bb90965b3587c7c0cca0d5240ccd93958bf4876 100644 (file)
@@ -278,7 +278,7 @@ cleanup:
 }
 
 /**
- * maildir_mbox_open - Implements MxOps::mbox_open()
+ * maildir_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  */
 static int maildir_mbox_open(struct Mailbox *m)
 {
@@ -291,7 +291,7 @@ static int maildir_mbox_open(struct Mailbox *m)
 }
 
 /**
- * maildir_mbox_open_append - Implements MxOps::mbox_open_append()
+ * maildir_mbox_open_append - Open a Mailbox for appending - Implements MxOps::mbox_open_append()
  */
 static int maildir_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 {
@@ -344,7 +344,7 @@ static int maildir_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 }
 
 /**
- * maildir_mbox_check - Implements MxOps::mbox_check()
+ * maildir_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  *
  * This function handles arrival of new mail and reopening of maildir folders.
  * The basic idea here is we check to see if either the new or cur
@@ -527,7 +527,7 @@ int maildir_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * maildir_mbox_check_stats - Implements MxOps::mbox_check_stats
+ * maildir_mbox_check_stats - Check the Mailbox statistics - Implements MxOps::mbox_check_stats
  */
 static int maildir_mbox_check_stats(struct Mailbox *m, int flags)
 {
@@ -552,7 +552,7 @@ static int maildir_mbox_check_stats(struct Mailbox *m, int flags)
 }
 
 /**
- * maildir_msg_open - Implements MxOps::msg_open()
+ * maildir_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int maildir_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -562,7 +562,7 @@ static int maildir_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * maildir_msg_open_new - Implements MxOps::msg_open_new()
+ * maildir_msg_open_new - Open a new message in a Mailbox - Implements MxOps::msg_open_new()
  *
  * Open a new (temporary) message in a maildir folder.
  *
@@ -637,7 +637,7 @@ int maildir_msg_open_new(struct Mailbox *m, struct Message *msg, struct Email *e
 }
 
 /**
- * maildir_msg_commit - Implements MxOps::msg_commit()
+ * maildir_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  */
 static int maildir_msg_commit(struct Mailbox *m, struct Message *msg)
 {
@@ -664,7 +664,7 @@ static int maildir_msg_save_hcache(struct Mailbox *m, struct Email *e)
 }
 
 /**
- * maildir_path_probe - Is this a Maildir mailbox? - Implements MxOps::path_probe()
+ * maildir_path_probe - Is this a Maildir Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType maildir_path_probe(const char *path, const struct stat *st)
 {
@@ -686,7 +686,7 @@ enum MailboxType maildir_path_probe(const char *path, const struct stat *st)
 
 // clang-format off
 /**
- * MxMaildirOps - Maildir mailbox - Implements ::MxOps
+ * MxMaildirOps - Maildir Mailbox - Implements ::MxOps
  */
 struct MxOps MxMaildirOps = {
   .magic            = MUTT_MAILDIR,
index ff7b0ea71fedabef78aaaf14171bede3f07f5f30..3a67389ee9ff5440f46c8e8b734cf4c9a9a06a04 100644 (file)
@@ -414,7 +414,7 @@ bool mh_valid_message(const char *s)
 }
 
 /**
- * mh_mbox_check_stats - Implements MxOps::check_stats
+ * mh_mbox_check_stats - Check the Mailbox statistics - Implements MxOps::check_stats
  */
 static int mh_mbox_check_stats(struct Mailbox *m, int flags)
 {
@@ -539,7 +539,7 @@ int mh_sync_message(struct Mailbox *m, int msgno)
 }
 
 /**
- * mh_mbox_open - Implements MxOps::mbox_open()
+ * mh_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  */
 static int mh_mbox_open(struct Mailbox *m)
 {
@@ -547,7 +547,7 @@ static int mh_mbox_open(struct Mailbox *m)
 }
 
 /**
- * mh_mbox_open_append - Implements MxOps::mbox_open_append()
+ * mh_mbox_open_append - Open a Mailbox for appending - Implements MxOps::mbox_open_append()
  */
 static int mh_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 {
@@ -580,7 +580,7 @@ static int mh_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 }
 
 /**
- * mh_mbox_check - Implements MxOps::mbox_check()
+ * mh_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  *
  * This function handles arrival of new mail and reopening of mh/maildir
  * folders. Things are getting rather complex because we don't have a
@@ -723,7 +723,7 @@ int mh_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * mh_msg_open - Implements MxOps::msg_open()
+ * mh_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int mh_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -733,7 +733,7 @@ static int mh_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * mh_msg_open_new - Implements MxOps::msg_open_new()
+ * mh_msg_open_new - Open a new message in a Mailbox - Implements MxOps::msg_open_new()
  *
  * Open a new (temporary) message in an MH folder.
  */
@@ -745,7 +745,7 @@ static int mh_msg_open_new(struct Mailbox *m, struct Message *msg, struct Email
 }
 
 /**
- * mh_msg_commit - Implements MxOps::msg_commit()
+ * mh_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  */
 static int mh_msg_commit(struct Mailbox *m, struct Message *msg)
 {
@@ -756,7 +756,7 @@ static int mh_msg_commit(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * mh_path_probe - Is this an mh mailbox? - Implements MxOps::path_probe()
+ * mh_path_probe - Is this an mh Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType mh_path_probe(const char *path, const struct stat *st)
 {
@@ -800,7 +800,7 @@ enum MailboxType mh_path_probe(const char *path, const struct stat *st)
 
 // clang-format off
 /**
- * MxMhOps - MH mailbox - Implements ::MxOps
+ * MxMhOps - MH Mailbox - Implements ::MxOps
  */
 struct MxOps MxMhOps = {
   .magic            = MUTT_MH,
index 390f24d60df66659b70be1b3639fd193a934b615..0ddf89d5904329ade075abae611c7dcc9b66b269 100644 (file)
@@ -1651,7 +1651,7 @@ int mh_check_empty(const char *path)
 }
 
 /**
- * maildir_ac_find - Find an Account that matches a Mailbox path
+ * maildir_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *maildir_ac_find(struct Account *a, const char *path)
 {
@@ -1662,7 +1662,7 @@ struct Account *maildir_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * maildir_ac_add - Add a Mailbox to an Account
+ * maildir_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int maildir_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -1672,7 +1672,7 @@ int maildir_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * maildir_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * maildir_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int maildir_path_canon(char *buf, size_t buflen)
 {
@@ -1684,7 +1684,7 @@ int maildir_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * maildir_path_pretty - Implements MxOps::path_pretty()
+ * maildir_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int maildir_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -1701,7 +1701,7 @@ int maildir_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * maildir_path_parent - Implements MxOps::path_parent()
+ * maildir_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int maildir_path_parent(char *buf, size_t buflen)
 {
@@ -1721,7 +1721,7 @@ int maildir_path_parent(char *buf, size_t buflen)
 }
 
 /**
- * mh_mbox_sync - Implements MxOps::mbox_sync()
+ * mh_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  */
 int mh_mbox_sync(struct Mailbox *m, int *index_hint)
 {
@@ -1795,7 +1795,7 @@ err:
 }
 
 /**
- * mh_mbox_close - Implements MxOps::mbox_close()
+ * mh_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  * @retval 0 Always
  */
 int mh_mbox_close(struct Mailbox *m)
@@ -1804,7 +1804,7 @@ int mh_mbox_close(struct Mailbox *m)
 }
 
 /**
- * mh_msg_close - Implements MxOps::msg_close()
+ * mh_msg_close - Close an email - Implements MxOps::msg_close()
  *
  * @note May also return EOF Failure, see errno
  */
index 0f5c58fb24473cdb88089dab56146b0e285863e5..4a0159ff039aeb4f7c66be33ce62bfef1bc8c57f 100644 (file)
@@ -872,7 +872,7 @@ void mbox_reset_atime(struct Mailbox *m, struct stat *st)
 }
 
 /**
- * mbox_ac_find - Find an Account that matches a Mailbox path
+ * mbox_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *mbox_ac_find(struct Account *a, const char *path)
 {
@@ -890,7 +890,7 @@ struct Account *mbox_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * mbox_ac_add - Add a Mailbox to an Account
+ * mbox_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int mbox_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -900,7 +900,7 @@ int mbox_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * mbox_mbox_open - Implements MxOps::mbox_open()
+ * mbox_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  */
 static int mbox_mbox_open(struct Mailbox *m)
 {
@@ -939,7 +939,7 @@ static int mbox_mbox_open(struct Mailbox *m)
 }
 
 /**
- * mbox_mbox_open_append - Implements MxOps::mbox_open_append()
+ * mbox_mbox_open_append - Open a Mailbox for appending - Implements MxOps::mbox_open_append()
  */
 static int mbox_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 {
@@ -973,7 +973,7 @@ static int mbox_mbox_open_append(struct Mailbox *m, OpenMailboxFlags flags)
 }
 
 /**
- * mbox_mbox_check - Implements MxOps::mbox_check()
+ * mbox_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  * @param[in]  m          Mailbox
  * @param[out] index_hint Keep track of current index selection
  * @retval #MUTT_REOPENED  Mailbox has been reopened
@@ -1106,7 +1106,7 @@ static int mbox_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * mbox_mbox_sync - Implements MxOps::mbox_sync()
+ * mbox_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  */
 static int mbox_mbox_sync(struct Mailbox *m, int *index_hint)
 {
@@ -1472,7 +1472,7 @@ bail: /* Come here in case of disaster */
 }
 
 /**
- * mbox_mbox_close - Implements MxOps::mbox_close()
+ * mbox_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  */
 static int mbox_mbox_close(struct Mailbox *m)
 {
@@ -1515,7 +1515,7 @@ static int mbox_mbox_close(struct Mailbox *m)
 }
 
 /**
- * mbox_msg_open - Implements MxOps::msg_open()
+ * mbox_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int mbox_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -1532,7 +1532,7 @@ static int mbox_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * mbox_msg_open_new - Implements MxOps::msg_open_new()
+ * mbox_msg_open_new - Open a new message in a Mailbox - Implements MxOps::msg_open_new()
  */
 static int mbox_msg_open_new(struct Mailbox *m, struct Message *msg, struct Email *e)
 {
@@ -1548,7 +1548,7 @@ static int mbox_msg_open_new(struct Mailbox *m, struct Message *msg, struct Emai
 }
 
 /**
- * mbox_msg_commit - Implements MxOps::msg_commit()
+ * mbox_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  */
 static int mbox_msg_commit(struct Mailbox *m, struct Message *msg)
 {
@@ -1568,7 +1568,7 @@ static int mbox_msg_commit(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * mbox_msg_close - Implements MxOps::msg_close()
+ * mbox_msg_close - Close an email - Implements MxOps::msg_close()
  */
 static int mbox_msg_close(struct Mailbox *m, struct Message *msg)
 {
@@ -1591,7 +1591,7 @@ static int mbox_msg_padding_size(struct Mailbox *m)
 }
 
 /**
- * mbox_path_probe - Is this an mbox mailbox? - Implements MxOps::path_probe()
+ * mbox_path_probe - Is this an mbox Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType mbox_path_probe(const char *path, const struct stat *st)
 {
@@ -1654,7 +1654,7 @@ enum MailboxType mbox_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * mbox_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * mbox_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int mbox_path_canon(char *buf, size_t buflen)
 {
@@ -1666,7 +1666,7 @@ int mbox_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * mbox_path_pretty - Implements MxOps::path_pretty()
+ * mbox_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int mbox_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -1683,7 +1683,7 @@ int mbox_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * mbox_path_parent - Implements MxOps::path_parent()
+ * mbox_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int mbox_path_parent(char *buf, size_t buflen)
 {
@@ -1703,7 +1703,7 @@ int mbox_path_parent(char *buf, size_t buflen)
 }
 
 /**
- * mmdf_msg_commit - Implements MxOps::msg_commit()
+ * mmdf_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  */
 static int mmdf_msg_commit(struct Mailbox *m, struct Message *msg)
 {
@@ -1730,7 +1730,7 @@ static int mmdf_msg_padding_size(struct Mailbox *m)
 }
 
 /**
- * mbox_mbox_check_stats - Implements MxOps::mbox_check_stats()
+ * mbox_mbox_check_stats - Check the Mailbox statistics - Implements MxOps::mbox_check_stats()
  */
 static int mbox_mbox_check_stats(struct Mailbox *m, int flags)
 {
@@ -1786,7 +1786,7 @@ static int mbox_mbox_check_stats(struct Mailbox *m, int flags)
 
 // clang-format off
 /**
- * MxMboxOps - Mbox mailbox - Implements ::MxOps
+ * MxMboxOps - Mbox Mailbox - Implements ::MxOps
  */
 struct MxOps MxMboxOps = {
   .magic            = MUTT_MBOX,
@@ -1814,7 +1814,7 @@ struct MxOps MxMboxOps = {
 };
 
 /**
- * MxMmdfOps - MMDF mailbox - Implements ::MxOps
+ * MxMmdfOps - MMDF Mailbox - Implements ::MxOps
  */
 struct MxOps MxMmdfOps = {
   .magic            = MUTT_MMDF,
diff --git a/mx.h b/mx.h
index acb8de76e78aecd8cc69c4818f019644522c3602..3308d04af85cef5596a6b519ef27472d82b46eda 100644 (file)
--- a/mx.h
+++ b/mx.h
@@ -107,7 +107,7 @@ struct MxOps
   const char *name;       ///< Mailbox name, e.g. "imap"
 
   /**
-   * ac_find - Find an Account for a Mailbox path
+   * ac_find - Find an Account that matches a Mailbox path
    * @param a    Account to search
    * @param path Path to search for
    * @retval  0 Success
@@ -123,7 +123,7 @@ struct MxOps
    */
   int             (*ac_add)   (struct Account *a, struct Mailbox *m);
   /**
-   * mbox_open - Open a mailbox
+   * mbox_open - Open a Mailbox
    * @param m Mailbox to open
    * @retval  0 Success
    * @retval -1 Error
@@ -170,7 +170,7 @@ struct MxOps
    */
   int (*mbox_close)      (struct Mailbox *m);
   /**
-   * msg_open - Open an email message in Mailbox
+   * msg_open - Open an email message in Mailbox
    * @param m     Mailbox
    * @param msg   Message to open
    * @param msgno Index of message to open
index f5ccd1017a1292f982723b4f0f7ca170bd437368..58c96c10fbf41bb63fc76391b2fc69dcbb722c4a 100644 (file)
@@ -2378,7 +2378,7 @@ int nntp_compare_order(const void *a, const void *b)
 }
 
 /**
- * nntp_ac_find - Find an Account that matches a Mailbox path
+ * nntp_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *nntp_ac_find(struct Account *a, const char *path)
 {
@@ -2407,7 +2407,7 @@ struct Account *nntp_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * nntp_ac_add - Add a Mailbox to an Account
+ * nntp_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int nntp_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -2417,7 +2417,7 @@ int nntp_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * nntp_mbox_open - Implements MxOps::mbox_open()
+ * nntp_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  */
 static int nntp_mbox_open(struct Mailbox *m)
 {
@@ -2573,7 +2573,7 @@ static int nntp_mbox_open(struct Mailbox *m)
 }
 
 /**
- * nntp_mbox_check - Implements MxOps::mbox_check()
+ * nntp_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  * @param m          Mailbox
  * @param index_hint Current message (UNUSED)
  * @retval #MUTT_REOPENED Articles have been renumbered or removed from server
@@ -2597,7 +2597,7 @@ static int nntp_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * nntp_mbox_sync - Implements MxOps::mbox_sync()
+ * nntp_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  *
  * @note May also return values from check_mailbox()
  */
@@ -2659,7 +2659,7 @@ static int nntp_mbox_sync(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * nntp_mbox_close - Implements MxOps::mbox_close()
+ * nntp_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  * @retval 0 Always
  */
 static int nntp_mbox_close(struct Mailbox *m)
@@ -2685,7 +2685,7 @@ static int nntp_mbox_close(struct Mailbox *m)
 }
 
 /**
- * nntp_msg_open - Implements MxOps::msg_open()
+ * nntp_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int nntp_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -2813,7 +2813,7 @@ static int nntp_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * nntp_msg_close - Implements MxOps::msg_close()
+ * nntp_msg_close - Close an email - Implements MxOps::msg_close()
  *
  * @note May also return EOF Failure, see errno
  */
@@ -2823,7 +2823,7 @@ static int nntp_msg_close(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * nntp_path_probe - Is this an NNTP mailbox? - Implements MxOps::path_probe()
+ * nntp_path_probe - Is this an NNTP Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType nntp_path_probe(const char *path, const struct stat *st)
 {
@@ -2840,7 +2840,7 @@ enum MailboxType nntp_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * nntp_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * nntp_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int nntp_path_canon(char *buf, size_t buflen)
 {
@@ -2851,7 +2851,7 @@ int nntp_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * nntp_path_pretty - Implements MxOps::path_pretty()
+ * nntp_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int nntp_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -2860,7 +2860,7 @@ int nntp_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * nntp_path_parent - Implements MxOps::path_parent()
+ * nntp_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int nntp_path_parent(char *buf, size_t buflen)
 {
@@ -2870,7 +2870,7 @@ int nntp_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * MxNntpOps - NNTP mailbox - Implements ::MxOps
+ * MxNntpOps - NNTP Mailbox - Implements ::MxOps
  */
 struct MxOps MxNntpOps = {
   .magic            = MUTT_NNTP,
index 5ec7613ea6c4b9b6826b7afa3e5a999c73389004..7a66158f3700d80dd046200cfb593ecfd9fd1028 100644 (file)
@@ -1915,7 +1915,7 @@ int nm_update_filename(struct Mailbox *m, const char *old_file,
 }
 
 /**
- * nm_mbox_check_stats - Implements MxOps::check_stats()
+ * nm_mbox_check_stats - Check the Mailbox statistics - Implements MxOps::check_stats()
  */
 static int nm_mbox_check_stats(struct Mailbox *m, int flags)
 {
@@ -2116,7 +2116,7 @@ done:
 }
 
 /**
- * nm_ac_find - Find an Account that matches a Mailbox path
+ * nm_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *nm_ac_find(struct Account *a, const char *path)
 {
@@ -2127,7 +2127,7 @@ struct Account *nm_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * nm_ac_add - Add a Mailbox to an Account
+ * nm_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int nm_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -2145,7 +2145,7 @@ int nm_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * nm_mbox_open - Implements MxOps::mbox_open()
+ * nm_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  */
 static int nm_mbox_open(struct Mailbox *m)
 {
@@ -2202,7 +2202,7 @@ static int nm_mbox_open(struct Mailbox *m)
 }
 
 /**
- * nm_mbox_check - Implements MxOps::mbox_check()
+ * nm_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  * @param m           Mailbox
  * @param index_hint  Remember our place in the index
  * @retval -1 Error
@@ -2330,7 +2330,7 @@ done:
 }
 
 /**
- * nm_mbox_sync - Implements MxOps::mbox_sync()
+ * nm_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  */
 static int nm_mbox_sync(struct Mailbox *m, int *index_hint)
 {
@@ -2421,7 +2421,7 @@ static int nm_mbox_sync(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * nm_mbox_close - Implements MxOps::mbox_close()
+ * nm_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  *
  * Nothing to do.
  */
@@ -2431,7 +2431,7 @@ static int nm_mbox_close(struct Mailbox *m)
 }
 
 /**
- * nm_msg_open - Implements MxOps::msg_open()
+ * nm_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int nm_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -2458,7 +2458,7 @@ static int nm_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * nm_msg_commit - Implements MxOps::msg_commit()
+ * nm_msg_commit - Save changes to an email - Implements MxOps::msg_commit()
  * @retval -1 Always
  */
 static int nm_msg_commit(struct Mailbox *m, struct Message *msg)
@@ -2468,7 +2468,7 @@ static int nm_msg_commit(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * nm_msg_close - Implements MxOps::msg_close()
+ * nm_msg_close - Close an email - Implements MxOps::msg_close()
  */
 static int nm_msg_close(struct Mailbox *m, struct Message *msg)
 {
@@ -2479,7 +2479,7 @@ static int nm_msg_close(struct Mailbox *m, struct Message *msg)
 }
 
 /**
- * nm_tags_edit - Implements MxOps::tags_edit()
+ * nm_tags_edit - Prompt and validate new messages tags - Implements MxOps::tags_edit()
  */
 static int nm_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t buflen)
 {
@@ -2490,7 +2490,7 @@ static int nm_tags_edit(struct Mailbox *m, const char *tags, char *buf, size_t b
 }
 
 /**
- * nm_tags_commit - Implements MxOps::tags_commit()
+ * nm_tags_commit - Save the tags to a message - Implements MxOps::tags_commit()
  */
 static int nm_tags_commit(struct Mailbox *m, struct Email *e, char *buf)
 {
@@ -2529,7 +2529,7 @@ done:
 }
 
 /**
- * nm_path_probe - Is this a Notmuch mailbox? - Implements MxOps::path_probe()
+ * nm_path_probe - Is this a Notmuch Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType nm_path_probe(const char *path, const struct stat *st)
 {
@@ -2540,7 +2540,7 @@ enum MailboxType nm_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * nm_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * nm_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int nm_path_canon(char *buf, size_t buflen)
 {
@@ -2551,7 +2551,7 @@ int nm_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * nm_path_pretty - Implements MxOps::path_pretty()
+ * nm_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int nm_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -2560,7 +2560,7 @@ int nm_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * nm_path_parent - Implements MxOps::path_parent()
+ * nm_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int nm_path_parent(char *buf, size_t buflen)
 {
@@ -2570,7 +2570,7 @@ int nm_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * MxNotmuchOps - Notmuch mailbox - Implements ::MxOps
+ * MxNotmuchOps - Notmuch Mailbox - Implements ::MxOps
  */
 struct MxOps MxNotmuchOps = {
   .magic            = MUTT_NOTMUCH,
index 51c4c21328630d85040591c59d6cfd784040dc1e..3b7c4c79a80f84214833124b15128eb851f5f239 100644 (file)
--- a/pop/pop.c
+++ b/pop/pop.c
@@ -747,7 +747,7 @@ fail:
 }
 
 /**
- * pop_ac_find - Find an Account that matches a Mailbox path
+ * pop_ac_find - Find an Account that matches a Mailbox path - Implements MxOps::ac_find()
  */
 struct Account *pop_ac_find(struct Account *a, const char *path)
 {
@@ -772,7 +772,7 @@ struct Account *pop_ac_find(struct Account *a, const char *path)
 }
 
 /**
- * pop_ac_add - Add a Mailbox to an Account
+ * pop_ac_add - Add a Mailbox to an Account - Implements MxOps::ac_add()
  */
 int pop_ac_add(struct Account *a, struct Mailbox *m)
 {
@@ -809,7 +809,7 @@ int pop_ac_add(struct Account *a, struct Mailbox *m)
 }
 
 /**
- * pop_mbox_open - Implements MxOps::mbox_open()
+ * pop_mbox_open - Open a Mailbox - Implements MxOps::mbox_open()
  *
  * Fetch only headers
  */
@@ -888,7 +888,7 @@ static int pop_mbox_open(struct Mailbox *m)
 }
 
 /**
- * pop_mbox_check - Implements MxOps::mbox_check()
+ * pop_mbox_check - Check for new mail - Implements MxOps::mbox_check()
  */
 static int pop_mbox_check(struct Mailbox *m, int *index_hint)
 {
@@ -927,7 +927,7 @@ static int pop_mbox_check(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * pop_mbox_sync - Implements MxOps::mbox_sync()
+ * pop_mbox_sync - Save changes to the Mailbox - Implements MxOps::mbox_sync()
  *
  * Update POP mailbox, delete messages from server
  */
@@ -1019,7 +1019,7 @@ static int pop_mbox_sync(struct Mailbox *m, int *index_hint)
 }
 
 /**
- * pop_mbox_close - Implements MxOps::mbox_close()
+ * pop_mbox_close - Close a Mailbox - Implements MxOps::mbox_close()
  */
 static int pop_mbox_close(struct Mailbox *m)
 {
@@ -1049,7 +1049,7 @@ static int pop_mbox_close(struct Mailbox *m)
 }
 
 /**
- * pop_msg_open - Implements MxOps::msg_open()
+ * pop_msg_open - Open an email message in a Mailbox - Implements MxOps::msg_open()
  */
 static int pop_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 {
@@ -1200,7 +1200,7 @@ static int pop_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
 }
 
 /**
- * pop_msg_close - Implements MxOps::msg_close()
+ * pop_msg_close - Close an email - Implements MxOps::msg_close()
  * @retval 0   Success
  * @retval EOF Error, see errno
  */
@@ -1227,7 +1227,7 @@ static int pop_msg_save_hcache(struct Mailbox *m, struct Email *e)
 }
 
 /**
- * pop_path_probe - Is this a POP mailbox? - Implements MxOps::path_probe()
+ * pop_path_probe - Is this a POP Mailbox? - Implements MxOps::path_probe()
  */
 enum MailboxType pop_path_probe(const char *path, const struct stat *st)
 {
@@ -1244,7 +1244,7 @@ enum MailboxType pop_path_probe(const char *path, const struct stat *st)
 }
 
 /**
- * pop_path_canon - Canonicalise a mailbox path - Implements MxOps::path_canon()
+ * pop_path_canon - Canonicalise a Mailbox path - Implements MxOps::path_canon()
  */
 int pop_path_canon(char *buf, size_t buflen)
 {
@@ -1255,7 +1255,7 @@ int pop_path_canon(char *buf, size_t buflen)
 }
 
 /**
- * pop_path_pretty - Implements MxOps::path_pretty()
+ * pop_path_pretty - Abbreviate a Mailbox path - Implements MxOps::path_pretty()
  */
 int pop_path_pretty(char *buf, size_t buflen, const char *folder)
 {
@@ -1264,7 +1264,7 @@ int pop_path_pretty(char *buf, size_t buflen, const char *folder)
 }
 
 /**
- * pop_path_parent - Implements MxOps::path_parent()
+ * pop_path_parent - Find the parent of a Mailbox path - Implements MxOps::path_parent()
  */
 int pop_path_parent(char *buf, size_t buflen)
 {
@@ -1274,7 +1274,7 @@ int pop_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * MxPopOps - POP mailbox - Implements ::MxOps
+ * MxPopOps - POP Mailbox - Implements ::MxOps
  */
 struct MxOps MxPopOps = {
   .magic            = MUTT_POP,