1#ifndef HEADER_CURL_IMAP_H 2#define HEADER_CURL_IMAP_H 3/*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 2009 - 2013, 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 ***************************************************************************/ 30typedef 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_XOAUTH2, 47 IMAP_AUTHENTICATE_CANCEL, 48 IMAP_AUTHENTICATE_FINAL, 49 IMAP_LOGIN, 50 IMAP_LIST, 51 IMAP_SELECT, 52 IMAP_FETCH, 53 IMAP_FETCH_FINAL, 54 IMAP_APPEND, 55 IMAP_APPEND_FINAL, 56 IMAP_LOGOUT, 57 IMAP_LAST /* never used */ 58} imapstate; 59 60/* This IMAP struct is used in the SessionHandle. All IMAP data that is 61 connection-oriented must be in imap_conn to properly deal with the fact that 62 perhaps the SessionHandle is changed between the times the connection is 63 used. */ 64struct IMAP { 65 curl_pp_transfer transfer; 66 char *mailbox; /* Mailbox to select */ 67 char *uidvalidity; /* UIDVALIDITY to check in select */ 68 char *uid; /* Message UID to fetch */ 69 char *section; /* Message SECTION to fetch */ 70 char *custom; /* Custom request */ 71 char *custom_params; /* Parameters for the custom request */ 72}; 73 74/* imap_conn is used for struct connection-oriented data in the connectdata 75 struct */ 76struct imap_conn { 77 struct pingpong pp; 78 imapstate state; /* Always use imap.c:state() to change state! */ 79 bool ssldone; /* Is connect() over SSL done? */ 80 unsigned int authmechs; /* Accepted authentication mechanisms */ 81 unsigned int preftype; /* Preferred authentication type */ 82 unsigned int prefmech; /* Preferred authentication mechanism */ 83 unsigned int authused; /* Auth mechanism used for the connection */ 84 int cmdid; /* Last used command ID */ 85 char resptag[5]; /* Response tag to wait for */ 86 bool tls_supported; /* StartTLS capability supported by server */ 87 bool login_disabled; /* LOGIN command disabled by server */ 88 bool ir_supported; /* Initial response supported by server */ 89 char *mailbox; /* The last selected mailbox */ 90 char *mailbox_uidvalidity; /* UIDVALIDITY parsed from select response */ 91}; 92 93extern const struct Curl_handler Curl_handler_imap; 94extern const struct Curl_handler Curl_handler_imaps; 95 96/* Authentication type flags */ 97#define IMAP_TYPE_CLEARTEXT (1 << 0) 98#define IMAP_TYPE_SASL (1 << 1) 99 100/* Authentication type values */ 101#define IMAP_TYPE_NONE 0 102#define IMAP_TYPE_ANY ~0U 103 104#endif /* HEADER_CURL_IMAP_H */ 105