]> Pileus Git - ~andy/fetchmail/blobdiff - fetchmail.h
Before showdots,
[~andy/fetchmail] / fetchmail.h
index 41d9da07c263a1cb16b5bb92ea4bca297e441c3e..bba30e219ab938d62fef1d952f8f25e944b08841 100644 (file)
@@ -2,27 +2,40 @@
  * For license terms, see the file COPYING in this directory.
  */
 
+/* We need this for HAVE_STDARG_H, etc */
+#include "config.h"
+
 /* constants designating the various supported protocols */
-#define                P_AUTO          0
+#define                P_AUTO          1
 #define                P_POP2          2
 #define                P_POP3          3
-#define                P_IMAP          4
-#define                P_IMAP_K4       5
-#define                P_IMAP_GSS      6
-#define                P_APOP          7
-#define                P_RPOP          8
-#define                P_ETRN          9
-
-#if INET6
+#define                P_APOP          4
+#define                P_RPOP          5
+#define                P_IMAP          6
+#define                P_IMAP_K4       7
+#define                P_IMAP_GSS      8
+#define                P_IMAP_CRAM_MD5 9
+#define                P_IMAP_LOGIN    10
+#define                P_ETRN          11
+
+#if INET6_ENABLE
+#define                SMTP_PORT       "smtp"
 #define                KPOP_PORT       "kpop"
-#else /* INET6 */
+#else /* INET6_ENABLE */
+#define                SMTP_PORT       25
 #define                KPOP_PORT       1109
-#endif /* INET6 */
+#endif /* INET6_ENABLE */
+
+#ifdef SSL_ENABLE
+#define                SIMAP_PORT      993
+#define                SPOP3_PORT      995
+#endif
 
 /* preauthentication types */
 #define                A_PASSWORD      0       /* password or inline authentication */
 #define                A_KERBEROS_V4   1       /* preauthenticate w/ Kerberos V4 */
 #define                A_KERBEROS_V5   2       /* preauthenticate w/ Kerberos V5 */
+#define                A_SSH           3       /* preauthentication at session level */
 
 /*
  * Definitions for buffer sizes.  We get little help on setting maxima
@@ -46,6 +59,7 @@
  */
 #define                MSGBUFSIZE      8192
 
+#define                NAMELEN         64      /* max username length */
 #define                PASSWORDLEN     64      /* max password length */
 #define                DIGESTLEN       33      /* length of MD5 digest */
 
 #define                PS_EXCLUDE      8       /* client-side exclusion error */
 #define                PS_LOCKBUSY     9       /* server responded lock busy */
 #define                PS_SMTP         10      /* SMTP error */
-#define                PS_DNS          11      /* fatal DNS error */   
-#define                PS_UNDEFINED    12      /* something I hadn't thought of */
-#define                PS_TRANSIENT    13      /* transient failure (internal use) */
-#define                PS_REFUSED      14      /* mail refused (internal use) */
-#define                PS_RETAINED     15      /* message retained (internal use) */
-#define                PS_TRUNCATED    16      /* headers incomplete (internal use) */
+#define                PS_DNS          11      /* fatal DNS error */
+#define                PS_BSMTP        12      /* output batch could not be opened */
+#define                PS_MAXFETCH     13      /* poll ended by fetch limit */
+/* leave space for more codes */
+#define                PS_UNDEFINED    23      /* something I hadn't thought of */
+#define                PS_TRANSIENT    24      /* transient failure (internal use) */
+#define                PS_REFUSED      25      /* mail refused (internal use) */
+#define                PS_RETAINED     26      /* message retained (internal use) */
+#define                PS_TRUNCATED    27      /* headers incomplete (internal use) */
 
 /* output noise level */
 #define         O_SILENT       0       /* mute, max squelch, etc. */
@@ -96,14 +113,16 @@ struct runctl
     char       *logfile;
     char       *idfile;
     int                poll_interval;
+    char       *postmaster;
+    flag       bouncemail;
+    char       *properties;
     flag       use_syslog;
     flag       invisible;
