lib/imap.h

   1 #ifndef HEADER_CURL_IMAP_H
   2 #define HEADER_CURL_IMAP_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 2009 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include "pingpong.h"
  26
  27 /****************************************************************************
  28  * IMAP unique setup
  29  ***************************************************************************/
  30 typedef enum {
  31   IMAP_STOP,         /* do nothing state, stops the state machine */
  32   IMAP_SERVERGREET,  /* waiting for the initial greeting immediately after
  33                         a connect */
  34   IMAP_CAPABILITY,
  35   IMAP_STARTTLS,
  36   IMAP_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
  37                        (multi mode only) */
  38   IMAP_AUTHENTICATE_PLAIN,
  39   IMAP_AUTHENTICATE_LOGIN,
  40   IMAP_AUTHENTICATE_LOGIN_PASSWD,
  41   IMAP_AUTHENTICATE_CRAMMD5,
  42   IMAP_AUTHENTICATE_DIGESTMD5,
  43   IMAP_AUTHENTICATE_DIGESTMD5_RESP,
  44   IMAP_AUTHENTICATE_NTLM,
  45   IMAP_AUTHENTICATE_NTLM_TYPE2MSG,
  46   IMAP_AUTHENTICATE_GSSAPI,
  47   IMAP_AUTHENTICATE_GSSAPI_TOKEN,
  48   IMAP_AUTHENTICATE_GSSAPI_NO_DATA,
  49   IMAP_AUTHENTICATE_XOAUTH2,
  50   IMAP_AUTHENTICATE_CANCEL,
  51   IMAP_AUTHENTICATE_FINAL,
  52   IMAP_LOGIN,
  53   IMAP_LIST,
  54   IMAP_SELECT,
  55   IMAP_FETCH,
  56   IMAP_FETCH_FINAL,
  57   IMAP_APPEND,
  58   IMAP_APPEND_FINAL,
  59   IMAP_SEARCH,
  60   IMAP_LOGOUT,
  61   IMAP_LAST          /* never used */
  62 } imapstate;
  63
  64 /* This IMAP struct is used in the SessionHandle. All IMAP data that is
  65    connection-oriented must be in imap_conn to properly deal with the fact that
  66    perhaps the SessionHandle is changed between the times the connection is
  67    used. */
  68 struct IMAP {
  69   curl_pp_transfer transfer;
  70   char *mailbox;          /* Mailbox to select */
  71   char *uidvalidity;      /* UIDVALIDITY to check in select */
  72   char *uid;              /* Message UID to fetch */
  73   char *section;          /* Message SECTION to fetch */
  74   char *partial;          /* Message PARTIAL to fetch */
  75   char *query;            /* Query to search for */
  76   char *custom;           /* Custom request */
  77   char *custom_params;    /* Parameters for the custom request */
  78 };
  79
  80 /* imap_conn is used for struct connection-oriented data in the connectdata
  81    struct */
  82 struct imap_conn {
  83   struct pingpong pp;
  84   imapstate state;            /* Always use imap.c:state() to change state! */
  85   bool ssldone;               /* Is connect() over SSL done? */
  86   unsigned int authmechs;     /* Accepted authentication mechanisms */
  87   unsigned int preftype;      /* Preferred authentication type */
  88   unsigned int prefmech;      /* Preferred authentication mechanism */
  89   unsigned int authused;      /* Auth mechanism used for the connection */
  90   int cmdid;                  /* Last used command ID */
  91   char resptag[5];            /* Response tag to wait for */
  92   bool tls_supported;         /* StartTLS capability supported by server */
  93   bool login_disabled;        /* LOGIN command disabled by server */
  94   bool ir_supported;          /* Initial response supported by server */
  95   bool mutual_auth;           /* Mutual authentication enabled (GSSAPI only) */
  96   char *mailbox;              /* The last selected mailbox */
  97   char *mailbox_uidvalidity;  /* UIDVALIDITY parsed from select response */
  98 };
  99
 100 extern const struct Curl_handler Curl_handler_imap;
 101 extern const struct Curl_handler Curl_handler_imaps;
 102
 103 /* Authentication type flags */
 104 #define IMAP_TYPE_CLEARTEXT (1 << 0)
 105 #define IMAP_TYPE_SASL      (1 << 1)
 106
 107 /* Authentication type values */
 108 #define IMAP_TYPE_NONE      0
 109 #define IMAP_TYPE_ANY       ~0U
 110
 111 #endif /* HEADER_CURL_IMAP_H */