summaryrefslogtreecommitdiff
path: root/include/mailutils/sys/imap.h
blob: 3e90809e50d07c822b72591821f7d588d308fafd (plain)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* GNU Mailutils -- a suite of utilities for electronic mail
   Copyright (C) 2010, 2011 Free Software Foundation, Inc.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General
   Public License along with this library.  If not, see
   <http://www.gnu.org/licenses/>. */

#ifndef _MAILUTILS_SYS_IMAP_H
# define _MAILUTILS_SYS_IMAP_H

# include <mailutils/sys/folder.h>
# include <mailutils/sys/mailbox.h>
# include <mailutils/sys/registrar.h>
# include <mailutils/sys/auth.h>
# include <mailutils/imap.h>

# ifdef __cplusplus
extern "C" {
# endif

#define MU_IMAP_RESP  0x01
#define MU_IMAP_TRACE 0x02  
#define MU_IMAP_XSCRIPT_MASK(n) (1<<((n)+1))

enum mu_imap_client_state
  {
    MU_IMAP_NO_STATE,
    MU_IMAP_ERROR,
    MU_IMAP_CONNECT,
    MU_IMAP_GREETINGS,
    MU_IMAP_CONNECTED,
    MU_IMAP_CAPABILITY_RX,
    MU_IMAP_LOGIN_RX,
    MU_IMAP_LOGOUT_RX,
    MU_IMAP_ID_RX,
  };

enum mu_imap_response
  {
    MU_IMAP_OK,
    MU_IMAP_NO,
    MU_IMAP_BAD
  };
  
struct _mu_imap
  {
    int flags;

    /* Holds the tagged response to the last command */
    char *tagbuf;
    size_t tagsize;
    enum mu_imap_response resp_code;
    
    /* Untagged responses */
    mu_list_t untagged_resp;

    /* Error string (if any) */
    char *errstr;
    size_t errsize;
    
    /* Input line buffer */
    char *rdbuf;
    size_t rdsize;

    enum mu_imap_state state;
    enum mu_imap_state imap_state;

    /* Tag */
    size_t tag_len;  /* Length of the command tag */
    int *tag_buf;    /* Tag number (BCD) */
    char *tag_str;   /* String representation (tag_len + 1 bytes, asciiz) */
    
    mu_list_t capa;
    mu_stream_t carrier;
};

#define MU_IMAP_FSET(p,f) ((p)->flags |= (f))
#define MU_IMAP_FISSET(p,f) ((p)->flags & (f))  
#define MU_IMAP_FCLR(p,f) ((p)->flags &= ~(f))

int _mu_imap_init (mu_imap_t imap);
int _mu_imap_trace_enable (mu_imap_t imap);
int _mu_imap_trace_disable (mu_imap_t imap);
int _mu_imap_xscript_level (mu_imap_t imap, int xlev);

/* If status indicates an error, return.
  */
#define MU_IMAP_CHECK_ERROR(imap, status)	\
  do						\
    {						\
      if (status != 0)				\
	{					\
          imap->state = MU_IMAP_ERROR;		\
          return status;			\
	}					\
    }						\
  while (0)

/* Check if status indicates an error.
   If the error is recoverable just return the status.
   Otherwise, set the error state and return the status
 */
#define MU_IMAP_CHECK_EAGAIN(imap, status)	\
  do						\
    {						\
      switch (status)				\
	{					\
        case 0:                                 \
	  break;				\
        case EAGAIN:                            \
        case EINPROGRESS:                       \
        case EINTR:                             \
        case MU_ERR_REPLY:                      \
        case MU_ERR_BADREPLY:                   \
	  return status;                        \
        default:                                \
          imap->state = MU_IMAP_ERROR;		\
	  return status;			\
	}					\
    }						\
  while (0)

int _mu_imap_seterrstr (mu_imap_t imap, const char *str, size_t len);
void _mu_imap_clrerrstr (mu_imap_t imap);

int _mu_imap_tag_next (mu_imap_t imap);
int _mu_imap_tag_clr (mu_imap_t imap);

int _mu_imap_response (mu_imap_t imap);
  
# ifdef __cplusplus
}
# endif

#endif /* _MAILUTILS_SYS_IMAP_H */

Return to:

Send suggestions and report system problems to the System administrator.