Chapter 29: Controller: /nodeworx/mail/pop3 Up Part II: NodeWorx API Spec Chapter 31: Controller: /nodeworx/mail/send 

30 Controller: /nodeworx/mail/queue

Required Permissions "EMAIL"
Action: delete
Added in version 4.8.0-393
Description Delete messages from the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: expire
Added in version 4.8.0-393
Description Expire messages in the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listStats
Added in version 4.8.0-393
Description Lists information about current queue statistics.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’queue’ => ’remote’,
’count’ => ’0’,
),
1 =>
array (
’queue’ => ’local’,
’count’ => ’0’,
),
2 =>
array (
’queue’ => ’todo’,
’count’ => ’0’,
),
),
)
Action: process
Added in version 4.7.0-339
Description Sends the ALRM signal to qmail, which tells it to process the mail queue.
Action: purge
Added in version 4.7.0-339
Description Purge mail queue.
Input Parameters
Name Type Notes Required?
queue struct (string) Help Entry
Use the dropdown to purge emails sitting in the selected queues.
Example Values
all, remote, local, todo
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryQueue
Added in version 4.8.0-393
Description Lists the contents of the selected queue.
Input Parameters
Name Type Notes Required?
queue string Help Entry
Use the dropdown to choose which email queue to view the message id, date, size, from and to of the emails within.
Example Values
all, remote, local, todo
Yes
Action: sendTestMessage
Added in version 4.8.0-393
Description Send a test message to see if the mail delivery is working.
Input Parameters
Name Type Notes Required?
email string Yes
subject string Yes
body string No
Action: unexpire
Added in version 4.8.0-393
Description Unexpire messages in the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
 Chapter 29: Controller: /nodeworx/mail/pop3 Up Part II: NodeWorx API Spec Chapter 31: Controller: /nodeworx/mail/send 

(C) 2017 by InterWorx LLC