IMFilter V2.0 Quick Reference

Index
License
Details
Quick Reference
FAQ

Calling IMFILTER from other programs, .CMDs, or .BATs...

IMFILTER sets the error level to 0 on success and 1 when an error has occurred.

Errors are sent to stdERR
Informational messages are sent to stdOUT

Filter Processing Mode...

FILES & DIRECTORIES

You must create at least one directory where you can store your "Rule Set". This directory should contain your RULES.IMA file, and optionally a number of .FWD files. The RULES.IMA file will be propagated to the top level directories of each mail domain and the .FWD files will be copied to the individual user directories.

This directory, we will call your SourceDirectory, may also contain the following files with their special purposes. You may put the IMFILTER.EXE file in this directory also, but it is not necessary.

Note: In both of these files, you may insert comments by beginning a line with a pound sign (#), and all blank lines are ignored.

DOMAINS.LST

Contains a list of top level domain directories. This is useful when you want to launch IMFILTER from a machine other than your mail server. NOTE: When using the DOMAINS.LST file to process your domains, you gain some important flexibility but some other options may not operate properly such as those based on the EXCLUDE.LST file. This is because there is some important information about domains that can only be reliably gathered from the registry.

EXCLUDE.LST

Contains a list of user addresses, domain names, and directory paths which should be excluded from mail filtering. When a domain or directory is excluded, neither the RULES.IMA file nor the .FWD files will be propagated. When a user is excluded, they will not receive the .FWD files so filtered mail will be stored in sub-boxes under their main mailbox as defined in the domain's RULES.IMA file.

IMFILTER [-registry] [-threads:N] [-cleanup] [-scrub] [-wipedel] [-verbose] SourceDirectory

-registry

Use IMail's registry entries to locate domain directories for processing. This option must be used from the server where IMail resides.

-threads:N

Adjust the number of threads to be used by IMFILTER. The default is 5. This number (N) can be anywhere between 1 and 100. We recommend that you do not use this option without a good reason.

-cleanup

Remove filters that have been previously installed from any users who have been added to the EXCLUDE.LST file.

-scrub

Removes .MBX, .SRT, and .UID files with the same name as .FWD files that are part of the current Rule Set. USE CAUTION!

-wipedel

Removes user directories and contents with the .DEL extension.

-verbose

Output additional messages.

SourceDirectory

Directory path containing the Rule Set to be processed by IMFilter.

Domain List Mode...

IMFILTER -makedomainlst [-suppress#] ListFilePathName

-makedomainlst

Uses IMFILTER to extract a DOMAINS.LST file from the registry for editing.

-suppress#

Eliminates domain name comments from the output file.

ListFilePathName

Output file name.