lib/pop3.h

   1 #ifndef __POP3_H
   2 #define __POP3_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 2009, 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_USER,
  33   POP3_PASS,
  34   POP3_STARTTLS,
  35   POP3_LIST,
  36   POP3_RETR,
  37   POP3_QUIT,
  38   POP3_LAST  /* never used */
  39 } pop3state;
  40
  41 /* pop3_conn is used for struct connection-oriented data in the connectdata
  42    struct */
  43 struct pop3_conn {
  44   struct pingpong pp;
  45   char *mailbox;     /* what to RETR */
  46   size_t eob;        /* number of bytes of the EOB (End Of Body) that has been
  47                         received thus far */
  48   pop3state state; /* always use pop3.c:state() to change state! */
  49 };
  50
  51 extern const struct Curl_handler Curl_handler_pop3;
  52 extern const struct Curl_handler Curl_handler_pop3s;
  53
  54 /*
  55  * This function scans the body after the end-of-body and writes everything
  56  * until the end is found.
  57  */
  58 CURLcode Curl_pop3_write(struct connectdata *conn,
  59                          char *str,
  60                          size_t nread);
  61
  62 #endif /* __POP3_H */