Table of Contents

Connectors documentation

local

no additionnal fields and settings are required for this connector. Mailcleaner will store credentials in its own database. In order to create accounts, use the “Manage by user” option from the administrative menu. Enter the username desired, choose the corresponding domain and click on the arrow button. You will then be presented with the user settings panel where you can set a password and add addresses to the account.

imap

this connector will authenticate users against an IMAP server.

pop3

this connector will authenticate users against a POP3 server.

ldap/Active Directory

this connector will authenticate users against any LDAP compliant service. This may be also used with an Active Directory or Microsoft Exchange server.

radius

this connector will authenticate users against a Radius server.

username formatters

These settings give you more control on the way the login name is send to the authentication server once they have been entered by the user. Think of these as “login rewriters”. This may be usefull when user must give their domain name to Mailcleaner (for multi-domain installation for exemple), but must be authentified only with their short login name to the authentication server.

username

only the local part of the username is passed to the authentication server. For exemple, if the user type its mail address as its mailcleaner username, then only the part before the @ sign will be sent. E.g. for myuser@mydomain.com, then myuser will be sent to the authentication server configured for the domain mydomain.com.

username@domain

this one will “build” the login name based on the local part and the domain. joining them with an ”@” sign. This may be usefull if you want your user to log in only with their shortname, but the full address is needed for authentication.

username%domain

this is the same as username@domain, but instead of a ”@” sign, a ”%” sign is used. Some IMAP server may need this kind of schema for correct authentication.

address fetchers

these settings let you choose the way MailCleaner can add email addresses or aliases to the user account. There are basically two type of them. Those which can retrieve the information from a database or directory, and those which can only “build” an address from the username. Remember that users can still add or remove these address from within their interface.

add domain

this one will build the address from the username. Appending the domain as if the username was the local part of the address.

ldap lookup

this one will retrieve different addresses and aliases belonging to the user from the LDAP/Active Directory configured in the connector section.

textfile lookup

this one will retrieve the address from a text file present on the MailCleaner server. The file should be present in /var/mailcleaner/spool/mailcleaner/addresses/domainname and containg one username and address pair per line, separated by a coma.

add a parameter

this one will act just as the “add domain”, but will replace the domain with an arbitrary string. This fectcher is not yet fully functionnal.

sql lookup

this one will fetch the addresses from the database configured in the connector.

local

this one will retrieve addresses and aliases informations from the internal MailCleaner database.