How to: Create and Manage Mailing Lists 
=======================================

Mailman is a software package that may be used to manage electronic mail discussions and e-newsletter lists.

From the SiteWorx control panel, users may create, manage, and delete mailing lists, as well as manage access 
and subscription services. 

.. contents::

Enabling Access to Mailman for SiteWorx Accounts
-------------------------------------------------

In order for Mailman to be accessible within SiteWorx, it must first be enabled for the SiteWorx account via
the SiteWorx Account Management settings form within NodeWorx. This can be performed either during account 
creation, or by editing the form after the fact. 

.. note::

   Enabling Mailman access for the SiteWorx account is a NodeWorx-level task, and therefore can only be performed
   by a system administrator. 

   SiteWorx users who do not see Mailman listed as an option in SiteWorx should contact their hosting provider
   to be granted access. 

#. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)
#. Navigate to **SiteWorx > Accounts**
#. Click the **Pencil Icon** next to the SiteWorx account
#. Under Package Options, select **Yes** from the Mailman Enabled dropdown
#. Click **Save**

.. image:: /images/mailman-account-permission.png
   :alt: SiteWorx account manage form 

Creating a Mailing List
-----------------------

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Hosting Features > Email > Mailing Lists** 
#. Click **+**. This opens the Add Mailing List form 
#. Update the required fields:

   - `List Name`: The name of the new mailing list
   - `Password`: Required to access the admin interface of the mailing list
   - `Confirm Password` 

#. Select the **Access Type** from the Access Type dropdown

   - There are two default access types available--Public and Private. Access type settings can be 
     refined after creating the list. See the Access Types section, below, for more detailed information.

.. image:: /images/mailman-create-list.png
   :alt: mailman create mailinglist form

Access Types
------------

When creating a new mailing list, two default Access Type options are provided--Public and Private.

- **Public**: Sets the list to be publicly advertised
   
   - List archives are publicly available
   - Subscribe policy requires email confirmation for new members

- **Private**:  Sets the list to not be publicly advertised 

   - List archives are not publicly available
   - New members are subject to admin approval

Managing Access Types
^^^^^^^^^^^^^^^^^^^^^^

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Hosting Features > Email > Mailing Lists** 
#. Click the **Access Type**. This is the long button that says either Public or Private under the Access Type
   header. This opens the Edit Mailing List Settings form
#. Select the desired settings for the provided options

   - **Archive List Privacy**: Sets whether the archives are publicly available
   - **Advertise this list**: Sets if the list is reported when a lists request is sent to listname-requests@domain.tld
   - **Subscribe Policy**: Sets the rules to approve a new subscriber

#. Click **Update**

.. image:: /images/access-types.png
   :alt: mailman access types


Managing a Mailing List
-----------------------

.. note::

   Detailed information on managing Mailman mailing lists can be found `here <https://www.gnu.org/software/mailman/docs.html>`__

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Hosting Features > Email > Mailing Lists** 
#. Click the **Pencil icon**. This opens the Mailinglist Administrator Authentication page in a new tab
#. Update the `List Administrator Password` field  
#. Click **Let Me In**

.. image:: /images/mailman-manage.png
   :alt: manage mailing list icon


Changing a Mailing List Password
--------------------------------

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Hosting Features > Email > Mailing Lists** 
#. Click the **Lock icon**. This opens the Update List Password form
#. Update the `Change Password` and `Confirm Password` fields with the new desired password

   - Alternately, clicking the **Magic Wand** icon will automatically generate a new password

#. Click **Update**

.. image:: /images/mailman-siteworx-password.png
   :alt: change mailing list password icon

.. image:: /images/mailman-sw-change-password.png
   :alt: update list password form

Deleting a Mailing List
-----------------------

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Hosting Features > Email > Mailing Lists**  
#. Click the **Trashcan icon**. This opens the Confirm Deletion form
#. Click **Delete** 

.. image:: /images/mailman-siteworx-delete.png
   :alt: delete mailinglist icon

.. image:: /images/mailman-confirm-delete.png
   :alt: confirm delete form