-    char       *postmaster;
 };
 
 struct idlist
 {
-    char *id;
+    unsigned char *id;
     union
     {
        struct
@@ -116,32 +135,47 @@ struct idlist
 #define UID_EXPUNGED   3               /* this message has been expunged */ 
         }
        status;
-       char *id2;
+       unsigned char *id2;
     } val;
     struct idlist *next;
 };
 
+struct query;
+
 struct method          /* describe methods for protocol state machine */
 {
-    char *name;                        /* protocol name */
-#if INET6
-    char *service;
-#else /* INET6 */
+    const char *name;          /* protocol name */
+#if INET6_ENABLE
+    const char *service;
+    const char *sslservice;
+#else /* INET6_ENABLE */
     int        port;                   /* service port */
-#endif /* INET6 */
+    int        sslport;                /* service port for ssl */
+#endif /* INET6_ENABLE */
     flag tagged;               /* if true, generate & expect command tags */
     flag delimited;            /* if true, accept "." message delimiter */
-    int (*parse_response)();   /* response_parsing function */
-    int (*password_canonify)();        /* canonicalize password */
-    int (*getauth)();          /* authorization fetcher */
-    int (*getrange)();         /* get message range to fetch */
-    int (*getsizes)();         /* get sizes of messages */
-    int (*is_old)();           /* check for old message */
-    int (*fetch_headers)();    /* fetch FROM headera given message */
-    int (*fetch_body)();       /* fetch a given message */
-    int (*trail)();            /* eat trailer of a message */
-    int (*delete)();           /* delete method */
-    int (*logout_cmd)();       /* logout command */
+    int (*parse_response)(int, char *);
+                               /* response_parsing function */
+    int (*password_canonify)(char *, char *, int);
+                               /* canonicalize password */
+    int (*getauth)(int, struct query *, char *);
+                               /* authorization fetcher */
+    int (*getrange)(int, struct query *, const char *, int *, int *, int *);
+                               /* get message range to fetch */
+    int (*getsizes)(int, int, int *);
+                               /* get sizes of messages */
+    int (*is_old)(int, struct query *, int);
+                               /* check for old message */
+    int (*fetch_headers)(int, struct query *, int, int *);
+                               /* fetch FROM headera given message */
+    int (*fetch_body)(int, struct query *, int, int *);
+                               /* fetch a given message */
+    int (*trail)(int, struct query *, int);
+                               /* eat trailer of a message */
+    int (*delete)(int, struct query *, int);
+                               /* delete method */
+    int (*logout_cmd)(int, struct query *);
+                               /* logout command */
     flag retry;                        /* can getrange poll for new messages? */
 };
 
@@ -153,12 +187,12 @@ struct hostdata           /* shared among all user connections to given server */
     struct idlist *akalist;            /* server name first, then akas */
     struct idlist *localdomains;       /* list of pass-through domains */
     int protocol;                      /* protocol type */
-#if INET6
+#if INET6_ENABLE
     char *service;                     /* IPv6 service name */
     void *netsec;                      /* IPv6 security request */
-#else /* INET6 */
+#else /* INET6_ENABLE */
     int port;                          /* TCP/IP service port number */
-#endif /* INET6 */
+#endif /* INET6_ENABLE */
     int interval;                      /* # cycles to skip between polls */
     int preauthenticate;               /* preauthentication mode to try */
     int timeout;                       /* inactivity timout in seconds */
@@ -174,18 +208,21 @@ struct hostdata           /* shared among all user connections to given server */
     flag checkalias;                   /* resolve aliases by comparing IPs? */
 
 
-#ifdef linux
+#if defined(linux) || defined(__FreeBSD__)
     char *interface;
     char *monitor;
     int  monitor_io;
     struct interface_pair_s *interface_pair;
 #endif /* linux */
 
+    char *plugin,*plugout;
+
     /* computed for internal use */
-    struct method *base_protocol;      /* relevant protocol method table */
+    const struct method *base_protocol;        /* relevant protocol method table */
     int poll_count;                    /* count of polls so far */
     char *queryname;                   /* name to attempt DNS lookup on */
     char *truename;                    /* "true name" of server host */
