citadel/modules/imap/serv_imap.h

   1 /* $Id$
   2  */
   3
   4
   5 #define GLOBAL_UIDVALIDITY_VALUE        1L
   6
   7
   8 void imap_cleanup_function(void);
   9 void imap_greeting(void);
  10 void imap_command_loop(void);
  11 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok);
  12 void imap_free_transmitted_message(void);
  13 int imap_do_expunge(void);
  14 void imap_rescan_msgids(void);
  15
  16
  17
  18 typedef struct __citimap {
  19         int authstate;
  20         char authseq[SIZ];
  21         int selected;                   /* set to 1 if in the SELECTED state */
  22         int readonly;                   /* mailbox is open read only */
  23         int num_msgs;                   /* Number of messages being mapped */
  24         int num_alloc;                  /* Number of messages for which we've allocated space */
  25         time_t last_mtime;              /* For checking whether the room was modified... */
  26         long *msgids;
  27         unsigned int *flags;
  28         StrBuf *TransmittedMessage;     /* for APPEND command... */
  29
  30         citimap_command Cmd;            /* our current commandline */
  31
  32         /* Cache most recent RFC822 FETCH because client might load in pieces */
  33         StrBuf *cached_rfc822;
  34         long cached_rfc822_msgnum;
  35         char cached_rfc822_withbody;    /* 1 = body cached; 0 = only headers cached */
  36
  37         /* Cache most recent BODY FETCH because client might load in pieces */
  38         char *cached_body;
  39         size_t cached_body_len;
  40         char cached_bodypart[SIZ];
  41         long cached_bodymsgnum;
  42         char cached_body_withbody;      /* 1 = body cached; 0 = only headers cached */
  43 } citimap;
  44
  45 /*
  46  * values of 'authstate'
  47  */
  48 enum {
  49         imap_as_normal,
  50         imap_as_expecting_username,
  51         imap_as_expecting_password,
  52         imap_as_expecting_plainauth,
  53         imap_as_expecting_multilineusername,
  54         imap_as_expecting_multilinepassword
  55 };
  56
  57 /* Flags for the above struct.  Note that some of these are for internal use,
  58  * and are not to be reported to IMAP clients.
  59  */
  60 #define IMAP_ANSWERED           1       /* reportable and setable */
  61 #define IMAP_FLAGGED            2       /* reportable and setable */
  62 #define IMAP_DELETED            4       /* reportable and setable */
  63 #define IMAP_DRAFT              8       /* reportable and setable */
  64 #define IMAP_SEEN               16      /* reportable and setable */
  65
  66 #define IMAP_MASK_SETABLE       0x1f
  67 #define IMAP_MASK_SYSTEM        0xe0
  68
  69 #define IMAP_SELECTED           32      /* neither reportable nor setable */
  70 #define IMAP_RECENT             64      /* reportable but not setable */
  71
  72
  73 #define IMAP ((citimap *)CC->session_specific_data)
  74
  75 /*
  76  * When loading arrays of message ID's into memory, increase the buffer to
  77  * hold this many additional messages instead of calling realloc() each time.
  78  */
  79 #define REALLOC_INCREMENT 100