Run a specific BoxTrapper action for a message

This function performs a specified action on messages in the BoxTrapper queue.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
action
required
string

The action to perform on the email message file. To perform multiple actions on the specified email messages, pass this parameter multiple times.

  • deliver — Deliver a specific message.
  • deliverall — Deliver all messages from a sender.
  • delete — Delete a message.
  • deleteall — Delete all messages from a sender.
  • blacklist — Blacklist the sender of an email message.
  • whitelist — Whitelist the sender of an email message.
  • ignore — Ignore email messages from a sender.

Note:

The function performs the actions on the email messages files in the order that you pass each action.

Enum: "deliver" "deliverall" "delete" "deleteall" "blacklist" "whitelist" "ignore" Examples:
action=action=blacklist action=deleteall
action=blacklist
queuefile
required
string

The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.

Examples:
queuefile=email=example.msg email=example1.msg email=example2.msg
queuefile=example.msg
email
string <email>

The account's email address.

Warning:

  • The email parameter is required when this function is called outside of Webmail.
  • If you call this function in Webmail, the email parameter is not required, and the system overrides this parameter with the current authenticated user's email address.
Example: email=user@example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  process_messages \
  queuefile='example.msg' \
  action='blacklist'

Response samples

Content type
application/json
Example
{
  • "apiversion": 3,
  • "module": "BoxTrapper",
  • "result": {
    • "data": [
      • {
        • "email": null,
        • "failed": 1,
        • "matches": [
          • "example"
          ],
        • "reason": "(XID 2ymu8k) The system failed to locate the requested message: example.msg"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": [
      • "One or more of the operations failed."
      ]
    }
}