NeoMutt  2024-02-01-23-g345d7b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
hook.h
Go to the documentation of this file.
1
23#ifndef MUTT_HOOK_H
24#define MUTT_HOOK_H
25
26#include "config.h"
27#include <stdint.h>
28#include "core/lib.h"
29
30struct Address;
31struct Buffer;
32struct Email;
33struct ListHead;
34
35typedef uint32_t HookFlags;
36#define MUTT_HOOK_NO_FLAGS 0
37#define MUTT_FOLDER_HOOK (1 << 0)
38#define MUTT_MBOX_HOOK (1 << 1)
39#define MUTT_SEND_HOOK (1 << 2)
40#define MUTT_FCC_HOOK (1 << 3)
41#define MUTT_SAVE_HOOK (1 << 4)
42#define MUTT_CHARSET_HOOK (1 << 5)
43#define MUTT_ICONV_HOOK (1 << 6)
44#define MUTT_MESSAGE_HOOK (1 << 7)
45#define MUTT_CRYPT_HOOK (1 << 8)
46#define MUTT_ACCOUNT_HOOK (1 << 9)
47#define MUTT_REPLY_HOOK (1 << 10)
48#define MUTT_SEND2_HOOK (1 << 11)
49#define MUTT_OPEN_HOOK (1 << 12)
50#define MUTT_APPEND_HOOK (1 << 13)
51#define MUTT_CLOSE_HOOK (1 << 14)
52#define MUTT_IDXFMTHOOK (1 << 15)
53#define MUTT_TIMEOUT_HOOK (1 << 16)
54#define MUTT_STARTUP_HOOK (1 << 17)
55#define MUTT_SHUTDOWN_HOOK (1 << 18)
56#define MUTT_GLOBAL_HOOK (1 << 19)
57
58void hooks_init(void);
59enum CommandResult mutt_parse_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
60
61void mutt_account_hook(const char *url);
62void mutt_crypt_hook(struct ListHead *list, struct Address *addr);
63void mutt_default_save(struct Buffer *path, struct Email *e);
65char *mutt_find_hook(HookFlags type, const char *pat);
66void mutt_folder_hook(const char *path, const char *desc);
67const char *mutt_idxfmt_hook(const char *name, struct Mailbox *m, struct Email *e);
68void mutt_message_hook(struct Mailbox *m, struct Email *e, HookFlags type);
69enum CommandResult mutt_parse_charset_iconv_hook(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
70void mutt_select_fcc(struct Buffer *path, struct Email *e);
72void mutt_timeout_hook(void);
73
74#endif /* MUTT_HOOK_H */
CommandResult
Error codes for command_t parse functions.
Definition: command.h:36
Convenience wrapper for the core headers.
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:162
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:119
void mutt_default_save(struct Buffer *path, struct Email *e)
Find the default save path for an email.
Definition: hook.c:748
void mutt_timeout_hook(void)
Execute any timeout hooks.
Definition: hook.c:902
char * mutt_find_hook(HookFlags type, const char *pat)
Find a matching hook.
Definition: hook.c:650
void mutt_startup_shutdown_hook(HookFlags type)
Execute any startup/shutdown hooks.
Definition: hook.c:934
void mutt_delete_hooks(HookFlags type)
Delete matching hooks.
Definition: hook.c:380
uint32_t HookFlags
Flags for mutt_parse_hook(), e.g. MUTT_FOLDER_HOOK.
Definition: hook.h:35
void mutt_account_hook(const char *url)
Perform an account hook.
Definition: hook.c:857
const char * mutt_idxfmt_hook(const char *name, struct Mailbox *m, struct Email *e)
Get index-format-hook format string.
Definition: hook.c:964
void mutt_folder_hook(const char *path, const char *desc)
Perform a folder hook.
Definition: hook.c:602
void mutt_select_fcc(struct Buffer *path, struct Email *e)
Select the FCC path for an email.
Definition: hook.c:786
void hooks_init(void)
Setup feature commands.
Definition: hook.c:1024
void mutt_crypt_hook(struct ListHead *list, struct Address *addr)
Find crypto hooks for an Address.
Definition: hook.c:848
void mutt_message_hook(struct Mailbox *m, struct Email *e, HookFlags type)
Perform a message hook.
Definition: hook.c:671
An email address.
Definition: address.h:36
String manipulation buffer.
Definition: buffer.h:36
The envelope/body of an email.
Definition: email.h:39
A mailbox.
Definition: mailbox.h:79