lib.h

Go to the documentation of this file.

#ifndef MUTT_IMAP_LIB_H
#define MUTT_IMAP_LIB_H

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <sys/types.h>
#include "core/lib.h"
#include "mx.h"

struct BrowserState;
struct Buffer;
struct ConfigSet;
struct ConnAccount;
struct EmailList;
struct PatternList;
struct stat;

// These Config Variables are used outside of libimap
extern short C_ImapKeepalive;
extern bool  C_ImapListSubscribed;
extern bool  C_ImapPassive;
extern bool  C_ImapPeek;

/* imap.c */
void imap_init(void);
int imap_access(const char *path);
int imap_check_mailbox(struct Mailbox *m, bool force);
int imap_delete_mailbox(struct Mailbox *m, char *path);
int imap_sync_mailbox(struct Mailbox *m, bool expunge, bool close);
int imap_path_status(const char *path, bool queue);
int imap_mailbox_status(struct Mailbox *m, bool queue);
int imap_subscribe(char *path, bool subscribe);
int imap_complete(char *buf, size_t buflen, const char *path);
int imap_fast_trash(struct Mailbox *m, char *dest);
enum MailboxType imap_path_probe(const char *path, const struct stat *st);
int imap_path_canon(char *buf, size_t buflen);
void imap_notify_delete_email(struct Mailbox *m, struct Email *e);

extern struct MxOps MxImapOps;

/* browse.c */
int imap_browse(const char *path, struct BrowserState *state);
int imap_mailbox_create(const char *folder);
int imap_mailbox_rename(const char *path);

/* config.c */
bool config_init_imap(struct ConfigSet *cs);

/* message.c */
int imap_copy_messages(struct Mailbox *m, struct EmailList *el, const char *dest, bool delete_original);

/* socket.c */
void imap_logout_all(void);

/* util.c */
int imap_expand_path(struct Buffer *buf);
int imap_parse_path(const char *path, struct ConnAccount *cac, char *mailbox, size_t mailboxlen);
void imap_pretty_mailbox(char *path, size_t pathlen, const char *folder);
int imap_mxcmp(const char *mx1, const char *mx2);

int imap_wait_keepalive(pid_t pid);
void imap_keepalive(void);

void imap_get_parent_path(const char *path, char *buf, size_t buflen);
void imap_clean_path(char *path, size_t plen);

/* search.c */
bool imap_search(struct Mailbox *m, const struct PatternList *pat);

#endif /* MUTT_IMAP_LIB_H */