+    char *trueaddr;                     /* IP address of truename, as char */
     struct hostdata *lead_server;      /* ptr to lead query for this server */
     int esmtp_options;
 };
@@ -201,11 +238,17 @@ struct query
     char *remotename;          /* remote login name to use */
     char *password;            /* remote password to use */
     struct idlist *mailboxes;  /* list of mailboxes to check */
+
+    /* per-forwarding-target data */
     struct idlist *smtphunt;   /* list of SMTP hosts to try forwarding to */
-    char *smtphost;            /* actual SMTP host to point to */
-    char *smtpaddress;         /* address we want to force in the delivery messages */ 
+    char *smtpaddress;         /* address to force in RCPT TO */ 
+    char *smtpname;             /* full RCPT TO name, including domain */
     struct idlist *antispam;   /* list of listener's antispam response */
     char *mda;                 /* local MDA to pass mail to */
+    char *bsmtp;               /* BSMTP output file */
+    char listener;             /* what's the listener's wire protocol? */
+#define SMTP_MODE      'S'
+#define LMTP_MODE      'L'
     char *preconnect;          /* pre-connection command to execute */
     char *postconnect;         /* post-connection command to execute */
 
@@ -218,22 +261,31 @@ struct query
     flag forcecr;              /* if TRUE, force CRs before LFs in text */
     flag pass8bits;            /* if TRUE, ignore Content-Transfer-Encoding */
     flag dropstatus;           /* if TRUE, drop Status lines in mail */
-    flag mimedecode;           /* if TRUE, decode MIME-coded headers/coded printable*/
+    flag dropdelivered;         /* if TRUE, drop Delivered-To lines in mail */
+    flag mimedecode;           /* if TRUE, decode MIME-armored messages */
+    flag idle;                 /* if TRUE, idle after each poll */
     int        limit;                  /* limit size of retrieved messages */
     int warnings;              /* size warning interval */
     int        fetchlimit;             /* max # msgs to get in single poll */
     int        batchlimit;             /* max # msgs to pass in single SMTP session */
     int        expunge;                /* max # msgs to pass between expunges */
-
-    struct idlist *oldsaved, *newsaved;
+    flag use_ssl;              /* use SSL encrypted session */
+    char *sslkey;              /* optional SSL private key file */
+    char *sslcert;             /* optional SSL certificate file */
+    char *properties;          /* passthrough properties for extensions */
 
     /* internal use -- per-poll state */
     flag active;               /* should we actually poll this server? */
-    char *destaddr;            /* destination host for this query */
+    const char *destaddr;      /* destination host for this query */
     int errcount;              /* count transient errors in last pass */
+    int authfailcount;         /* count of authorization failures */
+    int wedged;                        /* wedged by auth failures or timeouts? */
+    char *smtphost;            /* actual SMTP host we connected to */
     int smtp_socket;           /* socket descriptor for SMTP connection */
     unsigned int uid;          /* UID of user to deliver to */
     struct idlist *skipped;    /* messages skipped on the mail server */
+    struct idlist *oldsaved, *newsaved;
+    char *lastid;              /* last Message-ID seen on this connection */
 
     /* internal use -- per-message state */
     int mimemsg;               /* bitmask indicating MIME body-type */
@@ -243,11 +295,23 @@ struct query
     struct query *next;                /* next query control block in chain */
 };
 
+struct msgblk                  /* message header parsed for open_sink() */
+{
+    char               *headers;       /* raw message headers */
+    struct idlist      *recipients;    /* addressees */
+    char               return_path[HOSTLEN + USERNAMELEN + 4]; 
+    int                        reallen;
+};
+
+
 /*
  * Numeric option handling.  Numeric option value of zero actually means
- * it's unspecified.  Value less than zero is zero.
+ * it's unspecified.  Value less than zero is zero.  The reason for this
+ * screwy encoding is so we can zero out an option block in order to set the
+ * numeric flags in it to unspecified.
  */
