aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/curl/lib/pop3.h
blob: 6c7ae467880e6cf0891d4f3f8a472cffc5565495 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#ifndef HEADER_CURL_POP3_H 
#define HEADER_CURL_POP3_H 
/*************************************************************************** 
 *                                  _   _ ____  _ 
 *  Project                     ___| | | |  _ \| | 
 *                             / __| | | | |_) | | 
 *                            | (__| |_| |  _ <| |___ 
 *                             \___|\___/|_| \_\_____| 
 * 
 * Copyright (C) 2009 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
 * 
 * This software is licensed as described in the file COPYING, which 
 * you should have received as part of this distribution. The terms 
 * are also available at https://curl.se/docs/copyright.html.
 * 
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 
 * copies of the Software, and permit persons to whom the Software is 
 * furnished to do so, under the terms of the COPYING file. 
 * 
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 
 * KIND, either express or implied. 
 * 
 ***************************************************************************/ 
 
#include "pingpong.h" 
#include "curl_sasl.h"
 
/**************************************************************************** 
 * POP3 unique setup 
 ***************************************************************************/ 
typedef enum { 
  POP3_STOP,         /* do nothing state, stops the state machine */ 
  POP3_SERVERGREET,  /* waiting for the initial greeting immediately after 
                        a connect */ 
  POP3_CAPA, 
  POP3_STARTTLS, 
  POP3_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS 
                       (multi mode only) */ 
  POP3_AUTH,
  POP3_APOP, 
  POP3_USER, 
  POP3_PASS, 
  POP3_COMMAND, 
  POP3_QUIT, 
  POP3_LAST          /* never used */ 
} pop3state; 
 
/* This POP3 struct is used in the Curl_easy. All POP3 data that is
   connection-oriented must be in pop3_conn to properly deal with the fact that 
   perhaps the Curl_easy is changed between the times the connection is
   used. */ 
struct POP3 { 
  curl_pp_transfer transfer; 
  char *id;               /* Message ID */ 
  char *custom;           /* Custom Request */ 
}; 
 
/* pop3_conn is used for struct connection-oriented data in the connectdata 
   struct */ 
struct pop3_conn { 
  struct pingpong pp; 
  pop3state state;        /* Always use pop3.c:state() to change state! */ 
  bool ssldone;           /* Is connect() over SSL done? */ 
  size_t eob;             /* Number of bytes of the EOB (End Of Body) that 
                             have been received so far */ 
  size_t strip;           /* Number of bytes from the start to ignore as 
                             non-body */ 
  struct SASL sasl;       /* SASL-related storage */
  unsigned int authtypes; /* Accepted authentication types */ 
  unsigned int preftype;  /* Preferred authentication type */ 
  char *apoptimestamp;    /* APOP timestamp from the server greeting */ 
  bool tls_supported;     /* StartTLS capability supported by server */ 
}; 
 
extern const struct Curl_handler Curl_handler_pop3; 
extern const struct Curl_handler Curl_handler_pop3s; 
 
/* Authentication type flags */ 
#define POP3_TYPE_CLEARTEXT (1 << 0) 
#define POP3_TYPE_APOP      (1 << 1) 
#define POP3_TYPE_SASL      (1 << 2) 
 
/* Authentication type values */ 
#define POP3_TYPE_NONE      0 
#define POP3_TYPE_ANY       ~0U
 
/* This is the 5-bytes End-Of-Body marker for POP3 */ 
#define POP3_EOB "\x0d\x0a\x2e\x0d\x0a" 
#define POP3_EOB_LEN 5 
 
/* This function scans the body after the end-of-body and writes everything 
 * until the end is found */ 
CURLcode Curl_pop3_write(struct connectdata *conn, char *str, size_t nread); 
 
#endif /* HEADER_CURL_POP3_H */