Initial git import
[sxemacs] / lib-src / pop.h
1 /* pop.h: Header file for the "pop.c" client POP3 protocol.
2    Copyright (C) 1991, 1993, 2001, 2002, 2003, 2004,
3                  2005, 2006, 2007  Free Software Foundation, Inc.
4    Written by Jonathan Kamens, jik@security.ov.com.
5
6 This file is part of SXEmacs.
7
8 SXEmacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 SXEmacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program.  If not, see <http://www.gnu.org/licenses/>. */
20
21 #include <stdio.h>
22
23 #define GETLINE_MIN 1024        /* the getline buffer starts out this */
24                                 /* size */
25 #define GETLINE_INCR 1024       /* the getline buffer is grown by this */
26                                 /* size when it needs to grow */
27
28 extern char pop_error[];
29 extern int pop_debug;
30
31 struct _popserver
32 {
33         int file, data;
34         char *buffer;
35         int buffer_size, buffer_index;
36         int in_multi;
37         int trash_started;
38 };
39
40 typedef struct _popserver *popserver;
41
42 /*
43  * Valid flags for the pop_open function.
44  */
45
46 #define POP_NO_KERBEROS (1<<0)
47 #define POP_NO_HESIOD   (1<<1)
48 #define POP_NO_GETPASS  (1<<2)
49
50 #ifdef __STDC__
51 #define _ARGS(a) a
52 #else
53 #define _ARGS(a) ()
54 #endif
55
56 extern popserver pop_open _ARGS((char *host, char *username, char *password,
57                                  int flags));
58 extern int pop_stat _ARGS((popserver server, int *count, int *size));
59 extern int pop_list _ARGS((popserver server, int message, int **IDs,
60                            int **size));
61 extern int pop_retrieve _ARGS((popserver server, int message, int markfrom,
62                                char **));
63 extern int pop_retrieve_first _ARGS((popserver server, int message,
64                                      char **response));
65 extern int pop_retrieve_next _ARGS((popserver server, char **line));
66 extern int pop_retrieve_flush _ARGS((popserver server));
67 extern int pop_top_first _ARGS((popserver server, int message, int lines,
68                                 char **response));
69 extern int pop_top_next _ARGS((popserver server, char **line));
70 extern int pop_top_flush _ARGS((popserver server));
71 extern int pop_multi_first _ARGS((popserver server, char *command,
72                                   char **response));
73 extern int pop_multi_next _ARGS((popserver server, char **line));
74 extern int pop_multi_flush _ARGS((popserver server));
75 extern int pop_delete _ARGS((popserver server, int message));
76 extern int pop_noop _ARGS((popserver server));
77 extern int pop_last _ARGS((popserver server));
78 extern int pop_reset _ARGS((popserver server));
79 extern int pop_quit _ARGS((popserver server));
80 extern void pop_close _ARGS((popserver));
81
82 #undef _ARGS
83