private.h

Go to the documentation of this file.

 
#ifndef MUTT_IMAP_PRIVATE_H
#define MUTT_IMAP_PRIVATE_H
 
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "config/lib.h"
 
struct Buffer;
struct ConnAccount;
struct Email;
struct ImapAccountData;
struct ImapMboxData;
struct ListHead;
struct Mailbox;
struct Message;
struct Progress;
 
#define IMAP_PORT     143  
#define IMAP_SSL_PORT 993  
 
/* logging levels */
#define IMAP_LOG_CMD  2
#define IMAP_LOG_LTRL 3
#define IMAP_LOG_PASS 5
 
/* IMAP command responses. Used in ImapCommand.state too */
#define IMAP_RES_NO       -2  
#define IMAP_RES_BAD      -1  
#define IMAP_RES_OK        0  
#define IMAP_RES_CONTINUE  1  
#define IMAP_RES_RESPOND   2  
#define IMAP_RES_NEW       3  
 
#define SEQ_LEN 16
 
typedef uint8_t ImapOpenFlags;         
#define IMAP_OPEN_NO_FLAGS          0  
#define IMAP_REOPEN_ALLOW     (1 << 0) 
#define IMAP_EXPUNGE_EXPECTED (1 << 1) 
#define IMAP_EXPUNGE_PENDING  (1 << 2) 
#define IMAP_NEWMAIL_PENDING  (1 << 3) 
#define IMAP_FLAGS_PENDING    (1 << 4) 
 
typedef uint8_t ImapCmdFlags;          
#define IMAP_CMD_NO_FLAGS          0   
#define IMAP_CMD_PASS        (1 << 0)  
#define IMAP_CMD_QUEUE       (1 << 1)  
#define IMAP_CMD_POLL        (1 << 2)  
#define IMAP_CMD_SINGLE      (1 << 3)  
 
enum ImapExecResult
{
  IMAP_EXEC_SUCCESS = 0, 
  IMAP_EXEC_ERROR,       
  IMAP_EXEC_FATAL,       
};
 
/* length of "DD-MMM-YYYY HH:MM:SS +ZZzz" (null-terminated) */
#define IMAP_DATELEN 27
 
enum ImapFlags
{
  IMAP_FATAL = 1, 
  IMAP_BYE,       
};
 
enum ImapState
{
  /* States */
  IMAP_DISCONNECTED = 0, 
  IMAP_CONNECTED,        
  IMAP_AUTHENTICATED,    
  IMAP_SELECTED,         
 
  /* and pseudo-states */
  IMAP_IDLE, 
};
 
typedef uint32_t ImapCapFlags;              
#define IMAP_CAP_NO_FLAGS                0  
#define IMAP_CAP_IMAP4            (1 <<  0) 
#define IMAP_CAP_IMAP4REV1        (1 <<  1) 
#define IMAP_CAP_STATUS           (1 <<  2) 
#define IMAP_CAP_ACL              (1 <<  3) 
#define IMAP_CAP_NAMESPACE        (1 <<  4) 
#define IMAP_CAP_AUTH_CRAM_MD5    (1 <<  5) 
#define IMAP_CAP_AUTH_GSSAPI      (1 <<  6) 
#define IMAP_CAP_AUTH_ANONYMOUS   (1 <<  7) 
#define IMAP_CAP_AUTH_OAUTHBEARER (1 <<  8) 
#define IMAP_CAP_AUTH_XOAUTH2     (1 <<  9) 
#define IMAP_CAP_STARTTLS         (1 << 10) 
#define IMAP_CAP_LOGINDISABLED    (1 << 11) 
#define IMAP_CAP_IDLE             (1 << 12) 
#define IMAP_CAP_SASL_IR          (1 << 13) 
#define IMAP_CAP_ENABLE           (1 << 14) 
#define IMAP_CAP_CONDSTORE        (1 << 15) 
#define IMAP_CAP_QRESYNC          (1 << 16) 
#define IMAP_CAP_LIST_EXTENDED    (1 << 17) 
#define IMAP_CAP_COMPRESS         (1 << 18) 
#define IMAP_CAP_X_GM_EXT_1       (1 << 19) 
#define IMAP_CAP_ID               (1 << 20) 
 
#define IMAP_CAP_ALL             ((1 << 21) - 1)
 
struct ImapList
{
  char *name;
  char delim;
  bool noselect;
  bool noinferiors;
};
 
struct ImapCommand
{
  char seq[SEQ_LEN + 1]; 
  int state;            
};
 
