1 #ifndef HEADER_CURL_POP3_H
2 #define HEADER_CURL_POP3_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 2009 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
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.haxx.se/docs/copyright.html.
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.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
26 #include "curl_sasl.h"
28 /****************************************************************************
30 ***************************************************************************/
32 POP3_STOP, /* do nothing state, stops the state machine */
33 POP3_SERVERGREET, /* waiting for the initial greeting immediately after
37 POP3_UPGRADETLS, /* asynchronously upgrade the connection to SSL/TLS
45 POP3_LAST /* never used */
48 /* This POP3 struct is used in the Curl_easy. All POP3 data that is
49 connection-oriented must be in pop3_conn to properly deal with the fact that
50 perhaps the Curl_easy is changed between the times the connection is
53 curl_pp_transfer transfer;
54 char *id; /* Message ID */
55 char *custom; /* Custom Request */
58 /* pop3_conn is used for struct connection-oriented data in the connectdata
62 pop3state state; /* Always use pop3.c:state() to change state! */
63 bool ssldone; /* Is connect() over SSL done? */
64 size_t eob; /* Number of bytes of the EOB (End Of Body) that
65 have been received so far */
66 size_t strip; /* Number of bytes from the start to ignore as
68 struct SASL sasl; /* SASL-related storage */
69 unsigned int authtypes; /* Accepted authentication types */
70 unsigned int preftype; /* Preferred authentication type */
71 char *apoptimestamp; /* APOP timestamp from the server greeting */
72 bool tls_supported; /* StartTLS capability supported by server */
75 extern const struct Curl_handler Curl_handler_pop3;
76 extern const struct Curl_handler Curl_handler_pop3s;
78 /* Authentication type flags */
79 #define POP3_TYPE_CLEARTEXT (1 << 0)
80 #define POP3_TYPE_APOP (1 << 1)
81 #define POP3_TYPE_SASL (1 << 2)
83 /* Authentication type values */
84 #define POP3_TYPE_NONE 0
85 #define POP3_TYPE_ANY ~0U
87 /* This is the 5-bytes End-Of-Body marker for POP3 */
88 #define POP3_EOB "\x0d\x0a\x2e\x0d\x0a"
89 #define POP3_EOB_LEN 5
91 /* This function scans the body after the end-of-body and writes everything
92 * until the end is found */
93 CURLcode Curl_pop3_write(struct connectdata *conn, char *str, size_t nread);
95 #endif /* HEADER_CURL_POP3_H */