出典: ScalixWikiJP
NAME
sxaa - administer server-based Scalix rules (autoactions)
SYNOPSIS
sxaa --user USER
sxaa --user USER --forward ADDRESS [--text FILENAME] [FILTER] [--title RULETITLE]
sxaa --user USER --reply FILENAME [FILTER] [--title RULETITLE]
sxaa --user USER --redirect ADDRESS [--retain] [FILTER] [--title RULETITLE]
sxaa --user USER --file FOLDERNAME [FILTER] [--title RULETITLE]
sxaa --user USER --delete [FILTER] [--title RULETITLE]
sxaa --user USER --remove REFERENCE
sxaa --user USER --on REFERENCE
sxaa --user USER --off REFERENCE
sxaa --user USER --oof y --ref REFERENCE
sxaa --user USER --oof n --ref REFERENCE
sxaa --user USER --info REFERENCE
sxaa --user USER --toggleretain REFERENCE
sxaa --help
where FILTER can be one of:
--subject, --sender, --group, --itemclass or --header
--not reverses the meaning of the filter
ADDRESS is either an internet address of the form :
address@domain
or a Scalix address of the form :
S=Last/G=First/OU1=mailnode
REFERENCE is a number from the AANO column in ’sxaa --user USER’ output.
DESCRIPTION
sxaa can be used to administer server-based Scalix rules (autoactions).
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 root.
EXAMPLES
Listing rules
To list the current rules for user "Frodo Baggins" :
sxaa --user "Frodo Baggins"
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
Y in the OOF column indicates that this rule is designated as an "Out
Of Office" rule. This implies that an auto reply to the same origina-
tor will only be sent periodically rather than for every message.
Y in the FLT column indicates that a condition applies to this rule.
Y in the OLK column indicates that 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 to a remote user using an internet address, pro-
viding covering text from a file :
sxaa --user "Sam Orr" --forward pete@example.com --text fwd.txt
To add an auto forward to a user using a Scalix address without speci-
fying any covering text:
sxaa --user "Sam Orr" --forward S=Baggins/G=Bilbo/OU1=shire
The address to forward to can be specified in either internet or Scalix
style. Optional covering text can be supplied in a text file.
Automatic Replies
To add a simple autoreply :
sxaa --user "Sam Orr" --reply --text replyText.txt
Note that in this case, the reply text must be specified.
Redirecting Messages
To redirect messages arriving in Sam Orr’s inbox to an internet
address, retaining the original message in Sam’s intray :
sxaa --user "Sam Orr" --redirect jim@example.com --retain
To redirect Sam’s incoming messages to a Scalix address, and remove the
original message from Sam’s intray :
sxaa --user "Sam Orr" --redirect S=Davis/G=Jim/OU1=mars
Filing Messages to a Folder
To file Sam’s incoming messages to folder "March" :
sxaa --user "Sam Orr" --file "March"
To file incoming messages to sub-folder "MaybeSPAM" inside the inbox :
sxaa --user "Sam Orr" --file "/inbox/MaybeSPAM"
Notice the "/" at the start which is how to specify that this folder is
a sub-folder of the inbox.
Deleting Messages
sxaa --user "Sam Orr" --delete
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. Some example uses :
sxaa --user "Sam Orr" --file "JUNK" --subject "SPAM"
sxaa --user "Sam Orr" --file "dave" --sender "dave@example.com"
sxaa --user "Sam Orr" --file "Spam?" --header "X-Spam-Status:***"
sxaa --user "Sam Orr" --file "Sched" --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.
WARNING: 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 "Sam Orr" --file "Act" --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.
Group condition
The --group condition is used where matching on a group of users is
required. The users must be members of a Public Distribution List (PDL)
on the system. The group specification can be either and internet
address or a tag=value address:
sxaa --user "Sam Orr" --file "Golf Club" --group golf@mordor.uk.com
sxaa --user "Sam Orr" --file "Dev Team" --group "CN=Dev Team/OU1=mordor"
This --group option is not wildcarded and must match exactly one PDL on
the system.
Specifying a title
For each of the rules that are being added, a more relevant title can
be specified using the --title switch, for example
sxaa --user "Sam Orr" --file "MaybeSpam" \
--header "X-Spam-Status:***" --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 for the rule by using the --info option.
For example :
sxaa --user "Sam Orr" --info 602
and this will show you output similar to:
Conditions
----------
Arpa Header = "%List-Subscribe:%"
Action
------
FILE in /INBOX/forums
Deleting Rules
To delete a rule, use, for example :
sxaa --user "Sam Orr" --remove 602
The reference is obtained from the AANO column in the list.
Enabling/Disabling Rules
To enable Sam Orr’s rule with AANO reference 602 use :
sxaa --user "Sam Orr" --on 602
To disable it, use :
sxaa --user "Sam Orr" --off 602
As for deletion, the reference is obtained from the AANO column.
Marking a rule as Out of Office
To mark Sam’s rule 602 as being Out of Office (OOF):
sxaa --user "Sam Orr" --oof y --ref 602
AUTHOR
sxaa was developed by Scalix Corporation.
ScalixServer 11.4.6 November 2009 SXAA(1)
