code/hook_8h_source.html

 #ifndef MUTT_HOOK_H

 #define MUTT_HOOK_H


 #include "config.h"

 #include <stdint.h>

 #include <stdio.h>

 #include "core/lib.h"


 struct Address;

 struct Buffer;

 struct Email;

 struct ListHead;


 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_COMP_MBOX

 #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, intptr_t data, struct Buffer *err);

 enum CommandResult mutt_parse_charset_iconv_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);

 enum CommandResult mutt_parse_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);

 enum CommandResult mutt_parse_unhook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);

 void  mutt_select_fcc(struct Buffer *path, struct Email *e);

 void  mutt_startup_shutdown_hook(HookFlags type);

 void  mutt_timeout_hook(void);


 #endif /* MUTT_HOOK_H */

CommandResult
CommandResult
Error codes for command_t parse functions.
Definition: command.h:34

lib.h
Convenience wrapper for the core headers.

mutt_parse_idxfmt_hook
enum CommandResult mutt_parse_idxfmt_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse the 'index-format-hook' command - Implements Command::parse() -.
Definition: hook.c:406

mutt_parse_hook
enum CommandResult mutt_parse_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse the 'hook' family of commands - Implements Command::parse() -.
Definition: hook.c:126

mutt_parse_charset_iconv_hook
enum CommandResult mutt_parse_charset_iconv_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse 'charset-hook' and 'iconv-hook' commands - Implements Command::parse() -.
Definition: hook.c:81

mutt_parse_unhook
enum CommandResult mutt_parse_unhook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse the 'unhook' command - Implements Command::parse() -.
Definition: hook.c:532

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

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:948

mutt_startup_shutdown_hook
void mutt_startup_shutdown_hook(HookFlags type)
Execute any startup/shutdown hooks.
Definition: hook.c:918

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

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

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

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:731

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

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

mutt_select_fcc
void mutt_select_fcc(struct Buffer *path, struct Email *e)
Select the FCC path for an email.
Definition: hook.c:770

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

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

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

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

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

Mailbox
A mailbox.
Definition: mailbox.h:79