help
[<section_name> |
<command_name> |
all]

Outputs complete list of commands from all the sections.

After this command, you can specify the section name to receive information on all of the commands from it. Also you can specify the name of the specific command to get information only on it.

You can view the list of all commands with the help all command.

option
[regex]

Outputs the list of the parameters and their values used by both drweb-maild and plug-ins (which receibed their settings from Dr.Web MailD). The output parameter names match the specified regular expression.

If a regular expression is not specified, all parameters are output.

db-state

Outputs the current state of the Dr.Web MailD internal database in the following format:

Number: NC/NM

Size: SC/SM

where NC and NM are current and maximum amount of messages in the database, and SC and SM are current and maximum size (in bytes) of the database.

If NM or SM are equal to 0, the maximum amount of messages and maximum database size are not limited (you can set the restrictions in the settings).

queue-state

Outputs the current status of messages in the internal queue.

Total amount of messages and information about each message are displayed. If the total amount is large, that may indicate a lack of threads in the second pool of drweb-maild (regulated by the OutPoolOptions parameter)

send-stat

Enforces transfer/export of the statistics (similar to the action performed on timeout specified in the SendPeriod parameter from the [Stat] section of the Dr.Web MailD configuration file).

This command can be used if the value of the Send parameter from the [Stat] section of the Dr.Web MailD configuration file is set to Yes. Gathered statistics is transferred to Dr.Web Agent.

send-report
[period]

Enforces sending of reports on plug-in operations (similar to the action performed on timeout set in the SendPeriod parameter from the [Reports] section of the Dr.Web MailD configuration file).

This command can only be used when the value of the Send parameter from the [Stat] section of the Dr.Web MailD configuration file is set to Yes.

Period defines a time period for which the report is generated (value is in the {time} format). If this value is not specified, the report contains statistics for a 24-hour period.

backup

Enforces back-up of the internal database

quarantine-pulse

Enforces start of the drweb-qp utility for Quarantine processing (similar to the action performed on timeout set in the PulseTime parameter from the [Quarantine] section of the Dr.Web MailD configuration file)

dump-cache-stat

All cached statistics is moved from cache to the internal database

get
[(id1|-|id1-[id2])
[(plugin_name|-)]]

Outputs information on messages stored in the internal database.

where:

•id –  number of the requested message,

•id1-id2 – outputs information on messages with numbers from the range defined by these values,

•id1- – outputs information on all messages with numbers beginning with id1 (numbers must be specified in hexadecimal notation),

•plugin_name –  name of the plug-in, which moved the message to the database.

"–" symbol means that the parameter is not specified. When no parameter is specified, information on all messages from the database is output.

Example:

get - drweb – outputs information on messages moved to the database by Drweb plug-in.

get -       – outputs information on all messages stored in the database.

send
[(id1|-|id1-[id2])
[(plugin_name|-)]
[force]]

Sends specified messages to the recipients from the envelope.

Only messages not yet dispatched to the recipients (with send=no in get command output) can be sent. Description of the parameters is similar to that of the get command except for the new parameter - force, which initiates dispatch of messages with send=yes.

export
[(id1|-|id1-[id2]) [(plugin_name|-)]
[(dir_name|-)]
[env]

Exports specified messages from the database to external files.

Description of the parameters is similar to that of the get command except for the following two additional parameters:

•dir_name –  path to the directory where files are stored. If this path is not specified, the value of the BaseDir parameter from the [General] section of the Dr.Web MailD configuration file is used;

•env – if specified, the envelope is also exported to file in the following format:

ofirst line – the sender address;

osecond line – receiver addresses, separated by commas.

Name of the message file is created from the number of the message and .eml extension. Name of the envelope file is created from the number of the message and .envelope extension.

Example:

export 00002D94 vaderetro /t env

Success export body to /t/00002D94.eml and envelope to /t/00002D94.envelope

remove
[(id1|-|id1-[id2])
[(plugin_name|-)]

Removes specified messages from the database.

Description of the parameters is similar to that of the get command.

Example:

remove 00002D93

Success remove record 00002D93

send_and_remove
[(id1|-|id1-[id2])
[(plugin_name|-)]
[force_send]
[ignore_send_error]

Sends and removes specified messages from the database.

Value of the force_send parameter is similar to the value of the force parameter of the send command. If the message was successfully sent with the send_and_remove command, or dispatch of this message is not required (that is, the message was sent before), the message is deleted.

If the ignore_send_error parameter is specified, the message is deleted regardless whether the dispatch was successful or not.

version

Outputs the current product version.

stop

Stops the product operation.

reload

Sends SIGHUP signal to drweb-maild process.