pop3: Added support for sasl plain text authentication
[platform/upstream/curl.git] / lib / 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 - 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 /****************************************************************************
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_AUTH,
34   POP3_AUTH_PLAIN,
35   POP3_AUTH_FINAL,
36   POP3_USER,
37   POP3_PASS,
38   POP3_COMMAND,
39   POP3_QUIT,
40   POP3_LAST          /* never used */
41 } pop3state;
42
43 /* pop3_conn is used for struct connection-oriented data in the connectdata
44    struct */
45 struct pop3_conn {
46   struct pingpong pp;
47   char *mailbox;     /* message id */
48   char *custom;      /* custom request */
49   size_t eob;        /* number of bytes of the EOB (End Of Body) that has been
50                         received thus far */
51   size_t strip;      /* number of bytes from the start to ignore as non-body */
52   unsigned int authmechs; /* Accepted authentication methods */
53   unsigned int authused;  /* Authentication method used for the connection */
54   pop3state state;   /* always use pop3.c:state() to change state! */
55 };
56
57 extern const struct Curl_handler Curl_handler_pop3;
58 extern const struct Curl_handler Curl_handler_pop3s;
59
60 /* This is the 5-bytes End-Of-Body marker for POP3 */
61 #define POP3_EOB "\x0d\x0a\x2e\x0d\x0a"
62 #define POP3_EOB_LEN 5
63
64 /* This function scans the body after the end-of-body and writes everything
65  * until the end is found */
66 CURLcode Curl_pop3_write(struct connectdata *conn, char *str, size_t nread);
67
68 #endif /* HEADER_CURL_POP3_H */