/**
* enum HeaderField - Ordered list of headers for the compose screen
+ *
+ * The position of various fields on the compose screen.
*/
enum HeaderField
{
- HDR_FROM = 0, ///< Position for From: field
- HDR_TO, ///< Position for To: field
- HDR_CC, ///< Position for Cc: field
- HDR_BCC, ///< Position for Bcc: field
- HDR_SUBJECT, ///< Position for Subject: field
- HDR_REPLYTO, ///< Position for Reply-To: field
- HDR_FCC, ///< Position for Fcc: (save folder) field
-
+ HDR_FROM = 0, ///< "From:" field
+ HDR_TO, ///< "To:" field
+ HDR_CC, ///< "Cc:" field
+ HDR_BCC, ///< "Bcc:" field
+ HDR_SUBJECT, ///< "Subject:" field
+ HDR_REPLYTO, ///< "Reply-To:" field
+ HDR_FCC, ///< "Fcc:" (save folder) field
#ifdef MIXMASTER
- HDR_MIX,
+ HDR_MIX, ///< "Mix:" field (Mixmaster chain)
#endif
-
- HDR_CRYPT,
- HDR_CRYPTINFO,
-
+ HDR_CRYPT, ///< "Security:" field (encryption/signing info)
+ HDR_CRYPTINFO, ///< "Sign as:" field (encryption/signing info)
#ifdef USE_NNTP
- HDR_NEWSGROUPS,
- HDR_FOLLOWUPTO,
- HDR_XCOMMENTTO,
+ HDR_NEWSGROUPS, ///< "Newsgroups:" field
+ HDR_FOLLOWUPTO, ///< "Followup-To:" field
+ HDR_XCOMMENTTO, ///< "X-Comment-To:" field
#endif
-
- HDR_ATTACH = (HDR_FCC + 5), ///< position to start printing the attachments
+ HDR_ATTACH = (HDR_FCC + 5), ///< Position to start printing the attachments
};
int HeaderPadding[HDR_XCOMMENTTO + 1] = { 0 };
*/
enum AddressError
{
- ADDR_ERR_MEMORY = 1,
- ADDR_ERR_MISMATCH_PAREN,
- ADDR_ERR_MISMATCH_QUOTE,
- ADDR_ERR_BAD_ROUTE,
- ADDR_ERR_BAD_ROUTE_ADDR,
- ADDR_ERR_BAD_ADDR_SPEC,
+ ADDR_ERR_MEMORY = 1, ///< Out of memory
+ ADDR_ERR_MISMATCH_PAREN, ///< Mismatched parentheses
+ ADDR_ERR_MISMATCH_QUOTE, ///< Mismatches quotes
+ ADDR_ERR_BAD_ROUTE, ///< Bad route
+ ADDR_ERR_BAD_ROUTE_ADDR, ///< Bad route address
+ ADDR_ERR_BAD_ADDR_SPEC, ///< Bad address specifier
};
extern int AddressError;
*/
enum ContentType
{
- TYPE_OTHER,
- TYPE_AUDIO,
- TYPE_APPLICATION,
- TYPE_IMAGE,
- TYPE_MESSAGE,
- TYPE_MODEL,
- TYPE_MULTIPART,
- TYPE_TEXT,
- TYPE_VIDEO,
- TYPE_ANY
+ TYPE_OTHER, ///< Unknown Content-Type
+ TYPE_AUDIO, ///< Type: 'audio/*'
+ TYPE_APPLICATION, ///< Type: 'application/*'
+ TYPE_IMAGE, ///< Type: 'image/*'
+ TYPE_MESSAGE, ///< Type: 'message/*'
+ TYPE_MODEL, ///< Type: 'model/*'
+ TYPE_MULTIPART, ///< Type: 'multipart/*'
+ TYPE_TEXT, ///< Type: 'text/*'
+ TYPE_VIDEO, ///< Type: 'video/*'
+ TYPE_ANY, ///< Type: '*' or '.*'
};
/**
*/
enum RichAttribs
{
- RICH_PARAM = 0,
- RICH_BOLD,
- RICH_UNDERLINE,
- RICH_ITALIC,
- RICH_NOFILL,
- RICH_INDENT,
- RICH_INDENT_RIGHT,
- RICH_EXCERPT,
- RICH_CENTER,
- RICH_FLUSHLEFT,
- RICH_FLUSHRIGHT,
- RICH_COLOR,
+ RICH_PARAM = 0, ///< Parameter label
+ RICH_BOLD, ///< Bold text
+ RICH_UNDERLINE, ///< Underlined text
+ RICH_ITALIC, ///< Italic text
+ RICH_NOFILL, ///< Text will not be reformatted
+ RICH_INDENT, ///< Indented text
+ RICH_INDENT_RIGHT, ///< Right-indented text
+ RICH_EXCERPT, ///< Excerpt text
+ RICH_CENTER, ///< Centred text
+ RICH_FLUSHLEFT, ///< Left-justified text
+ RICH_FLUSHRIGHT, ///< Right-justified text
+ RICH_COLOR, ///< Coloured text
RICH_MAX,
};
*/
enum MdbTxnMode
{
- TXN_UNINITIALIZED,
- TXN_READ,
- TXN_WRITE
+ TXN_UNINITIALIZED, ///< Transaction is uninitialised
+ TXN_READ, ///< Read transaction in progress
+ TXN_WRITE, ///< Write transaction in progress
};
/**
/**
* enum FieldType - Header types
+ *
+ * Strings for printing headers
*/
enum FieldType
{
- DISP_TO,
- DISP_CC,
- DISP_BCC,
- DISP_FROM,
- DISP_PLAIN,
- DISP_NUM
+ DISP_TO, ///< To: string
+ DISP_CC, ///< Cc: string
+ DISP_BCC, ///< Bcc: string
+ DISP_FROM, ///< From: string
+ DISP_PLAIN, ///< Empty string
+ DISP_MAX,
};
/**
{
/* need 2 bytes at the end, one for the space, another for NUL */
static char padded[8];
- static const char *long_prefixes[DISP_NUM] = {
+ static const char *long_prefixes[DISP_MAX] = {
[DISP_TO] = "To ", [DISP_CC] = "Cc ", [DISP_BCC] = "Bcc ",
[DISP_FROM] = "", [DISP_PLAIN] = "",
};
*/
enum ImapAuthRes
{
- IMAP_AUTH_SUCCESS = 0,
- IMAP_AUTH_FAILURE,
- IMAP_AUTH_UNAVAIL
+ IMAP_AUTH_SUCCESS = 0, ///< Authentication successful
+ IMAP_AUTH_FAILURE, ///< Authentication failed
+ IMAP_AUTH_UNAVAIL, ///< Authentication method not permitted
};
/**
*/
enum GroupState
{
- GS_NONE,
- GS_RX,
- GS_ADDR
+ GS_NONE, ///< Group is missing an argument
+ GS_RX, ///< Entry is a regular expression
+ GS_ADDR, ///< Entry is an address
};
/**
*/
enum MenuTypes
{
- MENU_ALIAS,
- MENU_ATTACH,
- MENU_COMPOSE,
- MENU_EDITOR,
- MENU_FOLDER,
- MENU_GENERIC,
- MENU_MAIN,
- MENU_PAGER,
- MENU_POST,
- MENU_QUERY,
-
- MENU_PGP,
- MENU_SMIME,
-
+ MENU_ALIAS, ///< Select an email address by its alias
+ MENU_ATTACH, ///< Select an attachment
+ MENU_COMPOSE, ///< Compose an email
+ MENU_EDITOR, ///< Text entry area
+ MENU_FOLDER, ///< General file/mailbox browser
+ MENU_GENERIC, ///< Generic selection list
+ MENU_MAIN, ///< Index panel (list of emails)
+ MENU_PAGER, ///< Pager pager (email viewer)
+ MENU_POST, ///< Select a postponed email
+ MENU_QUERY, ///< Select from results of external query
+ MENU_PGP, ///< PGP encryption menu
+ MENU_SMIME, ///< SMIME encryption menu
#ifdef CRYPT_BACKEND_GPGME
- MENU_KEY_SELECT_PGP,
- MENU_KEY_SELECT_SMIME,
+ MENU_KEY_SELECT_PGP, ///< Select a PGP key
+ MENU_KEY_SELECT_SMIME, ///< Select a SMIME key
#endif
#ifdef MIXMASTER
- MENU_MIX,
+ MENU_MIX, ///< Create/edit a Mixmaster chain
#endif
MENU_MAX
*/
enum MuttMisc
{
- /* modes for mutt_view_attachment() */
- MUTT_REGULAR = 1,
- MUTT_MAILCAP,
- MUTT_AS_TEXT,
-
- /* action codes used by mutt_set_flag() and mutt_pattern_function() */
- MUTT_ALL,
- MUTT_NONE,
- MUTT_NEW,
- MUTT_OLD,
- MUTT_REPLIED,
- MUTT_READ,
- MUTT_UNREAD,
- MUTT_DELETE,
- MUTT_UNDELETE,
- MUTT_PURGE,
- MUTT_DELETED,
- MUTT_FLAG,
- MUTT_TAG,
- MUTT_UNTAG,
- MUTT_LIMIT,
- MUTT_EXPIRED,
- MUTT_SUPERSEDED,
- MUTT_TRASH,
+ /* mutt_view_attachment() */
+ MUTT_REGULAR = 1, ///< View using default method
+ MUTT_MAILCAP, ///< Force viewing using mailcap entry
+ MUTT_AS_TEXT, ///< Force viewing as text
+
+ /* action codes used by mutt_set_flag() and mutt_pattern_func() */
+ MUTT_ALL, ///< All messages
+ MUTT_NONE, ///< No messages
+ MUTT_NEW, ///< New messages
+ MUTT_OLD, ///< Old messages
+ MUTT_REPLIED, ///< Messages that have been replied to
+ MUTT_READ, ///< Messages that have been read
+ MUTT_UNREAD, ///< Unread messages
+ MUTT_DELETE, ///< Messages to be deleted
+ MUTT_UNDELETE, ///< Messages to be un-deleted
+ MUTT_PURGE, ///< Messages to be purged (bypass trash)
+ MUTT_DELETED, ///< Deleted messages
+ MUTT_FLAG, ///< Flagged messages
+ MUTT_TAG, ///< Tagged messages
+ MUTT_UNTAG, ///< Messages to be un-tagged
+ MUTT_LIMIT, ///< Messages in limited view
+ MUTT_EXPIRED, ///< Expired messsages
+ MUTT_SUPERSEDED, ///< Superseded messages
+ MUTT_TRASH, ///< Trashed messages
/* actions for mutt_pattern_comp/mutt_pattern_exec */
MUTT_AND,
#endif
/* Options for Mailcap lookup */
- MUTT_EDIT,
- MUTT_COMPOSE,
- MUTT_PRINT,
- MUTT_AUTOVIEW,
-
- /* options for socket code */
- MUTT_NEW_SOCKET,
-#ifdef USE_SSL_OPENSSL
- MUTT_NEW_SSL_SOCKET,
-#endif
+ MUTT_EDIT, ///< Mailcap edit field
+ MUTT_COMPOSE, ///< Mailcap compose field
+ MUTT_PRINT, ///< Mailcap print field
+ MUTT_AUTOVIEW, ///< Mailcap autoview field
- /* Options for mutt_save_attachment */
- MUTT_SAVE_APPEND,
- MUTT_SAVE_OVERWRITE
+ MUTT_SAVE_APPEND, ///< Append to existing file - mutt_save_attachment()
+ MUTT_SAVE_OVERWRITE, ///< Overwrite existing file - mutt_save_attachment()
};
/* flags for parse_spam_list */
*/
enum LookupType
{
- MUTT_LOOKUP_CHARSET,
- MUTT_LOOKUP_ICONV
+ MUTT_LOOKUP_CHARSET, ///< Alias for another character set
+ MUTT_LOOKUP_ICONV, ///< Character set conversion
};
#define MUTT_ICONV_HOOK_FROM 1 /**< apply charset-hooks to fromcode */
/**
* enum HistoryClass - Type to differentiate different histories
+ *
+ * Saved lists of recently-used:
*/
enum HistoryClass
{
- HC_CMD,
- HC_ALIAS,
- HC_COMMAND,
- HC_FILE,
- HC_PATTERN,
- HC_OTHER,
- HC_MBOX,
- /* insert new items here to keep history file working */
+ HC_CMD, ///< External commands
+ HC_ALIAS, ///< Aliases
+ HC_COMMAND, ///< NeoMutt commands
+ HC_FILE, ///< Files
+ HC_PATTERN, ///< Patterns
+ HC_OTHER, ///< Miscellaneous strings
+ HC_MBOX, ///< Mailboxes
HC_MAX,
};
*/
enum ColorId
{
- MT_COLOR_HDEFAULT = 0,
- MT_COLOR_QUOTED,
- MT_COLOR_SIGNATURE,
- MT_COLOR_INDICATOR,
- MT_COLOR_STATUS,
- MT_COLOR_TREE,
- MT_COLOR_NORMAL,
- MT_COLOR_ERROR,
- MT_COLOR_TILDE,
- MT_COLOR_MARKERS,
- MT_COLOR_BODY,
- MT_COLOR_HEADER,
- MT_COLOR_MESSAGE,
- MT_COLOR_ATTACHMENT,
- MT_COLOR_ATTACH_HEADERS,
- MT_COLOR_SEARCH,
- MT_COLOR_BOLD,
- MT_COLOR_UNDERLINE,
- MT_COLOR_PROMPT,
- MT_COLOR_PROGRESS,
+ MT_COLOR_HDEFAULT = 0, ///< Header default colour
+ MT_COLOR_QUOTED, ///< Pager: quoted text
+ MT_COLOR_SIGNATURE, ///< Pager: signature lines
+ MT_COLOR_INDICATOR, ///< Selected item in list
+ MT_COLOR_STATUS, ///< Status bar
+ MT_COLOR_TREE, ///< Index: tree-drawing characters
+ MT_COLOR_NORMAL, ///< Plain text
+ MT_COLOR_ERROR, ///< Error message
+ MT_COLOR_TILDE, ///< Pager: empty lines after message
+ MT_COLOR_MARKERS, ///< Pager: markers, line continuation
+ MT_COLOR_BODY, ///< Pager: highlight body of message (takes a pattern)
+ MT_COLOR_HEADER, ///< Message headers (takes a pattern)
+ MT_COLOR_MESSAGE, ///< Informational message
+ MT_COLOR_ATTACHMENT, ///< MIME attachments text (entire line)
+ MT_COLOR_ATTACH_HEADERS, ///< MIME attachment test (takes a pattern)
+ MT_COLOR_SEARCH, ///< Pager: search matches
+ MT_COLOR_BOLD, ///< Bold text
+ MT_COLOR_UNDERLINE, ///< Underlined text
+ MT_COLOR_PROMPT, ///< Question/user input
+ MT_COLOR_PROGRESS, ///< Progress bar
#ifdef USE_SIDEBAR
- MT_COLOR_DIVIDER,
- MT_COLOR_FLAGGED,
- MT_COLOR_HIGHLIGHT,
- MT_COLOR_NEW,
- MT_COLOR_ORDINARY,
- MT_COLOR_SB_INDICATOR,
- MT_COLOR_SB_SPOOLFILE,
+ MT_COLOR_DIVIDER, ///< Line dividing sidebar from the index/pager
+ MT_COLOR_FLAGGED, ///< Mailbox with flagged messages
+ MT_COLOR_HIGHLIGHT, ///< Select cursor
+ MT_COLOR_NEW, ///< Mailbox with new mail
+ MT_COLOR_ORDINARY, ///< Mailbox with no new or flagged messages
+ MT_COLOR_SB_INDICATOR, ///< Current open mailbox
+ MT_COLOR_SB_SPOOLFILE, ///< $spoolfile (Spool mailbox)
#endif
- MT_COLOR_MESSAGE_LOG,
+ MT_COLOR_MESSAGE_LOG, ///< Menu showing log messages
/* please no non-MT_COLOR_INDEX objects after this point */
- MT_COLOR_INDEX,
- MT_COLOR_INDEX_AUTHOR,
- MT_COLOR_INDEX_FLAGS,
- MT_COLOR_INDEX_TAG,
- MT_COLOR_INDEX_SUBJECT,
+ MT_COLOR_INDEX, ///< Index: default colour (takes a pattern)
+ MT_COLOR_INDEX_AUTHOR, ///< Index: author field (takes a pattern)
+ MT_COLOR_INDEX_FLAGS, ///< Index: flags field (takes a pattern)
+ MT_COLOR_INDEX_TAG, ///< Index: tag field (%g, takes a pattern)
+ MT_COLOR_INDEX_SUBJECT, ///< Index: subject field (takes a pattern)
/* below here - only index coloring stuff that doesn't have a pattern */
- MT_COLOR_INDEX_COLLAPSED,
- MT_COLOR_INDEX_DATE,
- MT_COLOR_INDEX_LABEL,
- MT_COLOR_INDEX_NUMBER,
- MT_COLOR_INDEX_SIZE,
- MT_COLOR_INDEX_TAGS,
- MT_COLOR_COMPOSE_HEADER,
- MT_COLOR_COMPOSE_SECURITY_ENCRYPT,
- MT_COLOR_COMPOSE_SECURITY_SIGN,
- MT_COLOR_COMPOSE_SECURITY_BOTH,
- MT_COLOR_COMPOSE_SECURITY_NONE,
- MT_COLOR_MAX
+ MT_COLOR_INDEX_COLLAPSED, ///< Index: number of messages in collapsed thread
+ MT_COLOR_INDEX_DATE, ///< Index: date field
+ MT_COLOR_INDEX_LABEL, ///< Index: label field
+ MT_COLOR_INDEX_NUMBER, ///< Index: index number
+ MT_COLOR_INDEX_SIZE, ///< Index: size field
+ MT_COLOR_INDEX_TAGS, ///< Index: tags field (%g, %J)
+ MT_COLOR_COMPOSE_HEADER, ///< Header labels, e.g. From:
+ MT_COLOR_COMPOSE_SECURITY_ENCRYPT, ///< Mail will be encrypted
+ MT_COLOR_COMPOSE_SECURITY_SIGN, ///< Mail will be signed
+ MT_COLOR_COMPOSE_SECURITY_BOTH, ///< Mail will be encrypted and signed
+ MT_COLOR_COMPOSE_SECURITY_NONE, ///< Mail will not be encrypted or signed
+ MT_COLOR_MAX,
};
/**
*/
enum NntpStatus
{
- NNTP_NONE = 0,
- NNTP_OK,
- NNTP_BYE
+ NNTP_NONE = 0, ///< No connection to server
+ NNTP_OK, ///< Connected to server
+ NNTP_BYE, ///< Disconnected from server
};
void nntp_acache_free(struct NntpMboxData *mdata);
*/
enum RangeType
{
- RANGE_K_REL,
- RANGE_K_ABS,
- RANGE_K_LT,
- RANGE_K_GT,
- RANGE_K_BARE,
+ RANGE_K_REL, ///< Relative range
+ RANGE_K_ABS, ///< Absolute range
+ RANGE_K_LT, ///< Less-than range
+ RANGE_K_GT, ///< Greater-than range
+ RANGE_K_BARE, ///< Single symbol
/* add new ones HERE */
- RANGE_K_INVALID
+ RANGE_K_INVALID, ///< Range is invalid
};
/**
*/
enum PatternExecFlag
{
- MUTT_MATCH_FULL_ADDRESS = 1
+ MUTT_MATCH_FULL_ADDRESS = 1, ///< Match the full address
};
/**
*/
enum PopAuthRes
{
- POP_A_SUCCESS = 0,
- POP_A_SOCKET,
- POP_A_FAILURE,
- POP_A_UNAVAIL
+ POP_A_SUCCESS = 0, ///< Authenticated successfully
+ POP_A_SOCKET, ///< Connection lost
+ POP_A_FAILURE, ///< Authentication failed
+ POP_A_UNAVAIL, ///< No valid authentication method
};
/**
*/
enum XdgType
{
- XDG_CONFIG_HOME,
- XDG_CONFIG_DIRS,
+ XDG_CONFIG_HOME, ///< XDG home dir: ~/.config
+ XDG_CONFIG_DIRS, ///< XDG system dir: /etc/xdg
};
int mutt_system(const char *cmd);
projects / neomutt / commitdiff