]> Pileus Git - ~andy/fetchmail/blobdiff - fetchmail.h
Before showdots,
[~andy/fetchmail] / fetchmail.h
index 243fd623c1d4d1c06bfe8545696abd5db39dcca4..bba30e219ab938d62fef1d952f8f25e944b08841 100644 (file)
@@ -9,25 +9,33 @@
 #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
@@ -51,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 */
 
@@ -68,6 +77,7 @@
 #define                PS_SMTP         10      /* SMTP error */
 #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) */
@@ -103,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
@@ -123,7 +135,7 @@ struct idlist
 #define UID_EXPUNGED   3               /* this message has been expunged */ 
         }
        status;
-       char *id2;
+       unsigned char *id2;
     } val;
     struct idlist *next;
 };
@@ -133,16 +145,18 @@ struct query;
 struct method          /* describe methods for protocol state machine */
 {
     const char *name;          /* protocol name */
-#if INET6
+#if INET6_ENABLE
     const char *service;
-#else /* INET6 */
+    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)(int, char *);
                                /* response_parsing function */
-    int (*password_canonify)(char *, char *);
+    int (*password_canonify)(char *, char *, int);
                                /* canonicalize password */
     int (*getauth)(int, struct query *, char *);
                                /* authorization fetcher */
@@ -173,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 */
@@ -194,7 +208,7 @@ 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;
@@ -208,6 +222,7 @@ struct hostdata             /* shared among all user connections to given server */
     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;
 };
@@ -227,6 +242,7 @@ struct query
     /* per-forwarding-target data */
     struct idlist *smtphunt;   /* list of SMTP hosts to try forwarding to */
     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 */
@@ -245,24 +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 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 */
+    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? */
     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 */
@@ -283,9 +306,12 @@ struct msgblk                      /* message header parsed for open_sink() */
 
 /*
  * 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)
@@ -328,6 +354,7 @@ 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 const char *fetchmailhost;
@@ -342,9 +369,9 @@ extern char *sdps_envto;
 /* error.c: Error reporting */
 #if defined(HAVE_STDARG_H)
 void report_init(int foreground);
-void report (FILE *fp, int errnum, const char *format, ...);
+void report (FILE *fp, const char *format, ...);
 void report_build (FILE *fp, const char *format, ...);
-void report_complete (FILE *fp, int errnum, 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 report ();
@@ -373,11 +400,25 @@ 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       /* 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*, struct msgblk *, int*, int*);
@@ -392,13 +433,14 @@ void stuff_warning();
 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);
@@ -412,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 */
@@ -430,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)
@@ -453,7 +496,15 @@ char *xstrdup(const char *);
  #pragma alloca
 #endif
 #endif
-#define        xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n))) report(stderr, PS_UNDEFINED, 0, "alloca failed")
+#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 *);
@@ -468,7 +519,7 @@ 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 *);
 const char *showproto(int);
@@ -476,6 +527,7 @@ void dump_config(struct runctl *runp, struct query *querylist);
 int is_host_alias(const char *, struct query *);
 char *host_fqdn(void);
 char *rfc822timestamp(void);
+flag isafile(int);
 
 void yyerror(const char *);
 int yylex(void);