---
title: "Internal Mailbox"
url: "https://nov18-dev.movespot.fyi/apis/internal-mailbox-0/versions/2eb01e46-804a-4f02-b351-ad840700d243"
---

# Internal Mailbox

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal Mailbox","description":"Internal API for the mailbox service.","version":"0.0.1","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://mailbox-api.mailbox.svc.cluster.local:5600/v1","description":"Mailbox API server"}],"paths":{"/internal/email/suppression-list/check":{"post":{"operationId":"checkEmailSuppressionState","summary":"Check if an email is in the suppression list","description":"Check if an email is in the suppression list.\n\nNote: The email address is not a part of the URL path so\nas to avoid any PII data in the access logs.\n","requestBody":{"$ref":"#/components/requestBodies/EmailSuppressionState"},"responses":{"200":{"$ref":"#/components/responses/EmailSuppressionStateResponse"}},"tags":["Email","Suppression List"]}},"/internal/email/suppression-list/remove":{"post":{"operationId":"deleteEmailFromSuppressionList","summary":"Remove the email from the suppression list","description":"Remove the email from the suppression list.\n\nNote: The email address is not a part of the URL path so\nas to avoid any PII data in the access logs.\n","requestBody":{"$ref":"#/components/requestBodies/RemoveSuppressedEmailPayload"},"responses":{"204":{"description":"No Content"}},"tags":["Email","Suppression List"]}}},"components":{"schemas":{"Identifier":{"type":"object","properties":{"principal_type":{"description":"Type of the principal","type":"string","example":"user"},"org_id":{"description":"ID of the Organization which the principal belongs to.","type":"string","example":"bc7e7998-b46b-4b3b-adbe-a4f761c408f3"},"principal_id":{"description":"Identifier of the associated principal","type":"string","format":"uuid","example":"5a568c6a-8121-4800-86dc-aac15ce3970e"}}},"EmailQuery":{"type":"object","properties":{"email":{"description":"The email address to check against the suppression list.","type":"string","format":"email","example":"user@example.com"}},"required":["email"]},"EmailSuppressionStateResponsePayload":{"type":"object","properties":{"email":{"description":"The email address to check against the suppression list.","type":"string","format":"email","example":"user@example.com"},"is_suppressed":{"description":"True if the email is in the suppression list, false otherwise.","type":"boolean","example":true},"identifiers":{"description":"Kong Identifiers which are associated with this suppressed email entry.","type":"array","items":{"$ref":"#/components/schemas/Identifier"}}},"required":["email","is_suppressed"]}},"requestBodies":{"EmailSuppressionState":{"description":"Body of suppression check request","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailQuery"}}}},"RemoveSuppressedEmailPayload":{"description":"Body of remove email from suppression list","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailQuery"}}}}},"responses":{"EmailSuppressionStateResponse":{"description":"Response of email suppression check request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSuppressionStateResponsePayload"}}}}}},"tags":[]}
```
