lib-src/pop.h

   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.
   4
   5 This file is part of GNU Emacs.
   6
   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.
  11
  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.
  16
  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.  */
  21
  22 #include <stdio.h>
  23
  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 */
  28
  29 extern char pop_error[];
  30 extern int pop_debug;
  31
  32 struct _popserver
  33 {
  34   int file, data;
  35   char *buffer;
  36   int buffer_size, buffer_index;
  37   int in_multi;
  38   int trash_started;
  39   void *extra;
  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 #define POP_NO_GSSAPI   (1<<3)  /* don't use the GSSAPI */
  52 #define POP_NO_NOPROT   (1<<4)  /* prohibit no protection; this *only* */
  53                                 /* makes sense if you use GSSAPI */
  54 #define POP_NO_INTEG    (1<<5)  /* don't use plain integrity */
  55 #define POP_NO_ENCRYPT  (1<<6)  /* don't use encryption */
  56
  57 /*
  58  * GSSAPI documentation
  59  *
  60  * This version will attempt to perform a GSSAPI handshake first; if this
  61  * fails, then it will attempt standard POP authentication.  Note that
  62  * library conflicts may prevent the use of this with the Kerberos
  63  * kpop hack.
  64  *
  65  * If you specify POP_NO_NOPROT and this library is unable to provide either
  66  * integrity protection or encryption, pop_open() will fail.  The pop_open()
  67  * call will attempt the highest level protection available; i.e., if both
  68  * server and client support encryption (and you do not provide the
  69  * POP_NO_ENCRYPT flag), that will be used; if both server and client support
  70  * integrity protection (and you do not provide the POP_NO_INTEG flag), that
  71  * will be used.  If neither of these are available, and you have not
  72  * specified the POP_NO_NOPROT flag, then this will be a normal, unprotected
  73  * connection.
  74  */
  75
  76 #ifdef __STDC__
  77 #define _ARGS(a) a
  78 #else
  79 #define _ARGS(a) ()
  80 #endif
  81
  82 extern popserver pop_open _ARGS((char *host, char *username, char *password,
  83                                  int flags));
  84 extern int pop_stat _ARGS((popserver server, int *count, int *size));
  85 extern int pop_list _ARGS((popserver server, int message, int **IDs,
  86                            int **size));
  87 extern int pop_retrieve _ARGS((popserver server, int message, int markfrom,
  88                                char **));
  89 extern int pop_retrieve_first _ARGS((popserver server, int message,
  90                                      char **response));
  91 extern int pop_retrieve_next _ARGS((popserver server, char **line));
  92 extern int pop_retrieve_flush _ARGS((popserver server));
  93 extern int pop_top_first _ARGS((popserver server, int message, int lines,
  94                                 char **response));
  95 extern int pop_top_next _ARGS((popserver server, char **line));
  96 extern int pop_top_flush _ARGS((popserver server));
  97 extern int pop_multi_first _ARGS((popserver server, char *command,
  98                                   char **response));
  99 extern int pop_multi_next _ARGS((popserver server, char **line));
 100 extern int pop_multi_flush _ARGS((popserver server));
 101 extern int pop_delete _ARGS((popserver server, int message));
 102 extern int pop_noop _ARGS((popserver server));
 103 extern int pop_last _ARGS((popserver server));
 104 extern int pop_reset _ARGS((popserver server));
 105 extern int pop_quit _ARGS((popserver server));
 106 extern void pop_close _ARGS((popserver));
 107
 108 #undef _ARGS