Restricting Imap

Some users have reported a problem where Zoë attempts to read and index content outside of the users IMAP account. While this behaviour is likely the result of a poorly configured email server, you can restrict Zoë in a one of two ways.

(NB: The default configuration for the WU imapd is to allow full access to the file system, including root "/", user directories, and the parent directory above the home. This is explained in the imap distribution. It can be easily changed, if desired.)

Account Settings

See System Configuration/Email Accounts for information regarding how to change these settings.

In the ACCOUNTS page of your email account, suffix the IMAP server's hostname with a slash followed by the prefix name, if applicable. This will limit IMAP requires to just the specified subfolder with respect to the user's home on the server.

eg.

imap.myisp.com/mail.

Configuration File

See System Configuration/Config Files for information regarding configuration files in general.

A more flexible way of restricting which IMAP folders to fetch was introduced in version 0.4.9:


  1. Create a plain text file named user@host.plist under $ZOEDIR/Library/SZ/Configurations/Default/.
    For example, if your IMAP user name is joe and your IMAP server hostname is mail.bloggs.com, the file name would be named joe@mail.bloggs.com.plist.
  2. In this file, list the folders you are interested in. According to http://article.gmane.org/gmane.mail.zoe.general/3636 the file is PL format of the form:
    { "folder1" = "true"; "folder2" = "false" }
  3. The special folder named "Inbox" can also be used.
  4. Full paths should be specified, which means, e.g., "top/subfolder". Even if you specify a prefix in your IMAP server name (see above), you still must specify the prefix in this file. E.g. "prefix/folder".

Only the IMAP folders listed will be considered instead of trying to "discover" everything that your server has. Specified folders will be indexed. If a value of "true", then the folder will be recursively searched.

Escape Rules from http://java.sun.com/j2se/1.4.2/docs/api/java/util/Properties.html#load(java.io.InputStream) apply, i.e. escape a space with a slash, like so '\ '

Questions

Can mail folders be excluded by specifing
ThirdFolder=false
in the properties config file?


How do you specify to search your entire imap folder EXCEPT for one mail folder?


The Zoe tar ball (v0.5.8) does not contain a Library/SZ/Configurations/Default directory. Do you need to create this, or has it moved?