INTRODUCTION
============
sxaa allows a system administrator to administer server-based Scalix rules (autoactions) from the command line. This allows administrators to set up simple rules without needing to use a client or know the user's mailbox password. This command should be run as a Scalix administror or, preferably, root.

Run the command without any parameters to list the options available.

Listing rules
-------------

To list the current rules:

sxaa --user user

will give output similar to:

OOF FLT OLK AANO ACTION         TITLE                           STATE
--- --- --- ---- ----------     ------------------------------  --------
     Y      500  FORWARD        SXAA FORWARD:500                enabled
     Y      501  FORWARD        SXAA FORWARD:501                enabled


The OOF column indicates if the rule is designated as Out Of Office. This implies that an auto reply to the same originator will only be sent periodically rather than for every message.
FLT indicates if a condition is applied to this rule.
OLK indicates if the rule was created using the Scalix Rules Wizard on Outlook.
AANO is a unique reference number for each rule. This can be used as the ref option for other calls to sxaa.

Forwarding Messages
-------------------
To add an auto forward:

	sxaa --user user --forward [address@domain | S=Last/G=First/OU1=mailnode] [--text file.txt]

The address can either be an internet-style address for a remote user or it can be for a Scalix user in which case the latter form is used. Optional covering text can be supplied in a text file.

Automatic Replies
-----------------
For simple auto replies:

	sxaa --user user --reply --text file.txt

In this case, the reply text *must* be specified.


Redirecting Messages
--------------------
For redirections:

	sxaa --user user --redirect [address@domain | S=Last/G=First/OU1=mailnode] [--retain]

As for the forwarding rule, the redirection address can be an internet or Scalix style. An optional switch can be specified so that incoming mail is retained in the InTray.

Filing Messages to a Folder
---------------------------
To file a message to a folder:
	sxaa --user user --file "foldername"
	sxaa --user user --file "/inbox/foldername"

The second version of the --file option shows how to specify a sub-folder of the inbox.

Specifying Conditions
---------------------
It is also possible to specify a simple condition to apply to a rule. There are a number of possible conditions: --subject, --sender, --header and --itemclass.

	sxaa --user user --file "foldername" --subject "SPAM"
	sxaa --user user --file "foldername" --sender "dave@scalix.com"
	sxaa --user user --file "foldername" --header "X-Spam-Status:***"
	sxaa --user user --file "foldername" --itemclass "IPM.Schedule"

For each of the conditions, a wildcard is applied. So, the example rules above should be read as "CONTAINS" the specified string.
NB: Because of the way that sxaa specifies a wildcard internally, if you need to use a '%' character in your string, you should also use the --wildcard option as follows:

	sxaa --user user --file "foldername" --subject "90%" --wildcard "@"

This indicates that the "@" character should be used as an internal wildcard character. Obviously, choose a character you do not need to specify in your strings.

Specifying a title
------------------
For each of the rules that are being added, a more relevant title can be specified using the --title switch, i.e.
	
	sxaa --user --file "foldername" --subject "SPAM" --title "Anti-spam rule"

Displaying Conditions
---------------------
If the FLT column for a rule shows that a condition has been supplied, you can view the condition by using the --info option.

	sxaa --user user --info reference

and this will show you output similar to:

	Conditions
	----------
	Sender not = "S=%user@domain.com%"
	Action
	------
	FORWARD
	TO : S=test.user/OU1=internet/DDT1=RFC-822/DDV1=test.user@example.com/CN=test.user/INTERNET-ADDR=test.user@example.com

Deleting Rules
--------------
To delete a rule:

	sxaa --user user --del reference

The reference is obtained from the AANO column in the list.

Enabling/Disabling Rules
------------------------
To enable/disable a rule:

	sxaa --user user --on reference
	sxaa --user user --off reference

As for deletion, the reference is obtained from the AANO column in the list.

Marking a rule as Out of Office
-------------------------------
To mark a rule as Out of Office (OOF):
	
	sxaa --user user --oof y --ref reference