Distributed James Server — Command Line Interface

Domains represent the domain names handled by your server.

You can add a domain:

You can remove a domain:

(Note: associated users are not removed automatically)

Check if a domain is handled:

And list your domains:

Note: the following commands are explained with virtual hosting turned on.

Users are accounts on the mail server. James can maintain mailboxes for them.

You can add a user:

Note: the domain used should have been previously created.

You can delete a user:

(Note: associated mailboxes are not removed automatically)

And change a user password:

Note: All these write operations can not be performed on LDAP backend, as the implementation is read-only.

Finally, you can list users:

An administrator can perform some basic operation on user mailboxes.

Note on mailbox formatting: mailboxes are composed of three parts.

An administrator can delete all of the mailboxes of a user, which is not done automatically when removing a user (to avoid data loss):

He can delete a specific mailbox:

He can list the mailboxes of a specific user:

And finally can create a specific mailbox:

The administrator can use the CLI to add a message in a mailbox. this can be done using:

This command will add a message having the content specified in file.eml (that needs to be at the EML format). It will get added in the INBOX.subFolder mailbox belonging to user user@domain.tld.

A mapping is a recipient rewriting rule. There is several kind of rewriting rules:

You can manage address mapping like (redirects email from fromUser@fromDomain.tld to redirected@domain.new, then deletes the mapping):

You can manage domain mapping like (redirects a domain, which means any@domain.tld will be rewritten as any@domain.new, then deletes the mapping):

You can view mapping for a domain:

You can manage regex mapping like this:

You can view mapping for a mail address:

And all mappings defined on the server:

Quotas are limitations on a group of mailboxes. They can limit the size or the messages count in a group of mailboxes.

James groups by defaults mailboxes by user (but it can be overridden), and labels each group with a quotaroot.

To get the quotaroot a given mailbox belongs to:

Then you can get the specific quotaroot limitations.

For the number of messages:

And for the storage space available:

You see the maximum allowed for these values:

For the number of messages:

And for the storage space available:

You can also specify maximum for these values.

For the number of messages:

And for the storage space available:

With value being an integer. Please note the use of units for storage (K, M, G). For instance:

Moreover, James allows to specify global maximum values, at the server level. Note: syntax is similar to what was exposed previously.

James allow you to index your emails in a search engine, for making search faster.

For some reasons, you might want to re-index your mails (inconsistencies across datastore, migrations).

To re-index all mails of all mailboxes of all users, type:

And for a specific mailbox:

James implements Sieve (RFC-5228). Your users can then write scripts and upload them to the server. Thus they can define the desired behavior upon email reception. James defines a Sieve mailet for this, and stores Sieve scripts. You can update them via the ManageSieve protocol, or via the ManageSieveMailet.

You can define quota for the total size of Sieve scripts, per user.

Syntax is similar to what was exposed for quotas. For defaults values:

And for specific user quotas:

Migration is experimental for now. You would need to customize Spring configuration to add a new mailbox manager with a different bean name.

You can then copy data across mailbox managers using:

You will then need to reconfigure James to use the new mailbox manager.