annotate lib-src/pop.h @ 298:70ad99077275 r21-0b47

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