imap/imap_private.h

   1 /*
   2  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   3  * Copyright (C) 1999-2001 Brendan Cully <brendan@kublai.com>
   4  *
   5  *     This program is free software; you can redistribute it and/or modify
   6  *     it under the terms of the GNU General Public License as published by
   7  *     the Free Software Foundation; either version 2 of the License, or
   8  *     (at your option) any later version.
   9  *
  10  *     This program is distributed in the hope that it will be useful,
  11  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *     GNU General Public License for more details.
  14  *
  15  *     You should have received a copy of the GNU General Public License
  16  *     along with this program; if not, write to the Free Software
  17  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  18  */
  19
  20 #ifndef _IMAP_PRIVATE_H
  21 #define _IMAP_PRIVATE_H 1
  22
  23 #include <inttypes.h>
  24
  25 #include "imap.h"
  26 #include "mutt_socket.h"
  27
  28 /* -- symbols -- */
  29 #define IMAP_PORT 143
  30 #define IMAP_SSL_PORT 993
  31
  32 /* logging levels */
  33 #define IMAP_LOG_CMD  2
  34 #define IMAP_LOG_LTRL 4
  35 #define IMAP_LOG_PASS 5
  36
  37 /* IMAP command responses. Used in IMAP_COMMAND.state too */
  38 /* <tag> OK ... */
  39 #define IMAP_CMD_OK       (0)
  40 /* <tag> BAD ... */
  41 #define IMAP_CMD_BAD      (-1)
  42 /* <tag> NO ... */
  43 #define IMAP_CMD_NO       (-2)
  44 /* * ... */
  45 #define IMAP_CMD_CONTINUE (1)
  46 /* + */
  47 #define IMAP_CMD_RESPOND  (2)
  48
  49 /* number of entries in the hash table */
  50 #define IMAP_CACHE_LEN 10
  51
  52 #define SEQLEN 5
  53
  54 #define IMAP_REOPEN_ALLOW     (1<<0)
  55 #define IMAP_EXPUNGE_EXPECTED (1<<1)
  56 #define IMAP_EXPUNGE_PENDING  (1<<2)
  57 #define IMAP_NEWMAIL_PENDING  (1<<3)
  58 #define IMAP_FLAGS_PENDING    (1<<4)
  59
  60 /* imap_exec flags (see imap_exec) */
  61 #define IMAP_CMD_FAIL_OK (1<<0)
  62 #define IMAP_CMD_PASS    (1<<1)
  63
  64 enum
  65 {
  66   IMAP_FATAL = 1,
  67   IMAP_BYE,
  68   IMAP_REOPENED
  69 };
  70
  71 enum
  72 {
  73   /* States */
  74   IMAP_DISCONNECTED = 0,
  75   IMAP_CONNECTED,
  76   IMAP_AUTHENTICATED,
  77   IMAP_SELECTED
  78 };
  79
  80 enum
  81 {
  82   /* Namespace types */
  83   IMAP_NS_PERSONAL = 0,
  84   IMAP_NS_OTHER,
  85   IMAP_NS_SHARED
  86 };
  87
  88 /* ACL Rights */
  89 enum
  90 {
  91   IMAP_ACL_LOOKUP = 0,
  92   IMAP_ACL_READ,
  93   IMAP_ACL_SEEN,
  94   IMAP_ACL_WRITE,
  95   IMAP_ACL_INSERT,
  96   IMAP_ACL_POST,
  97   IMAP_ACL_CREATE,
  98   IMAP_ACL_DELETE,
  99   IMAP_ACL_ADMIN,
 100
 101   RIGHTSMAX
 102 };
 103
 104 /* Capabilities we are interested in */
 105 enum
 106 {
 107   IMAP4 = 0,
 108   IMAP4REV1,
 109   STATUS,
 110   ACL,                          /* RFC 2086: IMAP4 ACL extension */
 111   NAMESPACE,                    /* RFC 2342: IMAP4 Namespace */
 112   ACRAM_MD5,                    /* RFC 2195: CRAM-MD5 authentication */
 113   AGSSAPI,                      /* RFC 1731: GSSAPI authentication */
 114   AUTH_ANON,                    /* AUTH=ANONYMOUS */
 115   STARTTLS,                     /* RFC 2595: STARTTLS */
 116   LOGINDISABLED,                /*           LOGINDISABLED */
 117
 118   CAPMAX
 119 };
 120
 121 /* imap_conn_find flags */
 122 #define M_IMAP_CONN_NONEW    (1<<0)
 123 #define M_IMAP_CONN_NOSELECT (1<<1)
 124
 125 /* -- data structures -- */
 126 typedef struct
 127 {
 128   unsigned int uid;
 129   char* path;
 130 } IMAP_CACHE;
 131
 132 typedef struct
 133 {
 134   int type;
 135   int listable;
 136   char *prefix;
 137   char delim;
 138   int home_namespace;
 139   /* We get these when we check if namespace exists - cache them */
 140   int noselect;
 141   int noinferiors;
 142 } IMAP_NAMESPACE_INFO;
 143
 144 /* IMAP command structure */
 145 typedef struct
 146 {
 147   char seq[SEQLEN+1];
 148   char* buf;
 149   unsigned int blen;
 150   int state;
 151 } IMAP_COMMAND;
 152
 153 typedef struct
 154 {
 155   /* This data is specific to a CONNECTION to an IMAP server */
 156   CONNECTION *conn;
 157   unsigned char state;
 158   unsigned char status;
 159   /* let me explain capstr: SASL needs the capability string (not bits).
 160    * we have 3 options:
 161    *   1. rerun CAPABILITY inside SASL function.
 162    *   2. build appropriate CAPABILITY string by reverse-engineering from bits.
 163    *   3. keep a copy until after authentication.
 164    * I've chosen (3) for now. (2) might not be too bad, but it involves
 165    * tracking all possible capabilities. bah. (1) I don't like because
 166    * it's just no fun to get the same information twice */
 167   char* capstr;
 168   unsigned char capabilities[(CAPMAX + 7)/8];
 169   unsigned int seqno;
 170   time_t lastread; /* last time we read a command for the server */
 171   /* who knows, one day we may run multiple commands in parallel */
 172   IMAP_COMMAND cmd;
 173
 174   /* The following data is all specific to the currently SELECTED mbox */
 175   char delim;
 176   CONTEXT *ctx;
 177   char *mailbox;
 178   unsigned short check_status;
 179   unsigned char reopen;
 180   unsigned char rights[(RIGHTSMAX + 7)/8];
 181   unsigned int newMailCount;
 182   IMAP_CACHE cache[IMAP_CACHE_LEN];
 183   int noclose : 1;
 184 #ifdef USE_HCACHE
 185   uint64_t uid_validity;
 186 #endif
 187
 188   /* all folder flags - system flags AND keywords */
 189   LIST *flags;
 190 } IMAP_DATA;
 191 /* I wish that were called IMAP_CONTEXT :( */
 192
 193 /* -- macros -- */
 194 #define CTX_DATA ((IMAP_DATA *) ctx->data)
 195
 196 /* -- private IMAP functions -- */
 197 /* imap.c */
 198 int imap_create_mailbox (IMAP_DATA* idata, char* mailbox);
 199 int imap_rename_mailbox (IMAP_DATA* idata, IMAP_MBOX* mx, const char* newname);
 200 int imap_make_msg_set (IMAP_DATA* idata, BUFFER* buf, int flag, int changed);
 201 int imap_open_connection (IMAP_DATA* idata);
 202 IMAP_DATA* imap_conn_find (const ACCOUNT* account, int flags);
 203 int imap_parse_list_response(IMAP_DATA* idata, char** name, int* noselect,
 204   int* noinferiors, char* delim);
 205 int imap_read_literal (FILE* fp, IMAP_DATA* idata, long bytes);
 206 void imap_expunge_mailbox (IMAP_DATA* idata);
 207 int imap_reconnect (CONTEXT* ctx);
 208 void imap_logout (IMAP_DATA* idata);
 209
 210 /* auth.c */
 211 int imap_authenticate (IMAP_DATA* idata);
 212
 213 /* command.c */
 214 int imap_cmd_start (IMAP_DATA* idata, const char* cmd);
 215 int imap_cmd_step (IMAP_DATA* idata);
 216 void imap_cmd_finish (IMAP_DATA* idata);
 217 int imap_code (const char* s);
 218 int imap_exec (IMAP_DATA* idata, const char* cmd, int flags);
 219
 220 /* message.c */
 221 void imap_add_keywords (char* s, HEADER* keywords, LIST* mailbox_flags, size_t slen);
 222 void imap_free_header_data (void** data);
 223 int imap_read_headers (IMAP_DATA* idata, int msgbegin, int msgend);
 224 char* imap_set_flags (IMAP_DATA* idata, HEADER* h, char* s);
 225
 226 /* util.c */
 227 int imap_continue (const char* msg, const char* resp);
 228 void imap_error (const char* where, const char* msg);
 229 IMAP_DATA* imap_new_idata (void);
 230 void imap_free_idata (IMAP_DATA** idata);
 231 char* imap_fix_path (IMAP_DATA* idata, char* mailbox, char* path,
 232   size_t plen);
 233 int imap_get_literal_count (const char* buf, long* bytes);
 234 char* imap_get_qualifier (char* buf);
 235 char* imap_next_word (char* s);
 236 time_t imap_parse_date (char* s);
 237 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX *mx, char* path);
 238 void imap_quote_string (char* dest, size_t slen, const char* src);
 239 void imap_unquote_string (char* s);
 240 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src);
 241 void imap_unmunge_mbox_name (char *s);
 242 int imap_wordcasecmp(const char *a, const char *b);
 243
 244 /* utf7.c */
 245 void imap_utf7_encode (char **s);
 246 void imap_utf7_decode (char **s);
 247
 248 #endif