Mailfilter - Development

Mailfilter Development

How to Submit Code:

Step 1: Get the Code

Mailfilter's code and web pages are kept in an online repository at Github. Hence, all changes you may want to submit should be made against the respective working copy in that repository. You can obtain the latest source via the following command:

git clone https://github.com/nondeterministic/mailfilter

Step 2: Please respect our Coding Standard

Format your code such that no line is longer than 80 characters.
Source code should always be printable (although versions < 0.7 do not obey to this restriction either).
Most of Mailfilter's code is C++, parts are pure C. Try to use C++ as well, e.g. avoid C-style comments "/* ... */" in favour of "// ... ".
Variable names are "file_pointer", rather than "filePointer".
Pointers are "char* pt", rather than "char *pt".
Function calls are "function_call ()", rather than "function_call()", i.e. notice the space.

Indentation:

// Always indent like this:
if (...)
  {
    function ();
  }
else
  {
    another_function ();
  }

// Please do NOT indent like this:
if (...) {
  function ();
}
else {
  another_function ();
}

Step 3: Submitting a patch

When mailfilter had an SVN-based workflow, I preferred getting code changes in terms of patches. With Github, this is no longer necessary as one can directly clone the repository, etc.

Skripts and Add-Ons:

If you have created a nifty shell skript, or any other sort of Mailfilter add-on, then please let us know. We have a contrib directory, where we ship user supplied programs. Note, however, that any submission must be made under the terms of the GNU General Public License. Please, always include a copyright notice and a "readme" file to reflect that, otherwise we are not able to regard and distribute your work.