> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Mailprotector API

> Allow and block senders, release quarantined mail, read message logs, and keep Mailprotector users and user syncs up to date

The common use is a ticket that asks to allow or block a sender: the agent finds the user or the customer the ticket is about, adds the allow or block rule at that level, and releases the mail the filter held when the ticket asks for it.

> [!NOTE]
>
> Automatically enabled when you configure Mailprotector permissions in your agent workflow.

## What It Does

* Add and remove allow and block rules for a sender address or domain, for one user, a user group, a domain or a whole customer
* Read the quarantine at every level, with why each message was held, and release chosen messages
* Read message logs: whether a message was delivered, held, bounced or encrypted, and why
* Find a user by address, and add, change and remove users, user groups and aliases
* Read each domain's user syncs and their schedule, turn a sync or its schedule on, and set how often it runs
* Read and change services (Bracket, SafeSend, SecureStore, XtraMail), domains and mail routing, settings and managers, and read statements

## Permission Groups

| Group | Access levels | Covers |
| - | - | - |
| Resellers & Customers | Disabled, Read Only, Read/Write | Your reseller account and its customers |
| Domains & Mail Routing | Disabled, Read Only, Read/Write | Domains and aliases, where each domain's mail is delivered, and which servers may send through it |
| User Groups & Users | Disabled, Read Only, Read/Write | User groups, users, aliases and notification addresses, and finding a user by address |
| User Sync | Disabled, Read Only, Read/Write | User syncs from Active Directory, Microsoft 365 or Google Workspace, their filters and their schedule |
| Services | Disabled, Read Only, Read/Write | The products each user group has |
| Allow & Block Rules | Disabled, Read Only, Read/Write | Reading every allow and block rule, and adding block rules |
| Allowing Senders | Disabled, Read Only, Read/Write | Adding allow rules and removing any rule |
| Quarantine | Disabled, Read Only, Read/Write | Quarantined mail and releasing it |
| Message Logs | Disabled, Read Only | Message logs and what each filtering result means |
| Configuration | Disabled, Read Only, Read/Write | The settings of the reseller, each customer, domain and user group |
| Managers | Disabled, Read Only, Read/Write | Console logins of your reseller account and each customer |
| Statements | Disabled, Read Only | Billing statements |

Neo always asks a technician before it deletes a customer, a domain or a user group, turns a service off, or sets a password or secret, whatever the group's approval setting. It never releases a level's whole quarantine at once, and never deletes your reseller account. On a ticket, the agent works only on the Mailprotector customer mapped to the ticket's company.

## Setup

See [Connecting Mailprotector to Neo](https://docs.neoagent.io/integrations/mailprotector/connecting-to-neo.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.