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

Required?

Example Values

Default Values

Notes

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

Required?

Example Values

Default Values

Notes

message_id

struct (integer)

No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

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,
    ),
  ),
  'reply_code' => 205,
)

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

Required?

Example Values

Default Values

Notes

queue

struct (string)

No*

all, remote, local, todo

Use the dropdown to purge emails sitting in the selected queues.

* 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

Required?

Example Values

Default Values

Notes

queue

string

Yes

all, remote, local, todo

Use the dropdown to choose which email queue to view the message id, date, size, from and to of the emails within.

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, …

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

Required?

Example Values

Default Values

Notes

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

Required?

Example Values

Default Values

Notes

message_id

struct (integer)

No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.