CtrlClnt (XMAIL ADMINISTRATION)

You can use CtrlClnt to send administration commands to AfterLogic XMail Server. These commands are defined in the previous section (XMAIL ADMIN PROTOCOL). The syntax of CtrlClnt is:

 CtrlClnt  [-snuptfSLcKCXHD]  ...

where:

-s server

set server address.

-n port

set server port [6017].

-u user

set username.

-p pass

set password.

-t timeout

set timeout [60].

-f filename

set dump filename [stdout].

-S

enable SSL link negotiation (talks to a CTRL port)

-L

use native SSL link (talks to a CTRLS port)

-K filename

set the SSL private key file (the environment variable ''CTRL_KEY_FILE'' also sets it)

-C filename

set the SSL certificate file (the environment variable ''CTRL_CERT_FILE'' also sets it)

-X filename

set the SSL certificate-list file (the environment variable ''CTRL_CA_FILE'' also sets it). See [SSL CONFIGURATION] for more information

-H dir

set the SSL certificate-store directory (the environment variable ''CTRL_CA_PATH'' also sets it). See [SSL CONFIGURATION] for more information

-D

enable debug output

With the command and parameters that follow adhering to the command syntax, ie:

 CtrlClnt  -s mail.foo.org -u someone-user -p ciao=>
   useradd home.bogus foouser foopasswd U

executes the command useradd with parameters 'home.bogus foouser foopasswd U'.

CtrlClnt returns 0 if the command is successful and != 0 if not. If the command is a query, then the result is printed to stdout.

[top]