]> Pileus Git - ~andy/fetchmail/blobdiff - fetchmail.h
Ready to ship.
[~andy/fetchmail] / fetchmail.h
index c7e5795ec8f75bd1f7ecb7927f5e223872130997..aa1c1215f110bf39b86e8c5cf99e065806265751 100644 (file)
@@ -8,24 +8,46 @@
 #define                P_POP3          3
 #define                P_IMAP          4
 #define                P_IMAP_K4       5
-#define                P_APOP          6
-#define                P_RPOP          7
-#define                P_ETRN          8
-
+#define                P_IMAP_GSS      6
+#define                P_APOP          7
+#define                P_RPOP          8
+#define                P_ETRN          9
+
+#if INET6
+#define                KPOP_PORT       "kpop"
+#else /* INET6 */
 #define                KPOP_PORT       1109
+#endif /* INET6 */
 
 /* 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 */
+
+/*
+ * Definitions for buffer sizes.  We get little help on setting maxima
+ * from IMAP RFCs up to 2060, so these are mostly from POP3.
+ */
+#define                HOSTLEN         635     /* max hostname length (RFC1123) */
+#define                POPBUFSIZE      512     /* max length of response (RFC1939) */
+#define                IDLEN           128     /* max length of UID (RFC1939) */
+
+/* per RFC1939 this should be 40, but Microsoft Exchange ignores that limit */
+#define                USERNAMELEN     128     /* max POP3 arg length */
+
+/* clear a netBSD kernel parameter out of the way */ 
+#undef         MSGBUFSIZE
+
+/*
+ * The RFC822 limit on message line size is just 998.  But
+ * make this *way* oversized; idiot DOS-world mailers that
+ * don't line-wrap properly often ship entire paragraphs as
+ * lines.
+ */
+#define                MSGBUFSIZE      8192
 
-/* definitions for buffer sizes -- somewhat arbitrary */
-#define                POPBUFSIZE      512     /* per RFC 937 */
-#define                MSGBUFSIZE      2048    /* size of message read buffer */
-#define                HOSTLEN         128     /* max hostname length */
-#define                USERNAMELEN     32      /* max user-name length */
 #define                PASSWORDLEN     64      /* max password length */
 #define                DIGESTLEN       33      /* length of MD5 digest */
-#define                IDLEN           128     /* length of UIDL message ID */
 
 /* exit code values */
 #define                PS_SUCCESS      0       /* successful receipt of messages */
@@ -44,6 +66,7 @@
 #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) */
 
 /* output noise level */
 #define         O_SILENT       0       /* mute, max squelch, etc. */
 
 #define                SIZETICKER      1024    /* print 1 dot per this many bytes */
 
+/*
+ * We #ifdef this and use flag rather than bool
+ * to avoid a type clash with curses.h
+ */
+#ifndef TRUE
+#define FALSE  0
+#define TRUE   1
+#endif /* TRUE */
+typedef        char    flag;
+
 /* we need to use zero as a flag-uninitialized value */
 #define FLAG_TRUE      2
 #define FLAG_FALSE     1
 
+struct runctl
+{
+    char       *logfile;
+    char       *idfile;
+    int                poll_interval;
+    flag       use_syslog;
+    flag       invisible;
+    char       *postmaster;
+};
+
 struct idlist
 {
     char *id;
     union
     {
-       int num;
+       struct
+       {
+           short       num;
+           flag        mark;           /* UID-index information */
+#define UID_UNSEEN     0               /* hasn't been seen */
+#define UID_SEEN       1               /* seen, but not deleted */
+#define UID_DELETED    2               /* this message has been deleted */
+#define UID_EXPUNGED   3               /* this message has been expunged */ 
+        }
+       status;
        char *id2;
     } val;
     struct idlist *next;
 };
 
-/*
- * We #ifdef this and use flag rather than bool
- * to avoid a type clash with curses.h
- */
-#ifndef TRUE
-#define FALSE  0
-#define TRUE   1
-#endif /* TRUE */
-typedef        char    flag;
-
 struct hostdata                /* shared among all user connections to given server */
 {
     /* rc file data */
@@ -85,7 +127,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
+    char *service;                     /* IPv6 service name */
+    void *netsec;                      /* IPv6 security request */
+#else /* INET6 */
     int port;                          /* TCP/IP service port number */
+#endif /* INET6 */
     int interval;                      /* # cycles to skip between polls */
     int preauthenticate;               /* preauthentication mode to try */
     int timeout;                       /* inactivity timout in seconds */
@@ -95,6 +142,11 @@ struct hostdata             /* shared among all user connections to given server */
     flag skip;                         /* suppress poll in implicit mode? */
     flag dns;                          /* do DNS lookup on multidrop? */
     flag uidl;                         /* use RFC1725 UIDLs? */
+#ifdef SDPS_ENABLE
+    flag sdps;                         /* use Demon Internet SDPS *ENV */
+#endif /* SDPS_ENABLE */
+    flag checkalias;                   /* resolve aliases by comparing IPs? */
+
 
 #ifdef linux
     char *interface;
@@ -124,6 +176,8 @@ struct query
     struct idlist *mailboxes;  /* list of mailboxes to check */
     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 */ 
+    struct idlist *antispam;   /* list of listener's antispam response */
     char *mda;                 /* local MDA to pass mail to */
     char *preconnect;          /* pre-connection command to execute */
     char *postconnect;         /* post-connection command to execute */
@@ -137,15 +191,12 @@ 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*/
     int        limit;                  /* limit size of retrieved messages */
     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 */
 
-    /* unseen, previous state of mailbox (initially from .fetchids) */
-#define UID_KEPT       0       /* this was remembered from a previous run */
-#define UID_DELETED    -1      /* this message has been deleted */
-#define UID_EXPUNGED   -2      /* this message has been expunged */ 
     struct idlist *oldsaved, *newsaved;
 
     /* internal use */
@@ -157,16 +208,30 @@ struct query
     struct query *next;                /* next query control block in chain */
 };
 
