> ## Documentation Index > Fetch the complete documentation index at: https://inbound.new/docs/llms.txt > Use this file to discover all available pages before exploring further. # Run one mailbox filter on a folder > Run a single filter over existing messages in a folder, up to 500 messages per call. Repeat with `afterUid` set to `lastUid` while `hasMore` is true. ## OpenAPI ````yaml https://inbound.new/openapi.json post /api/e2/mailboxes/{id}/filters/{filterId}/apply openapi: 3.1.0 info: title: Inbound Email API description: >+ # Inbound API The Inbound API allows you to manage email infrastructure programmatically - domains, email addresses, webhooks, and more. ## Authentication All API requests require a Bearer token in the Authorization header: ```bash curl -H "Authorization: Bearer YOUR_API_KEY" \ https://inbound.new/api/e2/domains ``` ## Base URL ``` https://inbound.new/api/e2 ``` ## Quick Start 1. **Create a domain** - Register your domain with Inbound 2. **Configure DNS** - Add the provided DNS records to your domain 3. **Create an email address** - Set up addresses to receive emails 4. **Create an endpoint** - Configure where emails are delivered (webhook, forwarding, etc.) version: 2.0.0 servers: - url: https://inbound.new description: Production API server security: - bearerAuth: [] tags: - name: Webhooks description: Webhooks sent by Inbound to your configured endpoints when events occur. - name: Emails description: >- Send, list, and manage emails. Supports immediate sending, scheduling, replies, and retry functionality. - name: Mail description: >- Inbox and thread views for received emails. Filter by domain, address, or search. - name: Domains description: >- Manage domains for sending and receiving emails. Domains must be verified via DNS before use. - name: Endpoints description: >- Configure where incoming emails are delivered - webhooks, email forwarding, or custom handlers. - name: Email Addresses description: Create and manage email addresses on your verified domains. - name: Attachments description: Download email attachments using authenticated requests. paths: /api/e2/mailboxes/{id}/filters/{filterId}/apply: post: tags: - Mailboxes summary: Run one mailbox filter on a folder description: >- Run a single filter over existing messages in a folder, up to 500 messages per call. Repeat with `afterUid` set to `lastUid` while `hasMore` is true. operationId: postApiE2MailboxesByIdFiltersByFilterIdApply parameters: - name: id in: path required: true schema: type: string - name: filterId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: folder: minLength: 1 maxLength: 255 description: Folder to run the filters over, for example `INBOX` type: string afterUid: minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. anyOf: - format: integer default: 0 type: string - minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. type: integer limit: minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) anyOf: - format: integer default: 0 type: string - minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) type: integer required: - folder application/x-www-form-urlencoded: schema: type: object properties: folder: minLength: 1 maxLength: 255 description: Folder to run the filters over, for example `INBOX` type: string afterUid: minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. anyOf: - format: integer default: 0 type: string - minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. type: integer limit: minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) anyOf: - format: integer default: 0 type: string - minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) type: integer required: - folder multipart/form-data: schema: type: object properties: folder: minLength: 1 maxLength: 255 description: Folder to run the filters over, for example `INBOX` type: string afterUid: minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. anyOf: - format: integer default: 0 type: string - minimum: 0 description: >- Only messages with a higher UID. Pass the previous response's lastUid to continue. type: integer limit: minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) anyOf: - format: integer default: 0 type: string - minimum: 1 maximum: 500 default: 500 description: Messages to process in this call (at most 500) type: integer required: - folder responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: folder: type: string processed: description: Messages examined in this batch type: number lastUid: nullable: true anyOf: - description: >- UID of the last message examined (afterUid when nothing was processed) type: number - type: 'null' hasMore: description: True when the batch was full and more messages may remain type: boolean required: - folder - processed - lastUid - hasMore '400': description: Response for status 400 content: application/json: schema: type: object properties: error: type: string required: - error '401': description: Response for status 401 content: application/json: schema: type: object properties: error: type: string required: - error '403': description: Response for status 403 content: application/json: schema: type: object properties: error: type: string required: - error '404': description: Response for status 404 content: application/json: schema: type: object properties: error: type: string required: - error '409': description: Response for status 409 content: application/json: schema: type: object properties: error: type: string required: - error components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Your Inbound API key. Include it in the Authorization header as: Bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.