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