NeoMutt  2023-05-17-56-ga67199
Teaching an old dog new tricks
DOXYGEN
mutt.h File Reference

Many unsorted constants and some structs. More...

#include "config.h"
#include <limits.h>
#include <stdint.h>
#include <stdbool.h>
+ Include dependency graph for mutt.h:

Go to the source code of this file.

Macros

#define PATH_MAX   4096
 
#define MUTT_COMP_NO_FLAGS   0
 No flags are set. More...
 
#define MUTT_COMP_ALIAS   (1 << 0)
 Alias completion (in alias dialog) More...
 
#define MUTT_COMP_COMMAND   (1 << 1)
 Complete a NeoMutt command. More...
 
#define MUTT_COMP_FILE   (1 << 2)
 File completion (in browser) More...
 
#define MUTT_COMP_FILE_MBOX   (1 << 3)
 File completion, plus incoming folders (in browser) More...
 
#define MUTT_COMP_FILE_SIMPLE   (1 << 4)
 File completion (no browser) More...
 
#define MUTT_COMP_LABEL   (1 << 5)
 Label completion. More...
 
#define MUTT_COMP_NM_QUERY   (1 << 6)
 Notmuch query mode. More...
 
#define MUTT_COMP_NM_TAG   (1 << 7)
 Notmuch tag +/- mode. More...
 
#define MUTT_COMP_PATTERN   (1 << 8)
 Pattern mode (in pattern dialog) More...
 
#define MUTT_COMP_CLEAR   (1 << 9)
 Clear input if printable character is pressed. More...
 
#define MUTT_COMP_PASS   (1 << 10)
 Password mode (no echo) More...
 
#define MUTT_COMP_UNBUFFERED   (1 << 11)
 Ignore macro buffer. More...
 
#define MUTT_SPAM   1
 
#define MUTT_NOSPAM   2
 

Typedefs

typedef uint16_t CompletionFlags
 Flags for mutt_enter_string_full(), e.g. MUTT_COMP_ALIAS. More...
 

Enumerations

enum  MessageType {
  MUTT_ALL = 1 , 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_MT_MAX
}
 To set flags or match patterns. More...
 

Functions

void reset_value (const char *name)
 

Variables

bool StartupComplete
 When the config has been read. More...
 

Detailed Description

Many unsorted constants and some structs.

Authors
  • Michael R. Elkins
  • g10 Code GmbH

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file mutt.h.

Macro Definition Documentation

◆ PATH_MAX

#define PATH_MAX   4096

Definition at line 41 of file mutt.h.

◆ MUTT_COMP_NO_FLAGS

#define MUTT_COMP_NO_FLAGS   0

No flags are set.

Definition at line 55 of file mutt.h.

◆ MUTT_COMP_ALIAS

#define MUTT_COMP_ALIAS   (1 << 0)

Alias completion (in alias dialog)

Definition at line 56 of file mutt.h.

◆ MUTT_COMP_COMMAND

#define MUTT_COMP_COMMAND   (1 << 1)

Complete a NeoMutt command.

Definition at line 57 of file mutt.h.

◆ MUTT_COMP_FILE

#define MUTT_COMP_FILE   (1 << 2)

File completion (in browser)

Definition at line 58 of file mutt.h.

◆ MUTT_COMP_FILE_MBOX

#define MUTT_COMP_FILE_MBOX   (1 << 3)

File completion, plus incoming folders (in browser)

Definition at line 59 of file mutt.h.

◆ MUTT_COMP_FILE_SIMPLE

#define MUTT_COMP_FILE_SIMPLE   (1 << 4)

File completion (no browser)

Definition at line 60 of file mutt.h.

◆ MUTT_COMP_LABEL

#define MUTT_COMP_LABEL   (1 << 5)

Label completion.

Definition at line 61 of file mutt.h.

◆ MUTT_COMP_NM_QUERY

#define MUTT_COMP_NM_QUERY   (1 << 6)

Notmuch query mode.

Definition at line 62 of file mutt.h.

◆ MUTT_COMP_NM_TAG

#define MUTT_COMP_NM_TAG   (1 << 7)

Notmuch tag +/- mode.

Definition at line 63 of file mutt.h.

◆ MUTT_COMP_PATTERN

#define MUTT_COMP_PATTERN   (1 << 8)

Pattern mode (in pattern dialog)

Definition at line 64 of file mutt.h.

◆ MUTT_COMP_CLEAR

#define MUTT_COMP_CLEAR   (1 << 9)

Clear input if printable character is pressed.

Definition at line 65 of file mutt.h.

◆ MUTT_COMP_PASS

#define MUTT_COMP_PASS   (1 << 10)

Password mode (no echo)

Definition at line 66 of file mutt.h.

◆ MUTT_COMP_UNBUFFERED

#define MUTT_COMP_UNBUFFERED   (1 << 11)

Ignore macro buffer.

Definition at line 67 of file mutt.h.

◆ MUTT_SPAM

#define MUTT_SPAM   1

Definition at line 99 of file mutt.h.

◆ MUTT_NOSPAM

#define MUTT_NOSPAM   2

Definition at line 100 of file mutt.h.

Typedef Documentation

◆ CompletionFlags

typedef uint16_t CompletionFlags

Flags for mutt_enter_string_full(), e.g. MUTT_COMP_ALIAS.

Definition at line 54 of file mutt.h.

Enumeration Type Documentation

◆ MessageType

To set flags or match patterns.

See also
mutt_set_flag(), mutt_pattern_func()
Enumerator
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 messages.

MUTT_SUPERSEDED 

Superseded messages.

MUTT_TRASH 

Trashed messages.

MUTT_MT_MAX 

Definition at line 74 of file mutt.h.

75{
76 MUTT_ALL = 1,
77 MUTT_NONE,
78 MUTT_NEW,
79 MUTT_OLD,
81 MUTT_READ,
87 MUTT_FLAG,
88 MUTT_TAG,
94
96};
@ MUTT_ALL
All messages.
Definition: mutt.h:76
@ MUTT_UNDELETE
Messages to be un-deleted.
Definition: mutt.h:84
@ MUTT_TRASH
Trashed messages.
Definition: mutt.h:93
@ MUTT_LIMIT
Messages in limited view.
Definition: mutt.h:90
@ MUTT_UNTAG
Messages to be un-tagged.
Definition: mutt.h:89
@ MUTT_SUPERSEDED
Superseded messages.
Definition: mutt.h:92
@ MUTT_EXPIRED
Expired messages.
Definition: mutt.h:91
@ MUTT_MT_MAX
Definition: mutt.h:95
@ MUTT_READ
Messages that have been read.
Definition: mutt.h:81
@ MUTT_OLD
Old messages.
Definition: mutt.h:79
@ MUTT_PURGE
Messages to be purged (bypass trash)
Definition: mutt.h:85
@ MUTT_NONE
No messages.
Definition: mutt.h:77
@ MUTT_TAG
Tagged messages.
Definition: mutt.h:88
@ MUTT_FLAG
Flagged messages.
Definition: mutt.h:87
@ MUTT_DELETED
Deleted messages.
Definition: mutt.h:86
@ MUTT_DELETE
Messages to be deleted.
Definition: mutt.h:83
@ MUTT_NEW
New messages.
Definition: mutt.h:78
@ MUTT_UNREAD
Unread messages.
Definition: mutt.h:82
@ MUTT_REPLIED
Messages that have been replied to.
Definition: mutt.h:80

Function Documentation

◆ reset_value()

void reset_value ( const char *  name)

Variable Documentation

◆ StartupComplete

bool StartupComplete
extern

When the config has been read.

Definition at line 199 of file main.c.