GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  RSPAMC (1)

NAME

C]rspamc] - rspamd command line client

CONTENTS

Synopsis
Description
Options
Return Value
Examples
See Also

SYNOPSIS

rspamc [I]options]] [I]command]] [I]input-file]]...

rspamc --help

DESCRIPTION

C]rspamc] is a simple client for checking messages using rspamd or for learning rspamd by messages. C]rspamc] supports the following commands:
[bu] Scan commands:
[bu] C]symbols]: scan message and show symbols (default command)
[bu] Control commands
[bu] C]learn_spam]: learn message as spam
[bu] C]learn_ham]: learn message as ham
[bu] C]fuzzy_add]: add message to fuzzy storage (check C]-f] and C]-w] options for this command)
[bu] C]fuzzy_del]: delete message from fuzzy storage (check C]-f] option for this command)
[bu] C]stat]: show rspamd statistics
[bu] C]stat_reset]: show and reset rspamd statistics (useful for graphs)
[bu] C]counters]: display rspamd symbols statistics
[bu] C]uptime]: show rspamd uptime
[bu] C]add_symbol]: add or modify symbol settings in rspamd
[bu] C]add_action]: add or modify action settings
Control commands that modifies rspamd state are considered as privileged and basically requires a password to be specified with
C]-P] option (see B]OPTIONS], below, for details). This depends on a controller[aq]s settings and is discussed in C]rspamd-workers] page.

C]Input files] may be either regular file(s) or a directory to scan. If no files are specified C]rspamc] reads from the standard input. Controller commands usually does not accept any input, however learn* and fuzzy* commands requires input.

OPTIONS

-h I]host[:port]], --connect=I]host[:port]]
  Specify host and port
-P I]password], --password=I]password]
  Specify control password
-c I]name], --classifier=I]name]
  Classifier to learn spam or ham (bayes is used by default)
-w I]weight], --weight=I]weight]
  Weight for fuzzy operations
-f I]number], --flag=I]number]
  Flag for fuzzy operations
-p, --pass Pass all filters
-v, --verbose
  More verbose output
-i I]ip address], --ip=I]ip address]
  Emulate that message was received from specified ip address
-u I]username], --user=I]username]
  Emulate that message was from specified user
-d I]user\@domain], --deliver=I]user\@domain]
  Emulate that message is delivered to specified user
-F I]user\@domain], --from=I]user\@domain]
  Emulate that message is from specified user
-r I]user\@domain], --rcpt=I]user\@domain]
  Emulate that message is for specified user
--helo=I]helo_string]
  Imitate SMTP HELO passing from MTA
--hostname=I]hostname]
  Imitate hostname passing from MTA (rspamd assumes that it is verified by MTA)
-t I]seconds], --timeout=I]seconds]
  Timeout for waiting for a reply (can be floating point number, e.g. 0.1)
-b I]host:port], --bind=I]host:port]
  Bind to specified ip address
-j, --json Output formatted JSON
--ucl Output UCL
--raw Output raw data received from rspamd (compacted JSON)
--headers
  Output HTTP headers from a reply
--extended-urls
  Output URLs in an extended format, showing full URL, host and the part of host that was used by surbl module (if enabled).
-n I]parallel_count], --max-requests=I]parallel_count]
  Maximum number of requests to rspamd executed in parallel (8 by default)
-e I]command], --execute=I]command]
  Execute the specified command with either mime output (if C]mime] option is also specified) or formatted rspamd output
--mime Output the full mime message instead of scanning results only
--header=I]header]
  Add custom HTTP header for a request. You may specify header in format C]name=value] or just C]name] for an empty header. This option can be repeated multiple times.
--sort=I]type]
  Sort output according to a specific field. For C]counters] command the allowed values for this key are C]name], C]weight], C]frequency] and C]time]. Appending C]:desc] to any of these types inverts sorting order.
--commands
  List available commands

RETURN VALUE

On exit C]rspamc] returns C]0] if operation was successfull and an error code otherwise.

EXAMPLES

Check stdin:
C]
rspamc < some_file
]

Check files:
C]
rspamc symbols file1 file2 file3
]

Learn files:
C]
rspamc -P pass learn_spam file1 file2 file3
]

Add fuzzy hash to set 2:
C]
rspamc -P pass -f 2 -w 10 fuzzy_add file1 file2
]

Delete fuzzy hash from other server:
C]
rspamc -P pass -h hostname:11334 -f 2 fuzzy_del file1 file2
]

Get statistics:
C]
rspamc stat
]

Get uptime:
C]
rspamc uptime
]

Add custom rule[aq]s weight:
C]
rspamc add_symbol test 1.5
]

Add custom action[aq]s weight:
C]
rspamc add_action reject 7.1
]

SEE ALSO

Rspamd documentation and source codes may be downloaded from <https://rspamd.com/>.

Search for    or go to Top of page |  Section 1 |  Main Index


Rspamd User Manual RSPAMC (1)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.