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