-#define NUM_VALUE(n)           (((n) == 0) ? -1 : (n))
+#define NUM_VALUE_IN(n)                (((n) == 0) ? -1 : (n))
+#define NUM_VALUE_OUT(n)       (((n) < 0) ? 0 : (n))
 #define NUM_NONZERO(n)         ((n) > 0)
 #define NUM_ZERO(n)            ((n) < 0)
 #define NUM_SPECIFIED(n)       ((n) != 0)
@@ -290,24 +354,30 @@ extern int linelimit;             /* limit # lines retrieved per site */
 extern flag versioninfo;       /* emit only version info */
 extern char *user;             /* name of invoking user */
 extern char *home;             /* home directory of invoking user */
+extern char *fmhome;           /* fetchmail home directory */
 extern int pass;               /* number of re-polling pass */
 extern flag configdump;                /* dump control blocks as Python dictionary */
-extern char *fetchmailhost;    /* either "localhost" or an FQDN */
+extern const char *fetchmailhost;
+                               /* either "localhost" or an FQDN */
+#ifdef SDPS_ENABLE
+extern char *sdps_envfrom;
+extern char *sdps_envto;
+#endif /* SDPS_ENABLE */
 
 /* prototypes for globally callable functions */
 
 /* error.c: Error reporting */
 #if defined(HAVE_STDARG_H)
-void error_init(int foreground);
-void error (int status, int errnum, const char *format, ...);
-void error_build (const char *format, ...);
-void error_complete (int status, int errnum, const char *format, ...);
-void error_at_line (int, int, const char *, unsigned int, const char *, ...);
+void report_init(int foreground);
+void report (FILE *fp, const char *format, ...);
+void report_build (FILE *fp, const char *format, ...);
+void report_complete (FILE *fp, const char *format, ...);
+void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...);
 #else
-void error ();
-void error_build ();
-void error_complete ();
-void error_at_line ();
+void report ();
+void report_build ();
+void report_complete ();
+void report_at_line ();
 #endif
 
 /* driver.c: transaction support */
@@ -315,7 +385,7 @@ void set_timeout(int);
 #if defined(HAVE_STDARG_H)
 void gen_send (int sock, const char *, ... );
 int gen_recv(int sock, char *buf, int size);
-int gen_transact (int sock, char *, ... );
+int gen_transact (int sock, const char *, ... );
 #else
 void gen_send ();
 int gen_recv();
@@ -330,25 +400,47 @@ int gen_transact ();
 #define FORWARDING_WAIT        4       /* waiting for listener response */
 extern int phase;
 
+/* response hooks can use this to identify the query stage */
+#define STAGE_GETAUTH  0
+#define STAGE_GETRANGE 1
+#define STAGE_GETSIZES 2
+#define STAGE_FETCH    3
+#define STAGE_IDLE     4
+#define STAGE_LOGOUT   5
+extern int stage;
+
+extern int mytimeout;
+
 /* mark values for name lists */
-#define XMIT_ACCEPT            1
-#define XMIT_REJECT            2
-#define XMIT_ANTISPAM          3
+#define XMIT_ACCEPT    1       /* accepted; matches local domain or name */
+#define XMIT_REJECT    2       /* rejected; no match */
+#define XMIT_RCPTBAD   3       /* SMTP listener rejected the name */ 
+
+/* idle.c */
+int interruptible_idle(int interval);
 
 /* sink.c: forwarding */
 int stuffline(struct query *, char *);
-int open_sink(struct query*, char*, struct idlist*, long reallen, int*, int*);
+int open_sink(struct query*, struct msgblk *, int*, int*);
 void release_sink(struct query *);
-int close_sink(struct query *, flag);
+int close_sink(struct query *, struct msgblk *, flag);
+int open_warning_by_mail(struct query *, struct msgblk *);
+#if defined(HAVE_STDARG_H)
+void stuff_warning(struct query *, const char *, ... );
+#else
+void stuff_warning();
+#endif
+void close_warning_by_mail(struct query *, struct msgblk *);
 
 /* rfc822.c: RFC822 header parsing */
