#!/usr/bin/python # # A GUI configurator for generating Fetchmail configuration files. from Tkinter import * from Dialog import * import sys import time import os import string # # Define the data structures the GUIs will be tossing around # class Controls: def __init__(self): self.foreground = FALSE # Run in background self.daemon = 300 # Default to 5-minute timeout self.syslog = FALSE # Use syslogd for logging? self.logfile = None # No logfile, initially self.invisible = FALSE # Suppress Received line & spoof? def __repr__(self): str = ""; if self.syslog: str = str + ("set syslog\n") elif self.logfile: str = str + ("set logfile \"%s\"\n" % (self.logfile,)); if not self.foreground and self.daemon: str = str + ("set daemon %s\n" % (self.daemon,)) return str + "\n" def __str__(self): return "[Server: " + repr(self) + "]" class Server: def __init__(self): self.pollname = None # Poll label self.via = None # True name of host self.active = TRUE # Poll status self.interval = 0 # Skip interval self.protocol = 'auto' # Default to auto protocol self.port = 0 # Port number to use self.uidl = FALSE # Don't use RFC1725 UIDLs by default self.auth = 'password' # Default to password authentication self.timeout = 300 # 5-minute timeout self.envelope = 'Received' # Envelope-address header self.qvirtual = '' # Name prefix to strip self.aka = [] # List of DNS aka names self.dns = TRUE # Enable DNS lookup on multidrop self.localdomains = [] # Domains to be considered local self.interface = None # IP address and range self.monitor = None # IP address and range self.userlist = [] # List of user entries for site self.typemap = ( ('pollname', 'String'), ('via', 'String'), ('active', 'Boolean'), ('interval', 'Int'), ('protocol', 'String'), ('interval', 'Int'), ('port', 'Int'), ('uidl', 'Boolean'), ('auth', 'String'), ('timeout', 'Int'), ('envelope', 'String'), ('qvirtual', 'String'), # leave aka out ('dns', 'Boolean'), # leave localdomains out ('interface', 'String'), ('monitor', 'String')) def dump(self, folded): str = "" if self.active: str = str + "poll" else: str = str + "skip" str = str + (" " + self.pollname) if self.via != self.pollname: str = str + " via " + self.via if self.protocol != ServerDefaults.protocol: str = str + " with proto " + self.protocol if self.port != defaultports[self.protocol]: str = str + " port " + `self.port` if self.timeout != ServerDefaults.timeout: str = str + " timeout " + `self.timeout` if self.interval != ServerDefaults.interval: str = str + " interval " + `self.interval` if self.envelope != ServerDefaults.envelope: str = str + " envelope " + self.envelope if self.qvirtual != ServerDefaults.qvirtual: str = str + " qvirtual " + self.qvirtual if self.auth != ServerDefaults.auth: str = str + " auth " + self.auth if self.dns != ServerDefaults.dns or self.uidl != ServerDefaults.uidl: str = str + " and options" if self.dns != ServerDefaults.dns: str = str + flag2str(self.dns, 'dns') if self.uidl != ServerDefaults.uidl: str = str + flag2str(self.uidl, 'uidl') if folded: str = str + "\n\t" else: str = str + " " if self.aka: str = str + "aka" for x in self.aka: str = str + " " + x if self.aka and self.localdomains: str = str + " " if self.localdomains: str = str + ("localdomains") for x in self.localdomains: str = str + " " + x if (self.aka or self.localdomains): if folded: str = str + "\n\t" else: str = str + " " if self.interface: str = str + " interface " + self.interface if self.monitor: str = str + " monitor " + self.monitor if (self.interface or self.monitor): if folded: str = str + "\n" if str[-1] == "\t": str = str[0:-1] return str; def __repr__(self): return self.dump(TRUE) def __str__(self): return "[Server: " + self.dump(FALSE) + "]" class User: def __init__(self): self.remote = "" # Remote username self.localnames = None # Local names self.password = "" # Password for mail account access self.folder = "" # Remote folder to retrieve from self.smtphost = 'localhost' # Host to forward to self.mda = "" # Mail Delive
README.packaging
================

