Server commands

All the command names and arguments are case-sensitive.

• QUEUE_INFO $<$queue name $\vert$ ALL$>$
• SHOW_CONFIG
• FETCH_RESULT $<$account name$>$
• POLL $<$MEDIA$>$ $<$OPERATION$>$ $[<$account name$>$ $<$password$>]$

Actimd has a number of queues with threads managing tasks. The QUEUE_INFO command is to request the server to report any task in a particular queue. The queue names can be:

• HOLD_RESULT
• RAW_RESULT
• INCOMING
• CLIENT_RESULT
• SUBMITTD

The keyword ALL represents all the queues. The only queue that normal users need to be aware of are HOLD_RESULT.

SHOW_CONFIG command requests the server to report all the current configuration values.

If there are results configured to put into HOLD_RESULT queue, then FETCH_RESULT retrieves all the results in the queue that matches the account name.

POLL is to instruct the server to start/end a polling action for a user's email account. MEDIA can only have the value EMAIL at the moment. As for OPERATION, this can be SETUP_USER, END_USER or CHECK. SETUP_USER starts the polling and the END_USER (should be supported soon) ends the continuous polling. CHECK command is to detect whether a polling has been setup.

Examples of server commands

actim -C QUEUE_INFO ALL
actim -C QUEUE_INFO HOLD_RESULT
actim -C FETCH_RESULT "e.xom@ntlworld.com"