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 - 2012, 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_STARTTLS,
  35   IMAP_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
  36                        (multi mode only) */
  37   IMAP_LOGIN,
  38   IMAP_SELECT,
  39   IMAP_FETCH,
  40   IMAP_LOGOUT,
  41   IMAP_LAST          /* never used */
  42 } imapstate;
  43
  44 /* imap_conn is used for struct connection-oriented data in the connectdata
  45    struct */
  46 struct imap_conn {
  47   struct pingpong pp;
  48   char *mailbox;     /* Message ID to fetch */
  49   imapstate state;   /* Always use imap.c:state() to change state! */
  50   int cmdid;         /* Next command ID */
  51   const char *idstr; /* String based response ID to wait for */
  52   bool ssldone;      /* Is connect() over SSL done? Only relevant in
  53                         multi mode */
  54 };
  55
  56 extern const struct Curl_handler Curl_handler_imap;
  57 extern const struct Curl_handler Curl_handler_imaps;
  58
  59 #endif /* HEADER_CURL_IMAP_H */