-char *reply_hack(char *, const char *);
-char *nxtaddr(const char *);
+unsigned char *reply_hack(unsigned char *, const unsigned char *);
+unsigned char *nxtaddr(const unsigned char *);
 
 /* uid.c: UID support */
 void initialize_saved_lists(struct query *, const char *);
 struct idlist *save_str(struct idlist **, const char *, flag);
 void free_str_list(struct idlist **);
+struct idlist *copy_str_list(struct idlist *idl);
 void save_str_pair(struct idlist **, const char *, const char *);
 void free_str_pair_list(struct idlist **);
 int delete_str(struct idlist **, int);
@@ -362,7 +454,7 @@ char *str_find(struct idlist **, int);
 char *idpair_find(struct idlist **, const char *);
 void append_str_list(struct idlist **, struct idlist **);
 void expunge_uids(struct query *);
-void update_str_lists(struct query *);
+void uid_swap_lists(struct query *);
 void write_saved_lists(struct query *, const char *);
 
 /* rcfile_y.y */
@@ -380,12 +472,13 @@ int from64tobits(char *, const char *);
 #define MSG_NEEDS_DECODE  0x80
 extern void UnMimeHeader(unsigned char *buf);
 extern int  MimeBodyType(unsigned char *hdrs, int WantDecode);
-extern int  UnMimeBodyline(unsigned char **buf, int collapsedoubledot);
+extern int  UnMimeBodyline(unsigned char **buf, flag delimited, flag issoftline);
 
 /* interface.c */
+void interface_init(void);
 void interface_parse(char *, struct hostdata *);
 void interface_note_activity(struct hostdata *);
-int interface_approve(struct hostdata *);
+int interface_approve(struct hostdata *, flag domonitor);
 
 /* xmalloc.c */
 #if defined(HAVE_VOIDPOINTER)
@@ -396,6 +489,22 @@ int interface_approve(struct hostdata *);
 XMALLOCTYPE *xmalloc(int);
 XMALLOCTYPE *xrealloc(XMALLOCTYPE *, int);
 char *xstrdup(const char *);
+#if defined(HAVE_ALLOCA_H)
+#include <alloca.h>
+#else
+#ifdef _AIX
+ #pragma alloca
+#endif
+#endif
+#define        xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n)))\
+       {report(stderr, _("alloca failed")); exit(PS_UNDEFINED);}
+#if FALSE
+/*
+ * This is a hack to help xgettext which cannot find strings in
+ * macro definitions like the one for xalloca above.
+ */
+static char *dummy = gettext_noop("alloca failed");
+#endif
 
 /* protocol driver and methods */
 int do_protocol(struct query *, const struct method *);
@@ -410,16 +519,15 @@ int parsecmdline (int, char **, struct runctl *, struct query *);
 char *MD5Digest (unsigned char *);
 int POP3_auth_rpa(unsigned char *, unsigned char *, int socket);
 int daemonize(const char *, void (*)(int));
-char *getpassword(char *);
+char *fm_getpassword(char *);
 void escapes(const char *, char *);
 char *visbuf(const char *);
-char *showproto(int);
+const char *showproto(int);
 void dump_config(struct runctl *runp, struct query *querylist);
 int is_host_alias(const char *, struct query *);
 char *host_fqdn(void);
-#ifdef SDPS_ENABLE
-char *sdps_envto;
-#endif /* SDPS_ENABLE */
+char *rfc822timestamp(void);
+flag isafile(int);
 
 void yyerror(const char *);
 int yylex(void);
@@ -435,9 +543,21 @@ void itimerthread(void*);
    find all of our lock files and stuff. */
 #define getcwd _getcwd2
 #define chdir _chdir2
-#endif
+#endif /* _EMX_ */
+
+# if HAVE_STRERROR
+#  ifndef strerror             /* On some systems, strerror is a macro */
+char *strerror ();
+#  endif
+# endif /* HAVE_STRERROR */
 
 #define STRING_DISABLED        (char *)-1
 #define STRING_DUMMY   ""
 
+#ifdef NeXT
+#ifndef S_IXGRP
+#define S_IXGRP 0000010
+#endif
+#endif
+
 /* fetchmail.h ends here */