sympa [NethServer Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{page>stephdl_donate}}
===== Sympa (mailling list) =====
<wrap hi>Available for NS7</wrap> 

Sympa is an open source mailing list manager. It provides advanced features with a rich and secure web interface.

  * scalable for big mailings lists ( > 1.000.000 list members)
  * list member provisioning using LDAP, SQL or other data sources
  * various authentication method (SSO, LDAP, X509)
  * S/MIME and DKIM
  * web archive with access control, message removal etc
  * virtual hosting for service providers.
  * automatic bounce management
  * easily customizable web interface
  * SOAP interface for integration with other applications

More features [[https://www.sympa.org/overview/features|description]].

====Maintainer====
Stephane de Labrusse at [[stephdl@de-labrusse.fr]]

====Installation====
1-You need to install my repository, [[:stephdl_repository|see how to do it]]

2-You can install sympa

  yum install nethserver-sympa --enablerepo=stephdl

It will install the email stack (nethserver-mail-server) but without the rspamd antispam, You can install nethserver-mail-filter if you want to filter spam with your mailing lists.
====First access====

Once installed sympa needs to be enabled on the email domain you want to use, because of an email server you have to install either nethserver-directory (openldap) or nethserver-dc (samba AD). The ''listmaster'' of all lists/domains will be ''admin@domain.com'' if ''domain.com'' is the first domain of your server.

* Install the account provider 

<file>
yum install nethserver-directory
</file>or
<file>
yum install nethserver-dc
</file>

* Now you have to set a password to the user ''admin'' to enable it.

* The first domain of NethServer must be enabled to use the web interface  of sympa

<file>
db domains setprop domain.com SympaStatus enabled
signal-event nethserver-sympa-update
</file>

* You can go to https://domain.com/sympa and ask a first login for the ''admin@domain.com'', an email to register and create the password will be sent to ''admin@domain.com''. There is no password synchrony yet between NethServer and Sympa with LDAP.

{{::e663d88e2677cd5786e0dcea5ee1d365c015d78d.png?400|}}

* Once the password has been created with the UI of sympa, you can create a list (top menu)

{{::63a5c311e178f81fd4a2d23bfaaf5d684825058b.png?400|}}

* When the list has been created, generally I use Web forum mailing list. Messages can either be read via email (subscription) or via the web (web archives).
You need to change the default policy of email sending, default is summary (emails sent one day per week) , change it to direct (standard) (email received by the list , email forwarded)

{{::cd74e43e2d83d45e2b3751b86e0404bfb485ca3a.png?400|}}

{{::b012f8272e86fa1c07941beec4265297b948f65d_2_690x109.png?400|}}

* Then you can add members in the list directly, or if the list allow it, the users can directly subscribe themselves with the sympa UI (the account creation to subscribe is not a mandatory)

{{::0ef51e944e3135cde571ddf43bd9d736459b01c1.png?400|}}

{{::53f5451769895c483d789b4f75206e5a748c07b2_2_690x440.png?400|}}

The list of users display if the email is sent by summary or direct


Well you have plenty of settings, this is for expert and power admin: https://sympa-community.github.io/manual/admin.html

==== Add a new domain ====

You can have several lists and use several domains

<file>
list@domain.org !== list@domain.net
</file>

if you want to add a new domain to sympa, first you have to create the email domain with the server-manager of NethServer, then use the CLI to create it.

<file>
db domains setprop domain.net SympaStatus enabled
signal-event nethserver-sympa-update
</file>

Then you can go to https://domain.net/sympa, use the master listmaster (admin@domain.com) to create the lists, you can add more master listmasters or domain listmasters

<WRAP center round tip 60%>
When you use the url https://domain.net/sympa, you can see only relevant lists to domain.net, lists for domain.com will be consultable at https://domain.com/sympa
</WRAP>


====Add master listmasters====

By default ''admin@domain.com'' is the master of all list/domains you can add more master listmasters who can manage all lists/domains

<file>
config setprop sympa listmasters admin2@domain.com,fool@domain.net
signal-event nethserver-sympa-update
</file>

''admin2@domain.com'' and ''fool@domain.net'' must create themselves their accounts in the sympa UI, like we did for ''admin@domain.com''
====Add domain listmasters====

By default ''admin@domain.com'' is the master of all list/domains but you can add more domain listmasters that can manage specifically one domain

<file>
db domains setprop domain.org SympaListMasters mickey@domain.net,donald@domain.org
signal-event nethserver-sympa-update
</file>

''mickey@domain.net'' and ''donald@domain.org'' will be admins on the domain ''domain.org for all lists''

''mickey@domain.net'' and ''donald@domain.org'' must create themselves their accounts in the sympa UI, like we did for ''admin@domain.com''
====Disable a domain====

You can stop to use the WEB UI of a domain, it won't delete the list inside ''/var/lib/sympa'' but it disable the sympa url of the domain (https://domain.com/sympa). The list will continue to answer and send emails because of the file ''/etc/sympa/sympa_transport''.
Sympa writes itself inside this file, it is not a template, either close the list(s) before with the UI of sympa, or temporally comment this file and restart sympa and postfix

to close the web UI of sympa for a domain

<file>
db domains setprop domain.com SympaStatus disabled
signal-event nethserver-sympa-update
</file>

====Official manual====

https://sympa-community.github.io/manual/

====Mass mailling limits ====

Any smtp providers have a limit in terms of how many emails you can send by day/hours. For example google allows you to send 500 emails/day or 2000 emails/day if you have  a G suite account. A provider like ionos allows [[https://www.ionos.com/help/email/general-topics/what-are-the-mass-mailing-limits/|5000 emails/hours]] if your email basic account is older than 30 days. Certainly once the limit exceeded you won't be able to send emails to your list subscribers

If you plan to send a lot of emails with your lists, because you cannot exceed the limit, or seen as a spammer, think twice on your IP or your sender reputations. 

This is a howTo on all settings you need to do [[https://www.ionos.com/help/email/general-topics/what-are-the-mass-mailing-limits/|if you plan to not use a smtp provider]]

====services====

to restart sympa either do 

<file>
systemctl restart sympa wwsympa sympasoap postfix
</file>

or expand all templates and restart all services 

<file>
signal-event nethserver-sympa-update 
</file>

====Backup====

The mysql database and the folder ''/var/lib/sympa'' are included in the data backup of nethserver, after a restoration you should find back the service running, else try a 

''signal-event nethserver-sympa-update''

====Logs====

\\ check ''/var/log/maillog'' for any smtp issue
\\ check ''/var/log/sympa.log'' for issue on sympa itself
\\ check ''/var/log/messages'' for any general issue


Sympa should write to ''/var/log/sympa.log'' log file, if you can see a lot of sympa's messages in ''/var/log/messages'', restart the server after the first installation or restart rsyslog

<file>
systemctl restart rsyslog
</file>
====Bugs====

Please raise Issues on [[https://github.com/stephdl/dev/issues|github]]

{{tag>module}} {{tag>stephdl}}