+/*
+ * Numeric option handling.  Numeric option value of zero actually means
+ * it's unspecified.  Value less than zero is zero.
+ */
+#define NUM_VALUE(n)           (((n) == 0) ? -1 : (n))
+#define NUM_NONZERO(n)         ((n) > 0)
+#define NUM_ZERO(n)            ((n) < 0)
+#define NUM_SPECIFIED(n)       ((n) != 0)
+
 #define MULTIDROP(ctl) (ctl->wildcard || \
                                ((ctl)->localnames && (ctl)->localnames->next))
 
 struct method
 {
     char *name;                        /* protocol name */
+#if INET6
+    char *service;
+#else /* INET6 */
     int        port;                   /* service port */
+#endif /* INET6 */
     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 */
@@ -200,30 +265,22 @@ extern void envquery(int, char **);
 extern int outlevel;           /* see the O_.* constants above */
 extern int yydebug;            /* enable parse debugging */
 
-/* daemon mode control */
-extern int poll_interval;      /* poll interval in seconds */
-extern flag nodetach;          /* if TRUE, don't detach daemon process */
-extern char *logfile;          /* log file for daemon mode */
-extern flag use_syslog;                /* if syslog was set */
-extern flag use_invisible;     /* if invisible was set */
-extern flag quitmode;          /* if --quit was set */
-extern flag check_only;                /* if --check was set */
-extern char *cmd_logfile;      /* if --logfile was set */
-extern int cmd_daemon;         /* if --daemon was set */
-
 /* these get computed */
 extern int batchcount;         /* count of messages sent in current batch */
 extern flag peek_capable;      /* can we read msgs without setting seen? */
 
 /* miscellaneous global controls */
+extern struct runctl run;      /* global controls for this run */
+extern flag nodetach;          /* if TRUE, don't detach daemon process */
+extern flag quitmode;          /* if --quit was set */
+extern flag check_only;                /* if --check was set */
 extern char *rcfile;           /* path name of rc file */
-extern char *idfile;           /* path name of UID file */
 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 *fetchmailhost;    /* the name of the host running fetchmail */
 extern int pass;               /* number of re-polling pass */
+extern flag configdump;                /* dump control blocks as Python dictionary */
 
 /* prototypes for globally callable functions */
 
@@ -243,7 +300,7 @@ void error_at_line ();
 
 /* driver.c: transaction support */
 #if defined(HAVE_STDARG_H)
-void gen_send (int sock, char *, ... );
+void gen_send (int sock, const char *, ... );
 int gen_recv(int sock, char *buf, int size);
 int gen_transact (int sock, char *, ... );
 #else
@@ -258,13 +315,15 @@ char *nxtaddr(const char *);
 
 /* uid.c: UID support */
 void initialize_saved_lists(struct query *, const char *);
-struct idlist *save_str(struct idlist **, int, const char *);
+struct idlist *save_str(struct idlist **, const char *, flag);
 void free_str_list(struct idlist **);
 void save_str_pair(struct idlist **, const char *, const char *);
 void free_str_pair_list(struct idlist **);
 int delete_str(struct idlist **, int);
-int str_in_list(struct idlist **, const char *);
+int str_in_list(struct idlist **, const char *, const flag);
 int str_nr_in_list(struct idlist **, const char *);
+int str_nr_last_in_list(struct idlist **, const char *);
+void str_set_mark( struct idlist **, const char *, const flag);
 int count_list( struct idlist **idl );
 char *str_from_nr_list( struct idlist **idl, int number );
 char *str_find(struct idlist **, int);
@@ -276,12 +335,21 @@ void write_saved_lists(struct query *, const char *);
 
 /* rcfile_y.y */
 int prc_parse_file(const char *, const flag);
-int prc_filecheck(const char *);
+int prc_filecheck(const char *, const flag);
 
 /* base64.c */
 void to64frombits(unsigned char *, const unsigned char *, int);
 int from64tobits(char *, const char *);
 
+/* unmime.c */
+/* Bit-mask returned by MimeBodyType */
+#define MSG_IS_7BIT       0x01
+#define MSG_IS_8BIT       0x02
+#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);
+
 /* interface.c */
 void interface_parse(char *, struct hostdata *);
 void interface_note_activity(struct hostdata *);
@@ -306,8 +374,7 @@ int doETRN (struct query *);
 
 /* miscellanea */
 struct query *hostalloc(struct query *); 
-int parsecmdline (int, char **, struct query *);
-void optmerge(struct query *, struct query *);
+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));
@@ -315,10 +382,29 @@ char *getpassword(char *);
 void escapes(const char *, char *);
 char *visbuf(const char *);
 char *showproto(int);
+void dump_config(struct runctl *runp, struct query *querylist);
+int is_host_alias(const char *, struct query *);
+#ifdef SDPS_ENABLE
+char *sdps_envto;
+#endif /* SDPS_ENABLE */
 
 void yyerror(const char *);
 int yylex(void);
 
+#ifdef __EMX__
+void itimerthread(void*);
+/* Have to include these first to avoid errors from redefining getcwd
+   and chdir.  They're re-include protected in EMX, so it's okay, I
+   guess.  */
+#include <stdlib.h>
+#include <unistd.h>
+/* Redefine getcwd and chdir to get drive-letter support so we can
+   find all of our lock files and stuff. */
+#define getcwd _getcwd2
+#define chdir _chdir2
+#endif
+
 #define STRING_DISABLED        (char *)-1
+#define STRING_DUMMY   ""
 
 /* fetchmail.h ends here */