imap.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. #ifndef HEADER_CURL_IMAP_H
  2. #define HEADER_CURL_IMAP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 2009 - 2022, 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 https://curl.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. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #include "pingpong.h"
  27. #include "curl_sasl.h"
  28. /****************************************************************************
  29. * IMAP unique setup
  30. ***************************************************************************/
  31. typedef enum {
  32. IMAP_STOP, /* do nothing state, stops the state machine */
  33. IMAP_SERVERGREET, /* waiting for the initial greeting immediately after
  34. a connect */
  35. IMAP_CAPABILITY,
  36. IMAP_STARTTLS,
  37. IMAP_UPGRADETLS, /* asynchronously upgrade the connection to SSL/TLS
  38. (multi mode only) */
  39. IMAP_AUTHENTICATE,
  40. IMAP_LOGIN,
  41. IMAP_LIST,
  42. IMAP_SELECT,
  43. IMAP_FETCH,
  44. IMAP_FETCH_FINAL,
  45. IMAP_APPEND,
  46. IMAP_APPEND_FINAL,
  47. IMAP_SEARCH,
  48. IMAP_LOGOUT,
  49. IMAP_LAST /* never used */
  50. } imapstate;
  51. /* This IMAP struct is used in the Curl_easy. All IMAP data that is
  52. connection-oriented must be in imap_conn to properly deal with the fact that
  53. perhaps the Curl_easy is changed between the times the connection is
  54. used. */
  55. struct IMAP {
  56. curl_pp_transfer transfer;
  57. char *mailbox; /* Mailbox to select */
  58. char *uidvalidity; /* UIDVALIDITY to check in select */
  59. char *uid; /* Message UID to fetch */
  60. char *mindex; /* Index in mail box of mail to fetch */
  61. char *section; /* Message SECTION to fetch */
  62. char *partial; /* Message PARTIAL to fetch */
  63. char *query; /* Query to search for */
  64. char *custom; /* Custom request */
  65. char *custom_params; /* Parameters for the custom request */
  66. };
  67. /* imap_conn is used for struct connection-oriented data in the connectdata
  68. struct */
  69. struct imap_conn {
  70. struct pingpong pp;
  71. imapstate state; /* Always use imap.c:state() to change state! */
  72. bool ssldone; /* Is connect() over SSL done? */
  73. bool preauth; /* Is this connection PREAUTH? */
  74. struct SASL sasl; /* SASL-related parameters */
  75. unsigned int preftype; /* Preferred authentication type */
  76. unsigned int cmdid; /* Last used command ID */
  77. char resptag[5]; /* Response tag to wait for */
  78. bool tls_supported; /* StartTLS capability supported by server */
  79. bool login_disabled; /* LOGIN command disabled by server */
  80. bool ir_supported; /* Initial response supported by server */
  81. char *mailbox; /* The last selected mailbox */
  82. char *mailbox_uidvalidity; /* UIDVALIDITY parsed from select response */
  83. struct dynbuf dyn; /* for the IMAP commands */
  84. };
  85. extern const struct Curl_handler Curl_handler_imap;
  86. extern const struct Curl_handler Curl_handler_imaps;
  87. /* Authentication type flags */
  88. #define IMAP_TYPE_CLEARTEXT (1 << 0)
  89. #define IMAP_TYPE_SASL (1 << 1)
  90. /* Authentication type values */
  91. #define IMAP_TYPE_NONE 0
  92. #define IMAP_TYPE_ANY ~0U
  93. #endif /* HEADER_CURL_IMAP_H */