Return to pop3.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / lib

curl

    1: #ifndef HEADER_CURL_POP3_H
    2: #define HEADER_CURL_POP3_H
    3: /***************************************************************************
    4:  *                                  _   _ ____  _
    5:  *  Project                     ___| | | |  _ \| |
    6:  *                             / __| | | | |_) | |
    7:  *                            | (__| |_| |  _ <| |___
    8:  *                             \___|\___/|_| \_\_____|
    9:  *
   10:  * Copyright (C) 2009 - 2019, 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.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: #include "pingpong.h"
   26: #include "curl_sasl.h"
   27: 
   28: /****************************************************************************
   29:  * POP3 unique setup
   30:  ***************************************************************************/
   31: typedef enum {
   32:   POP3_STOP,         /* do nothing state, stops the state machine */
   33:   POP3_SERVERGREET,  /* waiting for the initial greeting immediately after
   34:                         a connect */
   35:   POP3_CAPA,
   36:   POP3_STARTTLS,
   37:   POP3_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
   38:                        (multi mode only) */
   39:   POP3_AUTH,
   40:   POP3_APOP,
   41:   POP3_USER,
   42:   POP3_PASS,
   43:   POP3_COMMAND,
   44:   POP3_QUIT,
   45:   POP3_LAST          /* never used */
   46: } pop3state;
   47: 
   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
   51:    used. */
   52: struct POP3 {
   53:   curl_pp_transfer transfer;
   54:   char *id;               /* Message ID */
   55:   char *custom;           /* Custom Request */
   56: };
   57: 
   58: /* pop3_conn is used for struct connection-oriented data in the connectdata
   59:    struct */
   60: struct pop3_conn {
   61:   struct pingpong pp;
   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
   67:                              non-body */
   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 */
   73: };
   74: 
   75: extern const struct Curl_handler Curl_handler_pop3;
   76: extern const struct Curl_handler Curl_handler_pop3s;
   77: 
   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)
   82: 
   83: /* Authentication type values */
   84: #define POP3_TYPE_NONE      0
   85: #define POP3_TYPE_ANY       ~0U
   86: 
   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
   90: 
   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);
   94: 
   95: #endif /* HEADER_CURL_POP3_H */