code/hook_8h_source.html

 #ifndef MUTT_HOOK_H
 #define MUTT_HOOK_H

 #include "config.h"
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdio.h>
 #include "mutt_commands.h"

 struct Address;
 struct Buffer;
 struct Email;
 struct ListHead;
 struct Mailbox;

 /* These Config Variables are only used in hook.c */
 extern char *C_DefaultHook;
 extern bool  C_ForceName;
 extern bool  C_SaveName;

 typedef uint32_t HookFlags;
 #define MUTT_HOOK_NO_FLAGS       0
 #define MUTT_FOLDER_HOOK   (1 << 0)
 #define MUTT_MBOX_HOOK     (1 << 1)
 #define MUTT_SEND_HOOK     (1 << 2)
 #define MUTT_FCC_HOOK      (1 << 3)
 #define MUTT_SAVE_HOOK     (1 << 4)
 #define MUTT_CHARSET_HOOK  (1 << 5)
 #define MUTT_ICONV_HOOK    (1 << 6)
 #define MUTT_MESSAGE_HOOK  (1 << 7)
 #define MUTT_CRYPT_HOOK    (1 << 8)
 #define MUTT_ACCOUNT_HOOK  (1 << 9)
 #define MUTT_REPLY_HOOK    (1 << 10)
 #define MUTT_SEND2_HOOK    (1 << 11)
 #ifdef USE_COMPRESSED
 #define MUTT_OPEN_HOOK     (1 << 12)
 #define MUTT_APPEND_HOOK   (1 << 13)
 #define MUTT_CLOSE_HOOK    (1 << 14)
 #endif
 #define MUTT_IDXFMTHOOK    (1 << 15)
 #define MUTT_TIMEOUT_HOOK  (1 << 16)
 #define MUTT_STARTUP_HOOK  (1 << 17)
 #define MUTT_SHUTDOWN_HOOK (1 << 18)
 #define MUTT_GLOBAL_HOOK   (1 << 19)

 void  mutt_account_hook(const char *url);
 void  mutt_crypt_hook(struct ListHead *list, struct Address *addr);
 void  mutt_default_save(char *path, size_t pathlen, struct Email *e);
 void  mutt_delete_hooks(HookFlags type);
 char *mutt_find_hook(HookFlags type, const char *pat);
 void  mutt_folder_hook(const char *path, const char *desc);
 const char *mutt_idxfmt_hook(const char *name, struct Mailbox *m, struct Email *e);
 void  mutt_message_hook(struct Mailbox *m, struct Email *e, HookFlags type);
 enum CommandResult mutt_parse_idxfmt_hook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
 enum CommandResult mutt_parse_hook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
 enum CommandResult mutt_parse_unhook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
 void  mutt_select_fcc(char *path, size_t pathlen, struct Email *e);
 void  mutt_startup_shutdown_hook(HookFlags type);
 void  mutt_timeout_hook(void);

 #endif /* MUTT_HOOK_H */
mutt_startup_shutdown_hook
void mutt_startup_shutdown_hook(HookFlags type)
Execute any startup/shutdown hooks.
Definition: hook.c:845

Email
The envelope/body of an email.
Definition: email.h:39

CommandResult
CommandResult
Error codes for command_t parse functions.
Definition: mutt_commands.h:33

mutt_parse_hook
enum CommandResult mutt_parse_hook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
Parse the &#39;hook&#39; family of commands - Implements command_t.
Definition: hook.c:85

mutt_crypt_hook
void mutt_crypt_hook(struct ListHead *list, struct Address *addr)
Find crypto hooks for an Address.
Definition: hook.c:748

mutt_timeout_hook
void mutt_timeout_hook(void)
Execute any timeout hooks.
Definition: hook.c:806

mutt_parse_idxfmt_hook
enum CommandResult mutt_parse_idxfmt_hook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
Parse the &#39;index-format-hook&#39; command - Implements command_t.
Definition: hook.c:363

Buffer
String manipulation buffer.
Definition: buffer.h:33

Address
An email address.
Definition: address.h:34

HookFlags
uint32_t HookFlags
Flags for mutt_parse_hook(), e.g. MUTT_FOLDER_HOOK.
Definition: hook.h:43

mutt_delete_hooks
void mutt_delete_hooks(HookFlags type)
Delete matching hooks.
Definition: hook.c:316

mutt_message_hook
void mutt_message_hook(struct Mailbox *m, struct Email *e, HookFlags type)
Perform a message hook.
Definition: hook.c:579

C_ForceName
bool C_ForceName
Config: Save outgoing mail in a folder of their name.
Definition: hook.c:59

name
const char * name
Definition: pgpmicalg.c:45

mutt_account_hook
void mutt_account_hook(const char *url)
Perform an account hook.
Definition: hook.c:758

mutt_find_hook
char * mutt_find_hook(HookFlags type, const char *pat)
Find a matching hook.
Definition: hook.c:558

Mailbox
A mailbox.
Definition: mailbox.h:92

C_DefaultHook
char * C_DefaultHook
Config: Pattern to use for hooks that only have a simple regex.
Definition: hook.c:58

mutt_default_save
void mutt_default_save(char *path, size_t pathlen, struct Email *e)
Find the default save path for an email.
Definition: hook.c:662

mutt_commands.h
Mapping from user command name to function.

mutt_select_fcc
void mutt_select_fcc(char *path, size_t pathlen, struct Email *e)
Select the FCC path for an email.
Definition: hook.c:700

mutt_folder_hook
void mutt_folder_hook(const char *path, const char *desc)
Perform a folder hook.
Definition: hook.c:516

mutt_parse_unhook
enum CommandResult mutt_parse_unhook(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
Parse the &#39;unhook&#39; command - Implements command_t.
Definition: hook.c:465

C_SaveName
bool C_SaveName
Config: Save outgoing message to mailbox of recipient&#39;s name if it exists.
Definition: hook.c:60

mutt_idxfmt_hook
const char * mutt_idxfmt_hook(const char *name, struct Mailbox *m, struct Email *e)
Get index-format-hook format string.
Definition: hook.c:878