struct SeqsetIterator
{
  char *full_seqset;
  char *eostr;
  int in_range;
  int down;
  unsigned int range_cur;
  unsigned int range_end;
  char *substr_cur;
  char *substr_end;
};
 
/* -- private IMAP functions -- */
/* imap.c */
int imap_create_mailbox(struct ImapAccountData *adata, const char *mailbox);
int imap_rename_mailbox(struct ImapAccountData *adata, char *oldname, const char *newname);
int imap_open_connection(struct ImapAccountData *adata);
void imap_close_connection(struct ImapAccountData *adata);
int imap_read_literal(FILE *fp, struct ImapAccountData *adata, unsigned long bytes, struct Progress *progress);
void imap_expunge_mailbox(struct Mailbox *m, bool resort);
int imap_login(struct ImapAccountData *adata);
int imap_sync_message_for_copy(struct Mailbox *m, struct Email *e, struct Buffer *cmd, enum QuadOption *err_continue);
bool imap_has_flag(struct ListHead *flag_list, const char *flag);
int imap_adata_find(const char *path, struct ImapAccountData **adata, struct ImapMboxData **mdata);
 
/* auth.c */
int imap_authenticate(struct ImapAccountData *adata);
 
/* command.c */
int imap_cmd_start(struct ImapAccountData *adata, const char *cmdstr);
int imap_cmd_step(struct ImapAccountData *adata);
void imap_cmd_finish(struct ImapAccountData *adata);
bool imap_code(const char *s);
const char *imap_cmd_trailer(struct ImapAccountData *adata);
int imap_exec(struct ImapAccountData *adata, const char *cmdstr, ImapCmdFlags flags);
int imap_cmd_idle(struct ImapAccountData *adata);
 
/* message.c */
int imap_read_headers(struct Mailbox *m, unsigned int msn_begin, unsigned int msn_end, bool initial_download);
char *imap_set_flags(struct Mailbox *m, struct Email *e, char *s, bool *server_changes);
int imap_cache_del(struct Mailbox *m, struct Email *e);
int imap_cache_clean(struct Mailbox *m);
int imap_append_message(struct Mailbox *m, struct Message *msg);
 
bool imap_msg_open(struct Mailbox *m, struct Message *msg, struct Email *e);
int imap_msg_close(struct Mailbox *m, struct Message *msg);
int imap_msg_commit(struct Mailbox *m, struct Message *msg);
int imap_msg_save_hcache(struct Mailbox *m, struct Email *e);
 
/* util.c */
#ifdef USE_HCACHE
void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata);
void imap_hcache_close(struct ImapMboxData *mdata);
struct Email *imap_hcache_get(struct ImapMboxData *mdata, unsigned int uid);
int imap_hcache_put(struct ImapMboxData *mdata, struct Email *e);
int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid);
int imap_hcache_store_uid_seqset(struct ImapMboxData *mdata);
int imap_hcache_clear_uid_seqset(struct ImapMboxData *mdata);
char *imap_hcache_get_uid_seqset(struct ImapMboxData *mdata);
#endif
 
enum QuadOption imap_continue(const char *msg, const char *resp);
void imap_error(const char *where, const char *msg);
void imap_mdata_cache_reset(struct ImapMboxData *mdata);
char *imap_fix_path(char delim, const char *mailbox, char *path, size_t plen);
void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest);
int imap_get_literal_count(const char *buf, unsigned int *bytes);
char *imap_get_qualifier(char *buf);
char *imap_next_word(char *s);
void imap_qualify_path(char *buf, size_t buflen, struct ConnAccount *conn_account, char *path);
void imap_buf_qualify_path(struct Buffer *buf, struct ConnAccount *conn_account, char *path);
void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick);
void imap_unquote_string(char *s);
void imap_munge_mbox_name(bool unicode, char *dest, size_t dlen, const char *src);
void imap_unmunge_mbox_name(bool unicode, char *s);
struct SeqsetIterator *mutt_seqset_iterator_new(const char *seqset);
int mutt_seqset_iterator_next(struct SeqsetIterator *iter, unsigned int *next);
void mutt_seqset_iterator_free(struct SeqsetIterator **ptr);
bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2);
void imap_get_parent(const char *mbox, char delim, char *buf, size_t buflen);
bool  mutt_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2);
 
/* utf7.c */
void imap_utf_encode(bool unicode, char **s);
void imap_utf_decode(bool unicode, char **s);
void imap_allow_reopen(struct Mailbox *m);
void imap_disallow_reopen(struct Mailbox *m);
 
/* search.c */
void cmd_parse_search(struct ImapAccountData *adata, const char *s);
 
#endif /* MUTT_IMAP_PRIVATE_H */