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  
 
#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

enum ImapOpenFlag
{
  IMAP_OPEN_NONE        =       0,  
  IMAP_REOPEN_ALLOW     = 1U << 0,  
  IMAP_EXPUNGE_EXPECTED = 1U << 1,  
  IMAP_EXPUNGE_PENDING  = 1U << 2,  
  IMAP_NEWMAIL_PENDING  = 1U << 3,  
  IMAP_FLAGS_PENDING    = 1U << 4,  
  IMAP_SYNC_IN_PROGRESS = 1U << 5,  
};
typedef uint8_t ImapOpenFlags;

enum ImapCmdFlag
{
  IMAP_CMD_NONE   =       0,  
  IMAP_CMD_PASS   = 1U << 0,  
  IMAP_CMD_QUEUE  = 1U << 1,  
  IMAP_CMD_POLL   = 1U << 2,  
  IMAP_CMD_SINGLE = 1U << 3,  
};
typedef uint8_t ImapCmdFlags;

enum ImapExecResult
{
  IMAP_EXEC_SUCCESS = 0, 
  IMAP_EXEC_ERROR,       
  IMAP_EXEC_FATAL,       
};

#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, 
};

enum ImapCapFlag
{
  IMAP_CAP_NONE             =        0,  
  IMAP_CAP_IMAP4            = 1U <<  0,  
  IMAP_CAP_IMAP4REV1        = 1U <<  1,  
  IMAP_CAP_STATUS           = 1U <<  2,  
  IMAP_CAP_ACL              = 1U <<  3,  
  IMAP_CAP_NAMESPACE        = 1U <<  4,  
  IMAP_CAP_AUTH_CRAM_MD5    = 1U <<  5,  
  IMAP_CAP_AUTH_GSSAPI      = 1U <<  6,  
  IMAP_CAP_AUTH_ANONYMOUS   = 1U <<  7,  
  IMAP_CAP_AUTH_OAUTHBEARER = 1U <<  8,  
  IMAP_CAP_AUTH_XOAUTH2     = 1U <<  9,  
  IMAP_CAP_STARTTLS         = 1U << 10,  
  IMAP_CAP_LOGINDISABLED    = 1U << 11,  
  IMAP_CAP_IDLE             = 1U << 12,  
  IMAP_CAP_SASL_IR          = 1U << 13,  
  IMAP_CAP_ENABLE           = 1U << 14,  
  IMAP_CAP_CONDSTORE        = 1U << 15,  
  IMAP_CAP_QRESYNC          = 1U << 16,  
  IMAP_CAP_LIST_EXTENDED    = 1U << 17,  
  IMAP_CAP_COMPRESS         = 1U << 18,  
  IMAP_CAP_X_GM_EXT_1       = 1U << 19,  
  IMAP_CAP_ID               = 1U << 20,  
};
typedef uint32_t ImapCapFlags;
 
#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);
int imap_reopen_mailbox(struct ImapAccountData *adata);
 
/* 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, bool create);
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(const char *mailbox, char *path, size_t plen);
char *imap_fix_path_with_delim(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(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 */