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, 2005, 2006, 2007,
   3                  2008, 2009, 2010  Free Software Foundation, Inc.
   4
   5 Author:  Jonathan Kamens <jik@security.ov.com>
   6
   7 This file is part of GNU Emacs.
   8
   9 GNU Emacs is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 GNU Emacs is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  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
  30 extern char pop_error[];
  31 extern int pop_debug;
  32
  33 struct _popserver
  34 {
  35   int file, data;
  36   char *buffer;
  37   int buffer_size, buffer_index;
  38   int in_multi;
  39   int trash_started;
  40 };
  41
  42 typedef 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
  52 extern popserver pop_open (char *host, char *username, char *password,
  53                            int flags);
  54 extern int pop_stat (popserver server, int *count, int *size);
  55 extern int pop_list (popserver server, int message, int **IDs,
  56                      int **size);
  57 extern int pop_retrieve (popserver server, int message, int markfrom,
  58                          char **);
  59 extern int pop_retrieve_first (popserver server, int message,
  60                                char **response);
  61 extern int pop_retrieve_next (popserver server, char **line);
  62 extern int pop_retrieve_flush (popserver server);
  63 extern int pop_top_first (popserver server, int message, int lines,
  64                           char **response);
  65 extern int pop_top_next (popserver server, char **line);
  66 extern int pop_top_flush (popserver server);
  67 extern int pop_multi_first (popserver server, const char *command,
  68                             char **response);
  69 extern int pop_multi_next (popserver server, char **line);
  70 extern int pop_multi_flush (popserver server);
  71 extern int pop_delete (popserver server, int message);
  72 extern int pop_noop (popserver server);
  73 extern int pop_last (popserver server);
  74 extern int pop_reset (popserver server);
  75 extern int pop_quit (popserver server);
  76 extern void pop_close (popserver);
  77
  78 /* arch-tag: 76cc5f58-8e86-48fa-bc72-a7c6cb1c4f1c
  79    (do not change this comment) */