fetchmail 6.3 changes relevant for packagers
--------------------------------------------

Greetings, dear packager!

The bullet points below mention a few useful hints for package(r)s:

- Please use OpenSSL and add --with-ssl to the ./configure command line.  
  SSL/TLS support hasn't been enabled in the default build in order to maintain 
  fetchmail 6.2 compatibility as far as possible.  SSL/TLS however is a highly 
  recommended compilation option.

- Fetchmail now uses automake and supports all common automake targets and 
  overrides such as "make install-strip" or "DESTDIR=..." for staging areas.

- The fetchmailconf script has been renamed to fetchmailconf.py, automake will 
  install it into Python's top-level site-packages directory and byte-compile 
  it (so you need to package or remove fetchmailconf.pyc and fetchmailconf.pyo 
  as well).

- If you want to defeat Python byte-code compilation and would rather like to 
  install fetchmailconf.py yourself, you can add

      PYTHON=:

  to the ./configure command or pass this in the environment.  This pretends 
  that no Python interpreter were installed.

- The Makefile generates a two-line "fetchmailconf" /bin/sh wrapper script that 
  executes the actual fetchmailconf.py with the python installation found at 
  configuration time, so that users can still type "fetchmailconf" rather than 
  "python fetchmailconf".

- Note that fetchmailconf.py supports a few command line arguments, so if you 
  use local wrapper scripts, be sure they pass on their own arguments properly. 
  Remember to use "$@" (with quotes) in shells, not $*.

- There is now a dummy fetchmailconf manual page which will just source (roff's 
  ".so" command) the fetchmail manual page for now. You can of course keep your 
  symlinks in place and ignore this dummy. IF you install the dummy and 
  compress your man pages, be sure to test "man fetchmailconf", on some 
  systems, you'll need to adjust the ".so" command to point to the compressed 
  version.
