annotate lib-src/pop.h @ 82353:02af9b581498

(gud): Change to group `processes'.
author Richard M. Stallman <rms@gnu.org>
date Sun, 12 Aug 2007 17:53:21 +0000
parents 1f2482de3237
children 5714ff101fd9 f55f9811f5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 /* pop.h: Header file for the "pop.c" client POP3 protocol.
75250
6d19c76d81c5 Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 68647
diff changeset
2 Copyright (C) 1991, 1993, 2001, 2002, 2003, 2004,
6d19c76d81c5 Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 68647
diff changeset
3 2005, 2006, 2007 Free Software Foundation, Inc.
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 Written by Jonathan Kamens, jik@security.ov.com.
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 This file is part of GNU Emacs.
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 GNU Emacs is free software; you can redistribute it and/or modify
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 it under the terms of the GNU General Public License as published by
78257
1f2482de3237 Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 75250
diff changeset
10 the Free Software Foundation; either version 3, or (at your option)
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 any later version.
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 GNU Emacs is distributed in the hope that it will be useful,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 GNU General Public License for more details.
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 along with GNU Emacs; see the file COPYING. If not, write to
64083
23a17af379b1 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23a17af379b1 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
21 Boston, MA 02110-1301, USA. */
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 #include <stdio.h>
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 #define GETLINE_MIN 1024 /* the getline buffer starts out this */
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 /* size */
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 #define GETLINE_INCR 1024 /* the getline buffer is grown by this */
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 /* size when it needs to grow */
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 extern char pop_error[];
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 extern int pop_debug;
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 struct _popserver
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 {
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 int file, data;
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 char *buffer;
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 int buffer_size, buffer_index;
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 int in_multi;
15103
00d52ba071ea (struct _popserver): New field trash_started.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
39 int trash_started;
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 };
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 typedef struct _popserver *popserver;
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 /*
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 * Valid flags for the pop_open function.
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 */
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 #define POP_NO_KERBEROS (1<<0)
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 #define POP_NO_HESIOD (1<<1)
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 #define POP_NO_GETPASS (1<<2)
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 #ifdef __STDC__
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 #define _ARGS(a) a
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 #else
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 #define _ARGS(a) ()
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 #endif
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 extern popserver pop_open _ARGS((char *host, char *username, char *password,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 int flags));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 extern int pop_stat _ARGS((popserver server, int *count, int *size));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 extern int pop_list _ARGS((popserver server, int message, int **IDs,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 int **size));
20418
7e1538a45702 Allow messages retrieved from the POP
Karl Heuer <kwzh@gnu.org>
parents: 15103
diff changeset
63 extern int pop_retrieve _ARGS((popserver server, int message, int markfrom,
7e1538a45702 Allow messages retrieved from the POP
Karl Heuer <kwzh@gnu.org>
parents: 15103
diff changeset
64 char **));
9158
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 extern int pop_retrieve_first _ARGS((popserver server, int message,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 char **response));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 extern int pop_retrieve_next _ARGS((popserver server, char **line));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 extern int pop_retrieve_flush _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 extern int pop_top_first _ARGS((popserver server, int message, int lines,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 char **response));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 extern int pop_top_next _ARGS((popserver server, char **line));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 extern int pop_top_flush _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 extern int pop_multi_first _ARGS((popserver server, char *command,
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 char **response));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 extern int pop_multi_next _ARGS((popserver server, char **line));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 extern int pop_multi_flush _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 extern int pop_delete _ARGS((popserver server, int message));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 extern int pop_noop _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 extern int pop_last _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 extern int pop_reset _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 extern int pop_quit _ARGS((popserver server));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 extern void pop_close _ARGS((popserver));
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83
939488de5d3f Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 #undef _ARGS
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 22236
diff changeset
85
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 22236
diff changeset
86 /* arch-tag: 76cc5f58-8e86-48fa-bc72-a7c6cb1c4f1c
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 22236
diff changeset
87 (do not change this comment) */