# Spam Prevention (BoxTrapper)

Email / Spam Prevention (BoxTrapper)

## Add email address to BoxTrapper blocked senders

 - [GET /BoxTrapper/blacklist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/blacklist_messages.md): This function blacklists email message senders.

Important:

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

## Delete messages in the BoxTrapper queue

 - [GET /BoxTrapper/delete_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/delete_messages.md): This function deletes messages in the BoxTrapper queue.

Important:

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

## Send messages in the BoxTrapper queue

 - [GET /BoxTrapper/deliver_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/deliver_messages.md): This function delivers messages in the BoxTrapper queue.

Important:

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

## Return account BoxTrapper allowlist rules

 - [GET /BoxTrapper/get_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_allowlist.md): This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.

Important:

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

## Return account BoxTrapper blocklist rules

 - [GET /BoxTrapper/get_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_blocklist.md): This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.

Important:

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

## Return email account's BoxTrapper configuration

 - [GET /BoxTrapper/get_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_configuration.md): This function retrieves an account's BoxTrapper configuration.

Important:

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

## Return specified BoxTrapper email template

 - [GET /BoxTrapper/get_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_email_template.md): This function retrieves a BoxTrapper email message template.

Important:

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

## Return all BoxTrapper forwarders

 - [GET /BoxTrapper/get_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_forwarders.md): This function retrieves a list of email addresses to which BoxTrapper forwards email messages.

Important:

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

## Return account BoxTrapper ignorelist rules

 - [GET /BoxTrapper/get_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_ignorelist.md): This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.

Important:

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

## Return BoxTrapper log file and contents

 - [GET /BoxTrapper/get_log](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_log.md): This function returns the account's BoxTrapper log file and its contents.

Important:

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

## Return message's top 200 lines in BoxTrapper queue

 - [GET /BoxTrapper/get_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_message.md): This function returns the first 200 lines of an email in the BoxTrapper queue.

Important:

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

## Return whether email account uses BoxTrapper

 - [GET /BoxTrapper/get_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_status.md): This function checks whether BoxTrapper is enabled for an email account.

Important:

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

## Add email account to Exim ignore list

 - [GET /BoxTrapper/ignore_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/ignore_messages.md): This function marks email message senders for Exim to ignore.

Important:

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

## Return BoxTrapper email templates

 - [GET /BoxTrapper/list_email_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_email_templates.md): This function lists the BoxTrapper email templates.

Important:

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

## Return email account's BoxTrapper queued messages

 - [GET /BoxTrapper/list_queued_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_queued_messages.md): This function returns a list of messages in the account's BoxTrapper queue.

Important:

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

## Run a specific BoxTrapper action for a message

 - [GET /BoxTrapper/process_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/process_messages.md): 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.

## Restore default BoxTrapper email message template

 - [GET /BoxTrapper/reset_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/reset_email_template.md): This function restores the BoxTrapper email message templates to the system default setting.

Important:

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

## Update email account's BoxTrapper configuration

 - [GET /BoxTrapper/save_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_configuration.md): This function modifies an account's BoxTrapper configuration.

Important:

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

## Save BoxTrapper message template contents

 - [GET /BoxTrapper/save_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_email_template.md): This function saves the contents of a BoxTrapper message template.

Important:

When you disable the _Receive Mail_ role,
the system disables this function.

## Update account BoxTrapper allowlist

 - [GET /BoxTrapper/set_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_allowlist.md): This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.

Important:

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

## Update account BoxTrapper blocklist

 - [GET /BoxTrapper/set_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_blocklist.md): This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.

Important:

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

## Add email address to BoxTrapper forwarders

 - [GET /BoxTrapper/set_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_forwarders.md): This function adds a list of email addresses to which BoxTrapper forwards email messages.

Important:

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

## Update account BoxTrapper ignorelist

 - [GET /BoxTrapper/set_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_ignorelist.md): This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.

Important:

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

## Enable or disable BoxTrapper for email account

 - [GET /BoxTrapper/set_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_status.md): This function enables or disables BoxTrapper for an email account.

Important:

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

## Add email address to BoxTrapper allowed senders

 - [GET /BoxTrapper/whitelist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/whitelist_messages.md): This function whitelists email messages.

Important:

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

Note:

To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI BoxTrapper::deliver_messages function.