Return to imap.h CVS log

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

Annotation of embedaddon/curl/lib/imap.h, revision 1.1

1.1     ! misho       1: #ifndef HEADER_CURL_IMAP_H
        !             2: #define HEADER_CURL_IMAP_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:  * IMAP unique setup
        !            30:  ***************************************************************************/
        !            31: typedef enum {
        !            32:   IMAP_STOP,         /* do nothing state, stops the state machine */
        !            33:   IMAP_SERVERGREET,  /* waiting for the initial greeting immediately after
        !            34:                         a connect */
        !            35:   IMAP_CAPABILITY,
        !            36:   IMAP_STARTTLS,
        !            37:   IMAP_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
        !            38:                        (multi mode only) */
        !            39:   IMAP_AUTHENTICATE,
        !            40:   IMAP_LOGIN,
        !            41:   IMAP_LIST,
        !            42:   IMAP_SELECT,
        !            43:   IMAP_FETCH,
        !            44:   IMAP_FETCH_FINAL,
        !            45:   IMAP_APPEND,
        !            46:   IMAP_APPEND_FINAL,
        !            47:   IMAP_SEARCH,
        !            48:   IMAP_LOGOUT,
        !            49:   IMAP_LAST          /* never used */
        !            50: } imapstate;
        !            51: 
        !            52: /* This IMAP struct is used in the Curl_easy. All IMAP data that is
        !            53:    connection-oriented must be in imap_conn to properly deal with the fact that
        !            54:    perhaps the Curl_easy is changed between the times the connection is
        !            55:    used. */
        !            56: struct IMAP {
        !            57:   curl_pp_transfer transfer;
        !            58:   char *mailbox;          /* Mailbox to select */
        !            59:   char *uidvalidity;      /* UIDVALIDITY to check in select */
        !            60:   char *uid;              /* Message UID to fetch */
        !            61:   char *mindex;           /* Index in mail box of mail to fetch */
        !            62:   char *section;          /* Message SECTION to fetch */
        !            63:   char *partial;          /* Message PARTIAL to fetch */
        !            64:   char *query;            /* Query to search for */
        !            65:   char *custom;           /* Custom request */
        !            66:   char *custom_params;    /* Parameters for the custom request */
        !            67: };
        !            68: 
        !            69: /* imap_conn is used for struct connection-oriented data in the connectdata
        !            70:    struct */
        !            71: struct imap_conn {
        !            72:   struct pingpong pp;
        !            73:   imapstate state;            /* Always use imap.c:state() to change state! */
        !            74:   bool ssldone;               /* Is connect() over SSL done? */
        !            75:   bool preauth;               /* Is this connection PREAUTH? */
        !            76:   struct SASL sasl;           /* SASL-related parameters */
        !            77:   unsigned int preftype;      /* Preferred authentication type */
        !            78:   int cmdid;                  /* Last used command ID */
        !            79:   char resptag[5];            /* Response tag to wait for */
        !            80:   bool tls_supported;         /* StartTLS capability supported by server */
        !            81:   bool login_disabled;        /* LOGIN command disabled by server */
        !            82:   bool ir_supported;          /* Initial response supported by server */
        !            83:   char *mailbox;              /* The last selected mailbox */
        !            84:   char *mailbox_uidvalidity;  /* UIDVALIDITY parsed from select response */
        !            85: };
        !            86: 
        !            87: extern const struct Curl_handler Curl_handler_imap;
        !            88: extern const struct Curl_handler Curl_handler_imaps;
        !            89: 
        !            90: /* Authentication type flags */
        !            91: #define IMAP_TYPE_CLEARTEXT (1 << 0)
        !            92: #define IMAP_TYPE_SASL      (1 << 1)
        !            93: 
        !            94: /* Authentication type values */
        !            95: #define IMAP_TYPE_NONE      0
        !            96: #define IMAP_TYPE_ANY       ~0U
        !            97: 
        !            98: #endif /* HEADER_CURL_IMAP_H */