hook_8h_source.html

#ifndef MUTT_HOOK_H

#define MUTT_HOOK_H


#include "config.h"

#include <stdint.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)

#define MUTT_OPEN_HOOK     (1 << 12)

#define MUTT_APPEND_HOOK   (1 << 13)

#define MUTT_CLOSE_HOOK    (1 << 14)

#define MUTT_IDXFMTHOOK    (1 << 15)

#define MUTT_TIMEOUT_HOOK  (1 << 16)

#define MUTT_STARTUP_HOOK  (1 << 17)

#define MUTT_SHUTDOWN_HOOK (1 << 18)


void hooks_init(void);


enum CommandResult parse_hook_charset (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_compress(const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_crypt   (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_folder  (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_global  (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_index   (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_mailbox (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_mbox    (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_pattern (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_hook_regex   (const struct Command *cmd, struct Buffer *line, struct Buffer *err);

enum CommandResult parse_unhook       (const struct Command *cmd, struct Buffer *line, struct Buffer *err);


void                  mutt_account_hook            (const char *url);

void                  mutt_crypt_hook              (struct ListHead *list, struct Address *addr);

void                  mutt_default_save            (struct Buffer *path, 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 struct Expando *mutt_idxfmt_hook             (const char *name, struct Mailbox *m, struct Email *e);

void                  mutt_message_hook            (struct Mailbox *m, struct Email *e, HookFlags type);

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

lib.h
Convenience wrapper for the core headers.

parse_hook_folder
enum CommandResult parse_hook_folder(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse folder hook command - Implements Command::parse() -.
Definition hook.c:550

parse_unhook
enum CommandResult parse_unhook(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse the unhook command - Implements Command::parse() -.
Definition hook.c:1223

parse_hook_pattern
enum CommandResult parse_hook_pattern(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse pattern-based hook commands - Implements Command::parse() -.
Definition hook.c:241

parse_hook_regex
enum CommandResult parse_hook_regex(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse regex-based hook command - Implements Command::parse() -.
Definition hook.c:457

parse_hook_compress
enum CommandResult parse_hook_compress(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse compress hook commands - Implements Command::parse() -.
Definition hook.c:927

parse_hook_index
enum CommandResult parse_hook_index(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse the index format hook command - Implements Command::parse() -.
Definition hook.c:1076

parse_hook_mailbox
enum CommandResult parse_hook_mailbox(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse mailbox pattern hook commands - Implements Command::parse() -.
Definition hook.c:348

parse_hook_global
enum CommandResult parse_hook_global(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse global hook commands - Implements Command::parse() -.
Definition hook.c:178

parse_hook_charset
enum CommandResult parse_hook_charset(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse charset hook commands - Implements Command::parse() -.
Definition hook.c:126

parse_hook_crypt
enum CommandResult parse_hook_crypt(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse crypt hook commands - Implements Command::parse() -.
Definition hook.c:687

parse_hook_mbox
enum CommandResult parse_hook_mbox(const struct Command *cmd, struct Buffer *line, struct Buffer *err)
Parse mbox hook command - Implements Command::parse() -.
Definition hook.c:780

mutt_default_save
void mutt_default_save(struct Buffer *path, struct Email *e)
Find the default save path for an email.
Definition hook.c:1438

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

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

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

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

HookFlags
uint32_t HookFlags
Flags for parse_hook(), e.g. MUTT_FOLDER_HOOK.
Definition hook.h:35

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

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

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

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

hooks_init
void hooks_init(void)
Setup feature commands.
Definition hook.c:1769

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

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

Address
An email address.
Definition address.h:35

Buffer
String manipulation buffer.
Definition buffer.h:36

Command
Definition command.h:58

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

Expando
Parsed Expando trees.
Definition expando.h:41

Mailbox
A mailbox.
Definition mailbox.h:79