Skip to content

Mailman

services.mailman.enable

Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix). Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.enablePostfix

Enable Postfix integration. Requires an active Postfix installation.

If you want to use another MTA, set this option to false and configure settings in services.mailman.settings.mta.

Refer to the Mailman manual for more info.

Type: boolean

Default

true

Example

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.extraPythonPackages

Packages to add to the python environment used by mailman and mailman-web Type: list of package

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.hyperkitty.baseUrl

Where can Mailman connect to Hyperkitty's internal API, preferably on localhost?

Type: string

Default

"http://localhost:18507/archives/"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.hyperkitty.enable

Whether to enable the Hyperkitty archiver for Mailman. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.attrMap.email

LDAP-attribute that corresponds to the email-attribute in mailman.

Type: string

Default

"mail"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.attrMap.firstName

LDAP-attribute that corresponds to the firstName-attribute in mailman.

Type: string

Default

"givenName"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.attrMap.lastName

LDAP-attribute that corresponds to the lastName-attribute in mailman.

Type: string

Default

"sn"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.attrMap.username

LDAP-attribute that corresponds to the username-attribute in mailman.

Type: string

Default

"uid"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.bindDn

Service account to bind against.

Type: string

Example

"cn=root,dc=nixos,dc=org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.bindPasswordFile

Path to the file containing the bind password of the service account defined by .

Type: string

Example

"/run/secrets/ldap-bind"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.enable

Whether to enable LDAP auth. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.groupSearch.ou

Organizational unit to look up a group.

Type: string

Example

"ou=groups,dc=nixos,dc=org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.groupSearch.query

Query to find a group associated to a user in the LDAP database.

Type: string

Example

"(objectClass=groupOfNames)"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.groupSearch.type

Type of group to perform a group search against.

Type: one of "posixGroup", "groupOfNames", "memberDNGroup", "nestedMemberDNGroup", "nestedGroupOfNames", "groupOfUniqueNames", "nestedGroupOfUniqueNames", "activeDirectoryGroup", "nestedActiveDirectoryGroup", "organizationalRoleGroup", "nestedOrganizationalRoleGroup"

Default

"posixGroup"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.serverUri

LDAP host to connect against.

Type: string

Example

"ldaps://ldap.host"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.superUserGroup

Group where a user must be a member of to gain superuser rights.

Type: null or string

Default

null

Example

"cn=admin,ou=groups,dc=nixos,dc=org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.userSearch.ou

Organizational unit to look up a user.

Type: string

Example

"ou=users,dc=nixos,dc=org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.ldap.userSearch.query

Query to find a user in the LDAP database.

Type: string

Example

"(&(objectClass=inetOrgPerson)(|(uid=%(user)s)(mail=%(user)s)))"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.restApiPassFile

Path to the file containing the value for MAILMAN_REST_API_PASS.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.serve.enable

Whether to enable automatic nginx and uwsgi setup for mailman-web. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.serve.virtualRoot

Path to mount the mailman-web django application on.

Type: string

Default

"/"

Example

/lists

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.settings

Settings for mailman.cfg Type: attribute set of attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.siteOwner

Certain messages that must be delivered to a human, but which can't be delivered to a list owner (e.g. a bounce from a list owner), will be sent to this address. It should point to a human.

Type: string

Example

"postmaster@example.org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.webHosts

The list of hostnames and/or IP addresses from which the Mailman Web UI will accept requests. By default, "localhost" and "127.0.0.1" are enabled. All additional names under which your web server accepts requests for the UI must be listed here or incoming requests will be rejected.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.webSettings

Overrides for the default mailman-web Django settings.

Type: attribute set

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix

services.mailman.webUser

User to run mailman-web as

Type: string

Default

"mailman-web"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/mailman.nix