lib/curl_pop3.h

   1 #ifndef HEADER_CURL_POP3_H
   2 #define HEADER_CURL_POP3_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 /****************************************************************************
  26  * POP3 unique setup
  27  ***************************************************************************/
  28 typedef enum {
  29   POP3_STOP,         /* do nothing state, stops the state machine */
  30   POP3_SERVERGREET,  /* waiting for the initial greeting immediately after
  31                         a connect */
  32   POP3_STARTTLS,
  33   POP3_CAPA,
  34   POP3_AUTH_PLAIN,
  35   POP3_AUTH_LOGIN,
  36   POP3_AUTH_LOGIN_PASSWD,
  37   POP3_AUTH_CRAMMD5,
  38   POP3_AUTH_DIGESTMD5,
  39   POP3_AUTH_DIGESTMD5_RESP,
  40   POP3_AUTH_NTLM,
  41   POP3_AUTH_NTLM_TYPE2MSG,
  42   POP3_AUTH,
  43   POP3_APOP,
  44   POP3_USER,
  45   POP3_PASS,
  46   POP3_COMMAND,
  47   POP3_QUIT,
  48   POP3_LAST          /* never used */
  49 } pop3state;
  50
  51 /* pop3_conn is used for struct connection-oriented data in the connectdata
  52    struct */
  53 struct pop3_conn {
  54   struct pingpong pp;
  55   char *mailbox;          /* Message ID */
  56   char *custom;           /* Custom Request */
  57   size_t eob;             /* Number of bytes of the EOB (End Of Body) that
  58                              have been received so far */
  59   size_t strip;           /* Number of bytes from the start to ignore as
  60                              non-body */
  61   unsigned int authtypes; /* Supported authentication types */
  62   unsigned int authmechs; /* Accepted SASL authentication mechanisms */
  63   unsigned int authused;  /* SASL auth mechanism used for the connection */
  64   char *apoptimestamp;    /* APOP timestamp from the server greeting */
  65   pop3state state;        /* Always use curl_pop3.c:state() to change state */
  66 };
  67
  68 extern const struct Curl_handler Curl_handler_pop3;
  69 extern const struct Curl_handler Curl_handler_pop3s;
  70
  71 /* Authentication type flags */
  72 #define POP3_TYPE_CLEARTEXT 0x0001
  73 #define POP3_TYPE_APOP      0x0002
  74 #define POP3_TYPE_SASL      0x0004
  75
  76 /* This is the 5-bytes End-Of-Body marker for POP3 */
  77 #define POP3_EOB "\x0d\x0a\x2e\x0d\x0a"
  78 #define POP3_EOB_LEN 5
  79
  80 /* This function scans the body after the end-of-body and writes everything
  81  * until the end is found */
  82 CURLcode Curl_pop3_write(struct connectdata *conn, char *str, size_t nread);
  83
  84 #endif /* HEADER_CURL_POP3_H */