iredmail-doc/en_US/howto/manage.subscribeable.mailin...

3.5 KiB

Manage subscribeable mailing lists

[TOC]

Summary

Since iRedMail-0.9.8, iRedMail integrates mlmmj as mailing list manager.

Manage subscribeable mailing lists with iRedAdmin-Pro

With iRedAdmin-Pro, you can easily manage mailing list accounts with its web UI. Screenshots of mailing list profile pages in iRedAdmin-Pro:

Profile page:

{: width="900px" }

Allow users to subscribe from web page:

{: width="900px" }

Instruction to generate a newsletter sign up form:

{: width="900px" }

Manage subscribeable mailing lists with command line tool

iRedMail integrates mlmmjadmin (a RESTful API server developed by iRedMail team) to help you manage mlmmj mailing lists, it also offers command line script /opt/mlmmjadmin/tools/maillist_admin.py for system administrators.

!!! attention

- All settings used to create or update mailing list profiles are listed on
  [mlmmjadmin API document](https://github.com/iredmail/mlmmjadmin/blob/master/docs/API.md).
- Since mlmmjadmin-3.0, it requires Python 3.

Available commands:

  • create: Create a new mailing list account with additional setting:
  • info: Show settings of an existing mailing list account
  • update: Update an existing mailing list account
  • delete: Delete an existing mailing list account
  • subscribers: Show all subscribers
  • has_subscriber: Check whether mailing list has given subscriber.
  • subscribed: Show all subscribed lists of a given subscriber.
  • add_subscribers: Add new subscribers to mailing list.
  • remove_subscribers: Remove existing subscribers from mailing list.

Examples:

  • Create a new mailing list account with additional setting:

python3 maillist_admin.py create list@domain.com only_subscriber_can_post=yes disable_archive=no

  • Get settings of an existing mailing list account

python3 maillist_admin.py info list@domain.com

  • Update an existing mailing list account

python3 maillist_admin.py update list@domain.com only_moderator_can_post=yes disable_subscription=yes

  • Delete an existing mailing list account

python3 maillist_admin.py delete list@domain.com archive=yes

  • Add new subscribers user1@gmail.com and user2@hotmail.com:
python3 maillist_admin.py add_subscribers list@domain.com user1@gmail.com user2@hotmail.com
  • List all subscribers:

python3 maillist_admin.py subscribers list@domain.com

  • Show subscribed lists of a given subscriber:

python3 maillist_admin.py subscribed subscriber@domain.com

  • Check whether mailing list has given subscriber:

python3 maillist_admin.py has_subscriber list@domain.com subscriber@gmail.com

References

See Also