generated by cgit v1.2.3 (git 2.39.1) at 2025-11-18 10:03:41 +0000
+ context + ' without saving?', bitmap = 'question', strings = ('Yes', 'No'), default = 1) return ans.num == 0 # # First, code to set the global fetchmail run controls. # confighelp = { 'title' : 'Fetchmail configurator help', 'banner': 'Configurator help', 'text' : """ In the `Configurator Controls' panel, you can: Press `Save' to save the new fetchmail configuration you have created. Press `Quit' to exit without saving. Press `Help' to bring up this help message. In the `Configurator Controls' panel, you can set the following options that control how fetchmail runs: Poll interval Number of seconds to wait between polls in the background. Ignored if the `Run in Foreground?' option is on. Logfile If empty, emit progress and error messages to stderr. Otherwise this gives the name of the files to write to. This field is ignored if the "Log to syslog?" option is on. Invisible: If false (the default) fetchmail generates a Received line into each message and generates a HELO from the machine it is running on. If true, fetchmail generates no Received line and HELOs as if it were the remote site. In the `Remote Mail Configurations' panel, you can: 1. Enter the name of a new remote mail server you want fetchmail to query. To do this, simply enter a label for the poll configuration in the `New Server:' box. The label should be a DNS name of the server (unless you are using ssh or some other tunneling method and will fill in the `via' option on the site configuration screen). 2. Change the configuration of an existing site. To do this, find the site's label in the listbox and double-click it. This will take you to a site configuration dialogue. """} class ControlEdit(Frame): def PostControls(self): self.foreground = BooleanVar(self) self.foreground.set(self.controls.foreground) self.daemon = StringVar(self) self.daemon.set(`self.controls.daemon`) self.syslog = BooleanVar(self) self.syslog.set(self.controls.syslog); self.logfile = StringVar(self) if self.controls.logfile: self.logfile.set(self.controls.logfile); self.invisible = BooleanVar(self) self.invisible.set(self.controls.invisible); gf = Frame(self, relief=RAISED, bd = 5) Label(gf, text='Fetchmail Run Controls', bd=2).pack(side=TOP, pady=10) df = Frame(gf, relief=RAISED, bd=2) # Run in foreground? Checkbutton(df, {'text':'Run in foreground?', 'variable':self.foreground, 'relief':GROOVE}).pack(side=LEFT,anchor=W) # Set the poll interval de = LabeledEntry(df, ' Poll interval:', self.daemon, '14') de.pack(side=RIGHT, anchor=E) df.pack(); sf = Frame(gf, relief=RAISED, bd=2) # Use syslog for logging? Checkbutton(sf, {'text':'Log to syslog?', 'variable':self.syslog, 'relief':GROOVE}).pack(side=LEFT, anchor=W) # Set the logfile log = LabeledEntry(sf, ' Logfile:', self.logfile, '14') log.pack(side=RIGHT, anchor=E) sf.pack(fill=X) # Invisible mode? Checkbutton(gf, {'text':'Invisible mode?', 'variable':self.invisible, 'relief':GROOVE}).pack(side=LEFT, anchor=W) gf.pack(fill=X) def GatherControls(self): self.controls.daemon = self.daemon.get() self.controls.foreground = self.foreground.get() self.controls.logfile = self.logfile.get() self.controls.syslog = self.syslog.get() self.controls.invisible = self.invisible.get() # # Server editing stuff. # remotehelp = { 'title' : 'Remote site help', 'banner': 'Remote sites', 'text' : """ When you add a site name to the list here, you initialize an entry telling fetchmail how to poll a new site. When you select a sitename (by double- clicking it, or by single-clicking to select and then clicking the Edit button), you will open a window to configure that site. """} serverhelp = { 'title' : 'Server options help', 'banner': 'Server Options', 'text' : """ The server options screen controls fetchmail options that apply to one of your mailservers. Once you have a mailserver configuration set up as you like it, you can select `Save' to store it in the server list maintained in the main configuration window. If you wish to discard changes to a server configuration, select `Quit'. """} controlhelp = { 'title' : 'Run Control help', 'banner': 'Run Controls', 'text' : """ If the `Poll normally' checkbox is on, the host is polled as part of the normal operation of fetchmail when it is run with no arguments. If it is off, fetchmail will only query this host when it is given as a command-line argument. The `True name of server' box should specify the actual DNS name to query. By default this is the same as the poll name. Normally each host described in the file is queried once each poll cycle. If `Cycles to skip between polls' is greater than 0, that's the number of poll cycles that are skipped between the times this post is actually polled. The `Server timeout' is the number of seconds fetchmail will wait for a reply from the mailserver before concluding it is hung and giving up. """} protohelp = { 'title' : 'Protocol and Port help', 'banner': 'Protocol and Port', 'text' : """ These options control the remote-mail protocol and TCP/IP service port used to query this server. The `Protocol' button bar offers you a choice of all the different protocols available. The `auto' protocol is a special mode that probes the host ports for POP3 and IMAP to see if either is available. Normally the TCP/IP service port to use is dictated by the protocol choice. The `Port' field lets you set a non-standard port. """} sechelp = { 'title' : 'Security option help', 'banner': 'Security', 'text' : """ The `interface' option, if given, specifies the only device through which fetchmail is permitted to connect to servers. Specifying this may protect you from a spoofing attack if your client machine has more than one IP gateway address and some of the gateways are to insecure nets. The `monitor' option allows you to specify a range of IP addresses to monitor for activity. If these addresses are not active, fetchmail will not poll. This option may be used to prevent fetchmail from triggering an expensive dial-out if the interface is not already active. The `interface' and `monitor' options are available only for Linux systems. See the fetchmail manual page for details on these. """} multihelp = { 'title' : 'Multidrop option help', 'banner': 'Multidrop', 'text' : """ These options are only useful with multidrop mode. See the manual page for extended discussion. """} suserhelp = { 'title' : 'User list help', 'banner': 'User list', 'text' : """ When you add a user name to the list here, you initialize an entry telling fetchmail to poll the site on behalf of the new user. When you select a username (by double- clicking it, or by single-clicking to select and then clicking the Edit button), you will open a window to configure the user's options on that site. """} class ServerEdit(Frame): def __init__(self, host, sitelist, master=None): Frame.__init__(self, master) Pack.config(self) self.master.title('Fetchmail host ' + host); self.master.iconname('Fetchmail host ' + host); self.server = Server() self.server.pollname = host self.server.via = host self.sitelist = sitelist self.post() self.createWidgets(host) # self.grab_set() # self.focus_set() # self.wait_window() def post(self): # we can't abstract this away, execs would happen in the wrong scope for x in self.server.typemap: target = "self." + x[0] source = "self.server." + x[0] if x[1] == 'Boolean': exec target + " = BooleanVar(self)" if eval(source): exec target + ".set(" + source + ")" elif x[1] == 'String': exec target + " = StringVar(self)" if eval(source): exec target + ".set(" + source + ")" elif x[1] == 'Int': exec target + " = IntVar(self)" if eval(source): exec target + ".set(" + source + ")" def gather(self): for x in self.server.typemap: setattr(self.server, x[0], getattr(self, x[0]).get()) def nosave(self): if ConfirmQuit(self, 'server option editing'): Widget.destroy(self.master) def save(self): self.gather() self.sitelist.append(self.server) Widget.destroy(self.master) def refreshPort(self): proto = self.protocol.get() self.port.set(defaultports[proto]) if not proto in ("POP3", "APOP", "KPOP"): self.uidl = FALSE def createWidgets(self, host): topwin = Frame(self, relief=RAISED, bd=5) # This pushes the window past a 480 depth. # Label(topwin, text="Server options for " + host).pack(side=TOP,pady=10) Button(topwin, text='Save', fg='blue', command=self.save).pack(side=LEFT) Button(topwin, text='Quit', fg='blue', command=self.nosave).pack(side=LEFT) Button(topwin, text='Help', fg='blue', command=lambda: helpwin(serverhelp)).pack(side=RIGHT) topwin.pack(fill=X) leftwin = Frame(self); leftwidth = '25'; ctlwin = Frame(leftwin, relief=RAISED, bd=5) Label(ctlwin, text="Run Controls").pack(side=TOP) Checkbutton(ctlwin, text='Poll ' + host + ' normally?', variable=self.active).pack(side=TOP) LabeledEntry(ctlwin, 'True name of ' + host + ':', self.via, leftwidth).pack(side=TOP, fill=X) LabeledEntry(ctlwin, 'Cycles to skip between polls:', self.interval, leftwidth).pack(side=TOP, fill=X) LabeledEntry(ctlwin, 'Server timeout (seconds):', self.timeout, leftwidth).pack(side=TOP, fill=X) Button(ctlwin, text='Help', fg='blue', command=lambda: helpwin(controlhelp)).pack(side=RIGHT) ctlwin.pack(fill=X) protwin = Frame(leftwin, relief=RAISED, bd=5) Label(protwin, text="Protocol and Port").pack(side=TOP) pb = ButtonBar(protwin, '', self.protocol, protolist, 2, self.refreshPort) LabeledEntry(protwin, 'On server TCP/IP port:', self.port, leftwidth).pack(side=TOP, fill=X) Checkbutton(protwin, text="POP3: track `seen' with client-side UIDLs?", variable=self.uidl).pack(side=TOP) Button(protwin, text='Help', fg='blue', command=lambda: helpwin(protohelp)).pack(side=RIGHT) protwin.pack(fill=X) userwin = Frame(leftwin, relief=RAISED, bd=5) Label(userwin, text="User entries for " + host).pack(side=TOP) ListEdit("New user: ", None, self.edituser, userwin, suserhelp) userwin.pack(fill=X) leftwin.pack(side=LEFT, anchor=N, fill=X); rightwin = Frame(self); mdropwin = Frame(rightwin, relief=RAISED, bd=5) Label(mdropwin, text="Multidrop options").pack(side=TOP) LabeledEntry(mdropwin, 'Envelope address header:', self.envelope, '22').pack(side=TOP, fill=X) LabeledEntry(mdropwin, 'Name prefix to strip:', self.qvirtual, '22').pack(side=TOP, fill=X) Checkbutton(mdropwin, text="Enable multidrop DNS lookup?", variable=self.dns).pack(side=TOP) Label(mdropwin, text="DNS aliases").pack(side=TOP) ListEdit("New alias: ", self.server.aka, None, mdropwin, None) Label(mdropwin, text="Domains to be considered local").pack(side=TOP) ListEdit("New domain: ", self.server.localdomains, None, mdropwin, multihelp) mdropwin.pack(fill=X) secwin = Frame(rightwin, relief=RAISED, bd=5) # Pushes the window depth past 480 # Label(secwin, text="Security").pack(side=TOP) # Don't actually let users set this. KPOP sets it implicitly # ButtonBar(secwin, 'Authorization mode:', # self.auth, authlist, 1, None).pack(side=TOP) if os.popen("uname").readlines()[0] == 'Linux\n': LabeledEntry(secwin, 'Interface to check before poll:', self.interface, leftwidth).pack(side=TOP, fill=X) LabeledEntry(secwin, 'IP range to monitor:', self.monitor, leftwidth).pack(side=TOP, fill=X) Button(secwin, text='Help', fg='blue', command=lambda: helpwin(sechelp)).pack(side=RIGHT) secwin.pack(fill=X) rightwin.pack(side=LEFT, anchor=N); def edituser(self, user): UserEdit(user, self.server, Toplevel()) # # User editing stuff # userhelp = { 'title' : 'User option help', 'banner': 'User options', 'text' : """ You may use this panel to set options that may differ between individual users on your site. Note: if a site entry has more than one local user, messages will be retrieved in multidrop mode. This complicates the configuration issues; see the manual page section on multidrop mode. """} localhelp = { 'title' : 'Local name help', 'banner': 'Local names', 'text' : """ The local name(s) in a user entry are the people on the client machine who should receive mail from the poll described. Note: if a user entry has more than one local name, messages will be retrieved in multidrop mode. This complicates the configuration issues; see the manual page section on multidrop mode. """} class UserEdit(Frame): def __init__(self, user, server, master=None): Frame.__init__(self, master) Pack.config(self) self.master.title('Fetchmail user ' + user + ' querying ' + server.pollname); self.master.iconname('Fetchmail user ' + user); self.user = User() self.user.remote = user self.user.localnames = [user] self.server = server self.post() self.createWidgets() # self.grab_set() # self.focus_set() # self.wait_window() def post(self): # we can't abstract this away, execs would happen in the wrong scope for x in self.user.typemap: target = "self." + x[0] source = "self.user." + x[0] if x[1] == 'Boolean': exec target + " = BooleanVar(self)" if eval(source): exec target + ".set(" + source + ")" elif x[1] == 'String': exec target + " = StringVar(self)" if eval(source): exec target + ".set(" + source + ")" elif x[1] == 'Int': exec target + " = IntVar(self)" if eval(source): exec target + ".set(" + source + ")" def gather(self): for x in self.user.typemap: setattr(self.user, x[0], getattr(self, x[0]).get()) def nosave(self): if ConfirmQuit(self, 'user option editing'): Widget.destroy(self.master) def save(self): self.gather() self.server.userlist.append(self.user) Widget.destroy(self.master) def createWidgets(self): topwin = Frame(self, relief=RAISED, bd=5) # Label(topwin, # text="User options for " + self.user.remote).pack(side=TOP,pady=10) Button(topwin, text='Save', fg='blue', command=self.save).pack(side=LEFT) Button(topwin, text='Quit', fg='blue', command=self.nosave).pack(side=LEFT) Button(topwin, text='Help', fg='blue', command=lambda: helpwin(userhelp)).pack(side=RIGHT) topwin.pack(fill=X) leftwin = Frame(self); secwin = Frame(leftwin, relief=RAISED, bd=5) Label(secwin, text="Authentication").pack(side=TOP) LabeledEntry(secwin, 'Password:', self.password, '12').pack(side=TOP, fill=X) LabeledEntry(secwin, 'Folder(s):', self.folder, '12').pack(side=TOP, fill=X) secwin.pack(fill=X, anchor=N) names = Frame(leftwin, relief=RAISED, bd=5) Label(names, text="Local names").pack(side=TOP) ListEdit("New name: ", self.user.localnames, None, names, localhelp) names.pack(fill=X, anchor=N) targwin = Frame(leftwin, relief=RAISED, bd=5) Label(targwin, text="Forwarding Options").pack(side=TOP) LabeledEntry(targwin, 'System to forward to:', self.smtphost, '26').pack(side=TOP, fill=X) LabeledEntry(targwin, 'Connection setup command:', self.preconnect, '26').pack(side=TOP, fill=X) LabeledEntry(targwin, 'Connection wrapup command:', self.postconnect, '26').pack(side=TOP, fill=X) LabeledEntry(targwin, 'Local delivery agent:', self.mda, '26').pack(side=TOP, fill=X) targwin.pack(fill=X, anchor=N) leftwin.pack(side=LEFT, fill=X, anchor=N) rightwin = Frame(self) optwin = Frame(rightwin, relief=RAISED, bd=5) Label(optwin, text="Processing Options").pack(side=TOP) Checkbutton(optwin, text="Suppress deletion of messages after reading", variable=self.keep).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Flush seen messages before retrieval", variable=self.flush).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Fetch old messages as well as new", variable=self.fetchall).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Rewrite To/Cc/Bcc messages to enable reply", variable=self.rewrite).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Force CR/LF at end of each line", variable=self.forcecr).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Strip CR from end of eacgh line", variable=self.stripcr).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Pass 8 bits even theough SMTP says 7BIT", variable=self.pass8bits).pack(side=TOP, anchor=W) Checkbutton(optwin, text="Drop Status lines from forwarded messages", variable=self.dropstatus).pack(side=TOP, anchor=W) optwin.pack(fill=X) limwin = Frame(rightwin, relief=RAISED, bd=5) Label(limwin, text="Resource Limits").pack(side=TOP) LabeledEntry(limwin, 'Message size limit:', self.limit, '30').pack(side=TOP, fill=X) LabeledEntry(limwin, 'Max messages to fetch per poll:', self.fetchlimit, '30').pack(side=TOP, fill=X) LabeledEntry(limwin, 'Max messages to forward per poll:', self.batchlimit, '30').pack(side=TOP, fill=X) LabeledEntry(limwin, 'Interval between expunges (IMAP):', self.expunge, '30').pack(side=TOP, fill=X) limwin.pack(fill=X) rightwin.pack(side=LEFT) # # Configure drives the configuration dialogue. It may call multiple # instances of ServerEdit to do its job. # class Configure(Frame, ControlEdit): def __init__(self, master=None): Frame.__init__(self, master) self.master.title('fetchmail configurator'); self.master.iconname('fetchmail configurator'); Pack.config(self) self.MakeDispose() self.controls = Controls() self.PostControls() self.MakeSitelist(master) self.sites = [] def MakeDispose(self): # Set the disposal of the given configuration dispose = Frame(self, relief=RAISED, bd=5); Label(dispose, text='Configurator Controls', bd=2).pack(side=TOP, pady=10) Button(dispose, text='Save', fg='blue', command=self.save).pack(side=LEFT) Button(dispose, text='Quit', fg='blue', command=self.nosave).pack(side=LEFT) Button(dispose, text='Help', fg='blue', command=lambda: helpwin(confighelp)).pack(side=RIGHT) dispose.pack(side=TOP, fill=X); def MakeSitelist(self, master): lf = Frame(master, relief=RAISED, bd=5) Label(lf, text='Remote Mail Server Configurations', bd=2).pack(side=TOP, pady=10) ListEdit('New Server:', None, self.editsite, lf, remotehelp) lf.pack(fill=X) def editsite(self, site): ServerEdit(site, self.sites, Toplevel()) def save(self): self.GatherControls() sys.stdout.write("# Configuration created %s\n" % time.ctime(time.time())) sys.stdout.write(`self.controls`) for site in self.sites: sys.stdout.write(`site`) for user in site.userlist: sys.stdout.write(`user`) sys.stdout.write("\n") self.quit() def nosave(self): if ConfirmQuit(self, "configuration editor"): self.quit() if __name__ == '__main__': ServerDefaults = Server() UserDefaults = User() Configure().mainloop() # The following sets edit modes for GNU EMACS # Local Variables: # mode:python # End: