mail.medic.chalmers.se
Förstasidan-Technical info-Sicconfd

Main command: domain

Handles domains, e.g. to bind mailaddresses to recipients

General operations

Create/destroy domains

> domain domain create
Super users
Creates a new domain on the mail server. The newly created domain has no administrators, no addresses, no nothing. Always add at least one administrator after the domain has been created.
> domain domain destroy
Super users
Destroys a domain. Erases all configuration data pertaining to the domain, permanently, including all pointers to it in other parts of the configuration data.

Customer identifier

The customer identifier has no function as such. It can be set and retrieved, and its purpose is to have information for billing and similar purposes.

> domain domain customer set string
Super users
Sets a customer identifier. It has no technical relevance.
> domain domain customer get
Super users
Returns the customer identifier for the domain.

Administrators

Administrators has privileges to do (almost) anything to a domain, certain mailing lists and certain users. Only trusted people should be administrators for domains.

Change the administrator list

A domain administrator can't remove himself from the administrator list. A domain administrator can remove someone else from the administrator list. So in order to get yourself removed as an administrator for a domain, you need to add someone else and get that someone to remove you.

This prevents people from doing the switch from one administrator to another in the wrong order (remove yuorself, find out you can't add the new administrator), and it also gives the new administrator a reason to use the system (to remove the old administrator).

It also prevents ownerless domains.

> domain domain admins add user
Domain administrators
Add user to the list of administrators for domain
> domain domain admins del user
Domain administrators
Delete user from the list of administrators for domain

Retrieve administrator list

> domain domain admins get
Domain administrators
Returns a newline-separated list of all members of the domains administrator list.

Adress handling

An address first has to be created, thereafter you can bind it to recipients in the form of users, mailing lists or external mail addresses.

Certain addresses are created automatically, and can't be created manually, nor can you add or remove recipients from them.

Create/destroy addresses

You can't create addresses with localpart postmaster or abuse since they're created automatically and will be delivered to domain administrators.

Addresses ending with -request or starting with owner- can't be created, since they're automatically bound to the administrators of mailing lists with addresses in the domain (if foo@domain.com is bound to a mailing list, foo-request@domain.com and owner-foo@domain.com will be delivered to the administrators for that mailing list.

> domain domain address localpart create
Domain administrators
Creates the mail address localpart@domain. Initially it isn't bound to any recipient, and therefor can't receive mail.
> domain domain address localpart destroy
Domain administrators
Removes all data relating to a certain address, including what recipients it had. After removal, it can't be determined if a certain address has existed before or not. If you want to stop the address from being created again, quarantine it.

Adress quarantine

Addresses can be quarantined. A quarantined address can't had recipients added to it, nor can a new address with the same localpart be created. Mail can't be sent to it.

The purpose is to prevent certain addresses from being created, despite the fact that they're not being delivered to anyone.

> domain domain address localpart quarantine set
Domain administrators
Quarantines the address. All data remains, but you can no longer send mail to it. This should always be the first step before removing a mail address, since it prevents you from creating a new, identical address. Leave the mail address quarantined for some time before removing it comlpetely.
> domain domain address localpart quarantine unset
Domain administrators
Reactivates a quarantined mail address. Fully restores the address to the state prior to being quarantined.

Recipients for a certain address

Once an address has been created, you bind it to one or more recipients. The recipient can be users, mailing lists or external mail addresses.

It's unsuitable to bind an address directly to three or more recipients and/or external mail addresses. The preferred way is to create a mailing list with them as members, and bind the address to that list.

Binding more than 25 recipients directly to a mail address hasn't been tested, although it should work in theory. Mailing lists are much easier to use, though, and scales much better (no upper limit known).

Users

> domain domain address localpart users add user [user ...]
Domain administrators
Adds one or more users to the list of recipients for mails sent to localpart@domain. Returns an error if all of the stated users were members of the list.
> domain domain address localpart users del user [user ...]
Domain administrators
Removes one or more users to the list of recipients for mails sent to localpart@domain, stopping them from receiving mail for that address. Returns an error if none of the stated users were members of the list.
> domain domain address localpart users get
Domain administrators
Returns a newline separated list of all users who are recipients for the indicated address. To see all recipients, use domain domain address get.

Mailing lists

When an address localpart@domain is bound to a mailing list, localpart-request@domain and owner-localpart@domain are implicitly created.

localpart@domain is deilvered to the members of the lists that are bound to that address.

localpart-request@domain and owner-localpart@domain are delivered to the administrators for the lists bound to the address. The -request address is meant for external questions to the administrators, owner- address gets all list bounces.

> domain domain address localpart maillists add listname [listname ...]
Domain administrators
Adds one or more mailing lists as recipients for mail sent to localpart@domain. A mail delivered to a mailing list is sent to all users and mail addresses who are members of the ilst. This command differs from adding these recipients directly to the address by making it possible to have regular users responsible for membership of the mailing list. Returns an error if all of the stated users were members of the list.
> domain domain address localpart maillists del listname [listname ...]
Domain administrators
Removes one or more mailing lists as recipients of mail sent to localpart@domain. Returns an error if none of the stated users were members of the list.
> domain domain address localpart maillists get
Domain administrators
Returns a newline separated list of all mailing lists that are recipients for the stated address. To see all recipients, use domain domain address get.

External mail addresses

> domain domain address localpart emails add email [email ...]
Domain administrators
Adds one more more external mail addresses as recipients for mail sent to localpart@domain. Avoid using this command to bind to mail addresses within this mail server. Instead, create a mailing list and let both adresses deliver to it. Returns an error if all of the stated mail addresses were recipients of the local address.
> domain domain address localpart emails del email [email ...]
Domain administrators
Removes one or more external mail addresses from receiving mail to localpart@domain. Returns an error if none of the stated mail addresses were recipients of the local address.
> domain domain address localpart emails get
Domain administrators
Returns a newline separated list of all external mailaddresses that receives the stated local address. To see all recipients, use domain domain address get.

List all recipients

> domain domain address localpart get
Domain administrators
Returns a list of all recipients for the stated address.
> domain domain address localpart get csv
Domain administrators
Returns a list of all recipients for the stated address as CSV. Format:
 address:
 1  * domain=<domain>
 1  * localpart=<localpart>
 1  * quarantined="yes | "no"
 0+ * user=<member uname>
 0+ * maillist=<member listname>
 0+ * email=<member email>
 

The output data is, if possible, formatted to be readable in 80 colunms.

List/search addresses

All addresses

> domain domain list addresses
Domain administrators
Returns the name of all mailaddresses of the domain as a newline separated list

For certain recipients

> domain domain list addresses for user user
Domain administrators, Administratörer för user
Returns the name (localpart) of all mailaddresses on the domain that has the stated user as a direct recipient. Does not include indirections thruogh mailing lists.
> domain domain list addresses for maillist listname
Domain administrators, Administratörer för listname
Returns all mail addresses on the domain that has the stated mailing list as a direct recipient.
> domain domain list addresses for email email
Domain administrators
Returns all mail addresses on the domain that has the stated external mail address as a direct recipient. Does not include indirections thruogh mailing lists.