Mailmanのソースを表示

[[Category:メール]]
[[Category:メールサーバー]]
[[en:mailman]]
[https://gitlab.com/mailman/mailman Mailman] はメーリングリスト管理システムです。[[メールサーバー]]と組み合わせて使用します。

== インストール ==

{{Pkg|mailman3}} パッケージを[[インストール]]します。

{{Note|{{Pkg|mailman3}} は近い将来 {{Pkg|mailman}} に置き換わる予定です。両方のアプリケーションが {{ic|/var/lib/mailman}} をステートディレクトリ、{{ic|mailman}} ユーザーとして使うので、現在衝突していて、一緒にインストールすることはできません。}}

Mailman は [[Postorius]] (設定用) と [[Hyperkitty]] (アーカイブ用)と一緒に使うことができます。

{{Note|''Mailman'' は専用の {{ic|mailman}} ユーザーとして実行されます。したがって、{{ic|mailman}} 実行ファイルは、{{ic|mailman}} ユーザーとして実行する必要があります。}}

== 設定 ==

Mailman の設定はすべて {{ic|/etc/mailman.cfg}} で行われます。全ての可能な設定オプションとデフォルトの設定を説明するスキーマは {{ic|/usr/lib/python3.8/site-packages/mailman/config/schema.cfg}} に格納されています。

また、コマンドラインからも設定にアクセスすることができます。{{ic|mailman}} ユーザーとして (例: [[sudo]] や [[su]] を使って) 以下のコマンドを実行します。

 [mailman]$ mailman conf

=== データベース ===

Mailman はデフォルトで、{{ic|/var/lib/mailman/data/ の [[SQLite]] [https://mailman.readthedocs.io/en/latest/src/mailman/docs/database.html データベース] を使用します。}} ですが、[[MariaDB]] または [[PostgreSQL]] を使用するように設定できます。

==== SQLite ====

[[SQLite]] データベースのデフォルトの場所はすでに {{ic|schema.cfg}} に反映されているため、Mailman で設定する必要はありません。

{{hc|/etc/mailman.cfg|
[database]
url: sqlite:////var/lib/mailman/data/mailman.db
}}

==== MariaDB ====

{{Pkg|python-pymysql}} パッケージを [[インストール]] し、[[MariaDB]] にデータベースを設定します。

{{hc|/etc/mailman.cfg|2=
[database]
class: mailman.database.mysql.MySQLDatabase
url: mysql+pymysql://''myuser'':''mypassword''@''mymysqlhost''/mailman?charset=utf8&use_unicode=1
}}

==== PostgreSQL ====

{{Pkg|python-psycopg2}} パッケージを [[インストール]] し、[[PostgreSQL]] を使用してデータベースを作成します。

{{hc|/etc/mailman.cfg|
[database]
class: mailman.database.postgresql.PostgreSQLDatabase
url: postgres://''myuser'':''mypassword''@''mypghost''/mailman
}}

=== REST API ===

Mailman は、設定の {{ic|[webservice]}} セクションの設定に基づいて REST API を公開します。{{ic|admin_user}} と {{ic|admin_pass}} のデフォルト値を必ず置き換えてください (以下の例の値は使用しないでください)

{{hc|/etc/mailman.cfg|
[webservice]
admin_user: my_new_admin_user_name
admin_pass: my_new_admin_user_password
}}

=== ARC ===

デフォルトでは、[[Wikipedia:ja:DMARC|DMARC]] および [[Wikipedia:ja:DKIM|DKIM]] は無効になっています。設定は、設定ファイルの {{ic|[ARC]}} セクションで行われます。必ず必要な値を設定し、デフォルトに関するドキュメントを読んでください。

{{hc|/etc/mailman.cfg|
[ARC]
enabled: yes
authserv_id: mailserver.tld
trusted_authserv_ids: subdomain.mailserver.tld, other.mailserver.tld
privkey: /path/to/privatekey.pem
selector: test
domain: mailserver.tld
}}

=== MTA ===

To connect a mail-transfer-agent (MTA), it is necessary to configure the {{ic|[mta]}} section in the configuration file. [https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html Upstream documentation] covers examples for [[postfix]], [[exim]] and [[sendmail]], but other MTAs are technically possible.

==== Postfix ====

To connect to a local [[postfix]] instance the following configuration section can be used:

{{hc|/etc/mailman.cfg|
[mta]
incoming: mailman.mta.postfix.LMTP
outgoing: mailman.mta.deliver.deliver
lmtp_host: mail.example.com
lmtp_port: 8024
smtp_host: mail.example.com
smtp_port: 25
}}

The [[postfix]] configuration has to be extended to ensure compatibility (see [https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html#basic-postfix-connections upstream notes]).

{{hc|/etc/postfix/main.cf|
<nowiki>
[..]
recipient_delimiter = +
unknown_local_recipient_reject_code = 550
owner_request_special = no
[..]
</nowiki>
}}

Additionally, [[postfix]] needs to be made aware of mailman's [https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html#transport-maps transport maps]. Depending on the postfix configuration these may look similar to the following.

{{Note| The following examples assume that existing values for {{ic|transport_maps}}, {{ic|local_recipient_maps}}, {{ic|relay_domains}}, {{ic|virtual_mailbox_domains}} and {{ic|virtual_alias_maps}} are merged with the additional values.}}

{{hc|/etc/postfix/main.cf|
<nowiki>
[..]
transport_maps = hash:/var/lib/mailman/data/postfix_lmtp
local_recipient_maps = hash:/var/lib/mailman/data/postfix_lmtp
relay_domains = hash:/var/lib/mailman/data/postfix_domains
[..]
</nowiki>
}}

If {{ic|postmap}} is not directly accessible by mailman for creating the default hash-based alias maps, it is possible to generate regular expression based alias maps instead.
To overwrite the default Python-class based configuration, mailman allows the use of a configuration file. Create the following file:

{{hc|/etc/postfix-mailman.cfg|
[postfix]
postmap_command: /usr/bin/postmap
transport_file_type: regex
}}

Add the file to the {{ic|[mta]}} section in mailman's configuration file.

{{hc|/etc/mailman.cfg|
[mta]
''[..]''
configuration: /etc/postfix-mailman.cfg
}}

Afterwards the {{ic|regexp}} based exports can then be used in the [[postfix]] configuration.

{{hc|/etc/postfix/main.cf|
<nowiki>
[..]
transport_maps = regexp:/var/lib/mailman/data/postfix_lmtp
local_recipient_maps = regexp:/var/lib/mailman/data/postfix_lmtp
relay_domains = regexp:/var/lib/mailman/data/postfix_domains
[..]
</nowiki>
}}

{{Note| Make sure to create the new alias maps after changing their type (e.g. from {{ic|hash}} to {{ic|regexp}}): {{ic|[mailman]$ mailman aliases}}}}

To connect to a local [[postfix]] instance with a [[Postfix#Virtual_mail|virtual mail]] setup, first [[Postorius#Set_an_Alias_Domain|set an alias domain]]. Afterwards alter the respective configuration.

{{hc|/etc/postfix/main.cf|
<nowiki>
[..]
local_recipient_maps = regexp:/var/lib/mailman/data/postfix_lmtp
transport_maps = regexp:/var/lib/mailman/data/postfix_lmtp
virtual_mailbox_domains = regexp:/var/lib/mailman/data/postfix_domains
virtual_alias_maps = regexp:/var/lib/mailman/data/postfix_vmap
[..]
</nowiki>
}}

== 起動 ==

[[Enable]] and [[start]] {{ic|mailman3.service}}.

Several [[systemd]] services with timers exist, taking care of various aspects of the list management:

* {{ic|mailman3-digests.timer}}: for sending out daily digests to subscribers
* {{ic|mailman3-gatenews.timer}}: for hourly polling of [[Wikipedia:Network News Transfer Protocol|NNTP]] servers for news
* {{ic|mailman3-notify.timer}}: for sending out daily notifications to admins about pending requests

== セットアップ ==

=== メールサーバとの統合 ===

=== Integrate with Hyperkitty ===

Mailman does not automatically archive mails on its own. The [[Hyperkitty]] web application is used for this purpose. Based on a plugin, mailman is able to send mails to a [[Hyperkitty]] instance for archival.

[[インストール]] the {{Pkg|mailman3-hyperkitty}} package and configure {{ic|/etc/mailman-hyperkitty.cfg}}.

{{hc|/etc/mailman-hyperkitty.cfg|
[general]
base_url: https://example.tld/hyperkitty/
api_key: super_secret_password
}}

Afterwards, make mailman aware of the plugin:

{{hc|/etc/mailman.cfg|
[archiver.hyperkitty]
class: mailman_hyperkitty.Archiver
enable: yes
configuration: /etc/mailman-hyperkitty.cfg
}}

== ヒントとテクニック ==

=== mailman 3.0 未満からのマイグレート ===

Mailman offers the possibility of importing mailman < 3.0 based list databases ({{ic|config.pck}}). Run the following command as the {{ic|mailman}} user (e.g. using [[sudo]] or [[su]]):

 [mailman]$ mailman import21 ''LISTSPEC'' ''PICKLE_FILE''

Here, {{ic|''LISTSPEC''}} represents a fully-qualified name of a list to import (e.g. {{ic|list@example.com}}) and {{ic|''PICKLE_FILE''}} the path to the list's {{ic|config.pck}} file.

{{Note|The mailman2 list to be imported '''must''' already exist on the target mailman instance.}}

=== REST API ===

Mailman exposes a [https://mailman.readthedocs.io/en/latest/src/mailman/rest/docs/rest.html#the-rest-server REST API], which can be interfaced using custom tooling, based on {{Pkg|python-mailmanclient}}.

== 参照 ==

* [https://mailman.readthedocs.io/en/latest/ Mailman Documentation] - The upstream documentation
* [https://mailmanclient.readthedocs.io/en/latest/ Mailmanclient Documentation] - The upstream documentation
* [https://hyperkitty.readthedocs.io/en/latest/install.html#connecting-to-mailman Connecting to Mailman] - The upstream documentation on {{Pkg|mailman3-hyperkitty}}
* [https://docs.mailman3.org/en/latest/ Mailman Suite Documentation] - The (high level) upstream documentation for the entire Mailman Suite (Mailman, Hyperkitty and Postorius)