John Doe
", "text_body": "John Doe" } } } }, "description": "" } } } }, "/api/v1.0/mailboxes/{mailbox_id}/message-templates/available/": { "get": { "operationId": "mailboxes_message_templates_available_list", "description": "List message templates.", "parameters": [ { "in": "query", "name": "bodies", "schema": { "type": "string" }, "description": "Comma-separated list of body fields to include in the response. Allowed values: raw, html, text. Example: ?bodies=raw,html" }, { "in": "path", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "autoreply", "message", "signature" ] } } ], "tags": [ "mailboxes" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadMessageTemplate" } } } }, "description": "" } } } }, "/api/v1.0/mailboxes/{id}/": { "get": { "operationId": "mailboxes_retrieve", "description": "ViewSet for Mailbox model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "mailboxes" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mailbox" } } }, "description": "" } } }, "patch": { "operationId": "mailboxes_partial_update", "description": "Rename a mailbox (its display contact name). Mailbox admins only.\n\n``partial=True`` keeps true PATCH semantics: omitting ``name`` is a no-op\nrather than a 400, so the runtime matches the optional request schema.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "mailboxes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMailboxNameUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMailboxNameUpdateRequest" } } } }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mailbox" } } }, "description": "" } } } }, "/api/v1.0/mailboxes/{id}/search/": { "get": { "operationId": "mailboxes_search_list", "description": "Search mailboxes by domain, local part and contact name.\n\nQuery parameters:\n- q: Optional search query for local part and contact name", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "q", "schema": { "type": "string" }, "description": "Search mailboxes by domain, local part and contact name." } ], "tags": [ "mailboxes" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxLight" } } } }, "description": "" } } } }, "/api/v1.0/maildomains/": { "get": { "operationId": "maildomains_list", "description": "List mail domains, optionally filtered by name with the `q` parameter.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "in": "query", "name": "q", "schema": { "type": "string" }, "description": "Filter domains whose name contains this value (case-insensitive)." } ], "tags": [ "maildomains" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMailDomainAdminList" } } }, "description": "" } } }, "post": { "operationId": "maildomains_create", "description": "ViewSet for listing MailDomains the user administers.\nProvides a top-level entry for mail domain administration.\nEndpoint: /maildomains/Hello, world!
" }, "summary": "Send Draft" } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" }, "examples": { "SendDraftResult": { "value": { "task_id": "123e4567-e89b-12d3-a456-426614174000" }, "summary": "Send Draft Result" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/v1.0/tasks/{task_id}/": { "get": { "operationId": "tasks_retrieve", "description": "\n Get the status of an async task.\n\n This endpoint returns the current status of a task identified by its ID.\n ", "parameters": [ { "in": "path", "name": "task_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "tasks" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" }, "examples": { "TaskStatus": { "value": { "status": "SUCCESS", "result": { "success": true }, "error": null }, "summary": "Task Status" } } } }, "description": "" } } } }, "/api/v1.0/third-party/drive/": { "get": { "operationId": "third_party_drive_retrieve", "description": "Search for files created by the current user.", "parameters": [ { "in": "query", "name": "title", "schema": { "type": "string" }, "description": "Search files by title." } ], "tags": [ "third-party/drive" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDriveItemResponse" } } }, "description": "Files found" } } }, "post": { "operationId": "third_party_drive_create", "description": "Save an attachment to the user's Drive workspace. If the file already exists (matched by title and size), returns the existing item with a 200 status. Otherwise, creates a new file and returns it with a 201 status.", "tags": [ "third-party/drive" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriveUploadAttachmentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DriveUploadAttachmentRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialDriveItem" } } }, "description": "File already exists in Drive" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialDriveItem" } } }, "description": "File created successfully" } } } }, "/api/v1.0/threads/": { "get": { "operationId": "threads_list", "description": "List threads with optional search functionality.", "parameters": [ { "in": "query", "name": "has_active", "schema": { "type": "integer" }, "description": "Filter threads that have active messages (1=true, 0=false)." }, { "in": "query", "name": "has_archived", "schema": { "type": "integer" }, "description": "Filter threads that have archived (1=true, 0=false)." }, { "in": "query", "name": "has_assigned_to_me", "schema": { "type": "integer" }, "description": "Filter threads assigned to the current user (1=true, 0=false)." }, { "in": "query", "name": "has_attachments", "schema": { "type": "integer" }, "description": "Filter threads with attachments (1=true, 0=false)." }, { "in": "query", "name": "has_delivery_pending", "schema": { "type": "integer" }, "description": "Filter threads that have delivery pending messages: sending, retry or failed (1=true, 0=false)." }, { "in": "query", "name": "has_draft", "schema": { "type": "integer" }, "description": "Filter threads with draft messages (1=true, 0=false)." }, { "in": "query", "name": "has_mention", "schema": { "type": "integer" }, "description": "Filter threads with any mention (read or unread) for the current user (1=true, 0=false)." }, { "in": "query", "name": "has_messages", "schema": { "type": "integer" }, "description": "Filter threads that have messages (1=true, 0=false)." }, { "in": "query", "name": "has_sender", "schema": { "type": "integer" }, "description": "Filter threads with messages sent by the user (1=true, 0=false)." }, { "in": "query", "name": "has_starred", "schema": { "type": "integer" }, "description": "Filter threads with starred messages (1=true, 0=false)." }, { "in": "query", "name": "has_trashed", "schema": { "type": "integer" }, "description": "Filter threads that have trashed messages (1=true, 0=false)." }, { "in": "query", "name": "has_unassigned", "schema": { "type": "integer" }, "description": "Filter threads with no active assignment from any user (1=true, 0=false)." }, { "in": "query", "name": "has_unread", "schema": { "type": "integer" }, "description": "Filter threads with unread messages (1=true, 0=false). Requires mailbox_id." }, { "in": "query", "name": "has_unread_mention", "schema": { "type": "integer" }, "description": "Filter threads with unread mentions for the current user (1=true, 0=false)." }, { "in": "query", "name": "is_spam", "schema": { "type": "integer" }, "description": "Filter threads that are spam (1=true, 0=false)." }, { "in": "query", "name": "is_trashed", "schema": { "type": "integer" }, "description": "Filter threads that have all messages trashed (1=true, 0=false)." }, { "in": "query", "name": "label_slug", "schema": { "type": "string" }, "description": "Filter threads by label slug." }, { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter threads by mailbox ID." }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Search threads by content (subject, sender, recipients, message body)." } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedThreadList" } } }, "description": "" } } } }, "/api/v1.0/threads/{id}/": { "get": { "operationId": "threads_retrieve", "description": "Retrieve a single thread, ignoring spam/trashed filters.\n\nDeep-link sharing relies on a stable URL that survives state\nchanges: a shared link must keep working after the thread is\narchived, marked as spam, or moved to trash. The ThreadAccess\npermission check still applies, so unauthorized users get 404.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Thread" } } }, "description": "" } } }, "delete": { "operationId": "threads_destroy", "description": "Delete a thread, requiring EDITOR role on the thread.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/v1.0/threads/{id}/refresh-summary/": { "post": { "operationId": "threads_refresh_summary_create", "description": "Refresh the summary of a thread.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "string" } } } } }, "description": "Summary successfully refreshed." }, "403": { "content": { "application/json": { "schema": { "detail": "Permission denied" } } }, "description": "User does not have permission to refresh the summary of this thread." } } } }, "/api/v1.0/threads/{id}/split/": { "post": { "operationId": "threads_split_create", "description": "Split a thread by moving the specified message and all later messages to a new thread.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "threads" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadSplitRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadSplitRequestRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Thread" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "Validation error." }, "403": { "content": { "application/json": { "schema": { "detail": "Permission denied" } } }, "description": "User does not have editor permission on this thread." } } } }, "/api/v1.0/threads/{id}/summary/": { "get": { "operationId": "threads_summary_retrieve", "description": "Retrieve the summary of a thread.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "string" } } } } }, "description": "Thread summary retrieved successfully." }, "403": { "content": { "application/json": { "schema": { "detail": "Permission denied" } } }, "description": "User does not have permission to access this thread." } } } }, "/api/v1.0/threads/{thread_id}/accesses/": { "get": { "operationId": "threads_accesses_list", "description": "ViewSet for ThreadAccess model.", "parameters": [ { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter thread accesses by mailbox ID." }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-access" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadAccess" } } } }, "description": "" } } }, "post": { "operationId": "threads_accesses_create", "description": "Create a new thread access.", "parameters": [ { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter thread accesses by mailbox ID." }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-access" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAccessRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadAccessRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAccess" } } }, "description": "" } } } }, "/api/v1.0/threads/{thread_id}/accesses/{id}/": { "put": { "operationId": "threads_accesses_update", "description": "ViewSet for ThreadAccess model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter thread accesses by mailbox ID." }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-access" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAccessRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadAccessRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAccess" } } }, "description": "" } } }, "patch": { "operationId": "threads_accesses_partial_update", "description": "ViewSet for ThreadAccess model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter thread accesses by mailbox ID." }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-access" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedThreadAccessRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedThreadAccessRequest" } } } }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAccess" } } }, "description": "" } } }, "delete": { "operationId": "threads_accesses_destroy", "description": "ViewSet for ThreadAccess model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter thread accesses by mailbox ID." }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-access" ], "security": [ { "cookieAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/v1.0/threads/{thread_id}/events/": { "get": { "operationId": "threads_events_list", "description": "ViewSet for ThreadEvent model.", "parameters": [ { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEvent" } } } }, "description": "" } } }, "post": { "operationId": "threads_events_create", "description": "Create a ThreadEvent.\n\nFor ASSIGN/UNASSIGN, delegates to the service layer which owns the\nidempotence rules, edit-rights validation and the undo window.\nFor IM, persists the event via the serializer and then re-syncs\nMENTION rows.\n\nReturns 204 when the service decides nothing was new (every\nassignee already assigned, full UNASSIGN absorbed by undo, …).", "parameters": [ { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEventRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadEventRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEvent" } } }, "description": "" } } } }, "/api/v1.0/threads/{thread_id}/events/{id}/": { "get": { "operationId": "threads_events_retrieve", "description": "ViewSet for ThreadEvent model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEvent" } } }, "description": "" } } }, "put": { "operationId": "threads_events_update", "description": "ViewSet for ThreadEvent model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEventRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadEventRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEvent" } } }, "description": "" } } }, "patch": { "operationId": "threads_events_partial_update", "description": "ViewSet for ThreadEvent model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedThreadEventRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedThreadEventRequest" } } } }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadEvent" } } }, "description": "" } } }, "delete": { "operationId": "threads_events_destroy", "description": "ViewSet for ThreadEvent model.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "security": [ { "cookieAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/v1.0/threads/{thread_id}/events/{id}/read-mention/": { "patch": { "operationId": "threads_events_read_mention_partial_update", "description": "Mark the current user's unread MENTION on this ThreadEvent as read.\n\nReturns 204 even when no UserEvent matches (idempotent); the thread\nevent itself is resolved via the standard ``get_object`` lookup so a\nmissing event yields 404.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "required": true }, { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-events" ], "security": [ { "cookieAuth": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "Thread event not found" } } } }, "/api/v1.0/threads/{thread_id}/users/": { "get": { "operationId": "threads_users_list", "description": "List distinct users who have access to a thread (via ThreadAccess → Mailbox → MailboxAccess).", "parameters": [ { "in": "path", "name": "thread_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "thread-users" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadMentionableUser" } } } }, "description": "" } } } }, "/api/v1.0/threads/bulk-delete/": { "post": { "operationId": "threads_bulk_delete_create", "description": "Permanently delete (hard-delete) draft messages within the given accessible and editable threads. A thread emptied by the deletion is removed; otherwise its stats are recomputed.", "tags": [ "threads" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadBulkDeleteRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThreadBulkDeleteRequestRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "deleted_count": { "type": "integer" } }, "required": [ "success", "deleted_count" ] } } }, "description": "Messages permanently deleted." }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "Missing or invalid parameters." }, "401": { "description": "Authentication credentials were not provided or are invalid." }, "403": { "description": "You do not have permission to delete drafts in one or more targeted threads." } } } }, "/api/v1.0/threads/stats/": { "get": { "operationId": "threads_stats_retrieve", "description": "Get aggregated statistics for threads based on filters.", "parameters": [ { "in": "query", "name": "has_archived", "schema": { "type": "integer" }, "description": "Filter threads that are archived (1=true, 0=false)." }, { "in": "query", "name": "has_assigned_to_me", "schema": { "type": "integer" }, "description": "Filter threads assigned to the current user (1=true, 0=false)." }, { "in": "query", "name": "has_attachments", "schema": { "type": "integer" }, "description": "Filter threads with attachments (1=true, 0=false)." }, { "in": "query", "name": "has_delivery_pending", "schema": { "type": "integer" }, "description": "Filter threads with delivery pending messages: sending, retry or failed (1=true, 0=false)." }, { "in": "query", "name": "has_draft", "schema": { "type": "integer" }, "description": "Filter threads with draft messages (1=true, 0=false)." }, { "in": "query", "name": "has_mention", "schema": { "type": "integer" }, "description": "Filter threads with any mention (read or unread) for the current user (1=true, 0=false)." }, { "in": "query", "name": "has_sender", "schema": { "type": "integer" }, "description": "Filter threads with messages sent by the user (1=true, 0=false)." }, { "in": "query", "name": "has_starred", "schema": { "type": "integer" }, "description": "Filter threads with starred messages (1=true, 0=false)." }, { "in": "query", "name": "has_trashed", "schema": { "type": "integer" }, "description": "Filter threads that are trashed (1=true, 0=false)." }, { "in": "query", "name": "has_unassigned", "schema": { "type": "integer" }, "description": "Filter threads with no active assignment from any user (1=true, 0=false)." }, { "in": "query", "name": "has_unread_mention", "schema": { "type": "integer" }, "description": "Filter threads with unread mentions for the current user (1=true, 0=false)." }, { "in": "query", "name": "label_slug", "schema": { "type": "string" }, "description": "Filter threads by label slug." }, { "in": "query", "name": "mailbox_id", "schema": { "type": "string", "format": "uuid" }, "description": "Filter threads by mailbox ID." }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Search threads by content (subject, sender, recipients, message body)." }, { "in": "query", "name": "stats_fields", "schema": { "type": "string", "enum": [ "all", "all_unread", "has_assigned_to_me", "has_delivery_failed", "has_delivery_pending", "has_mention", "has_unassigned", "has_unread_mention" ] }, "description": "Comma-separated list of fields to aggregate.\n Special values: 'all' (count all threads), 'all_unread' (count all unread threads).\n Boolean fields: has_trashed, has_draft, has_starred, has_attachments, has_archived,\n has_sender, has_active, has_delivery_pending, has_delivery_failed, is_spam, has_messages, has_unread_mention, has_mention, has_assigned_to_me, has_unassigned.\n Unread variants ('_unread' suffix): count threads where the condition is true AND the thread is unread.\n Examples: 'all,all_unread', 'has_starred,has_starred_unread', 'is_spam,is_spam_unread'", "required": true, "explode": false, "style": "form" } ], "tags": [ "threads" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "description": "A dictionary containing the aggregated counts. Keys correspond to the fields requested via the `stats_fields` query parameter. Each value is an integer count. Keys not requested will not be present in the response." }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "Returned if `stats_fields` parameter is missing or contains invalid fields." } } } }, "/api/v1.0/users/": { "get": { "operationId": "users_list", "description": "List users.\nSearch users by email, full name or maildomain.\nA search query of at least 3 characters is required.", "parameters": [ { "in": "query", "name": "maildomain_pk", "schema": { "type": "string", "format": "uuid" }, "description": "Filter users by maildomain." }, { "in": "query", "name": "q", "schema": { "type": "string" }, "description": "Search users by full name, short name or email." } ], "tags": [ "admin-users-list" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithoutAbilities" } } } }, "description": "" } } } }, "/api/v1.0/users/me/": { "get": { "operationId": "users_me_retrieve", "description": "Return information on currently logged user", "tags": [ "users" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithAbilities" } } }, "description": "" }, "401": { "description": "Authentication credentials were not provided or are invalid." } } } }, "/api/v1.0/users/me/channels/": { "get": { "operationId": "users_me_channels_list", "description": "Manage personal (scope_level=user) integration channels", "tags": [ "channels" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } } } }, "description": "" } } }, "post": { "operationId": "users_me_channels_create", "description": "Manage personal (scope_level=user) integration channels", "tags": [ "channels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserChannelCreateRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserChannelCreateRequestRequest" } } } }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channel" } } }, "description": "Existing push device refreshed (idempotent re-register)." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelCreateResponse" } } }, "description": "Channel created (or push device registered)." } } } }, "/api/v1.0/users/me/channels/{id}/": { "get": { "operationId": "users_me_channels_retrieve", "description": "Manage personal (scope_level=user) integration channels", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "channels" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channel" } } }, "description": "" } } }, "put": { "operationId": "users_me_channels_update", "description": "Manage personal (scope_level=user) integration channels", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "channels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChannelRequest" } } }, "required": true }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channel" } } }, "description": "Channel updated successfully" }, "400": { "description": "Invalid input data" }, "403": { "description": "Permission denied" }, "404": { "description": "Channel not found" } } }, "patch": { "operationId": "users_me_channels_partial_update", "description": "Manage personal (scope_level=user) integration channels", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "channels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedChannelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedChannelRequest" } } } }, "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channel" } } }, "description": "" } } }, "delete": { "operationId": "users_me_channels_destroy", "description": "Manage personal (scope_level=user) integration channels", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "channels" ], "security": [ { "cookieAuth": [] } ], "responses": { "204": { "description": "Channel deleted successfully" }, "403": { "description": "Permission denied" }, "404": { "description": "Channel not found" } } } }, "/api/v1.0/users/me/channels/{id}/regenerate-secret/": { "post": { "operationId": "users_me_channels_regenerate_secret_create", "description": "Manage personal (scope_level=user) integration channels", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "channels" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegeneratedSecretResponse" } } }, "description": "Rotates the channel's secret. Single-active: the previous credential is invalidated immediately. The response carries exactly one of ``api_key`` / ``secret`` matching the channel's type (and, for webhooks, its current ``auth_method``)." }, "400": { "description": "Channel type has no rotatable secret" }, "403": { "description": "Permission denied" }, "404": { "description": "Channel not found" } } } } }, "components": { "schemas": { "Attachment": { "type": "object", "description": "Serialize attachments.", "properties": { "blobId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "readOnly": true, "title": "File name", "description": "Original filename of the attachment" }, "size": { "type": "integer", "description": "Return the size of the associated blob.", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "sha256": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "cid": { "type": "string", "readOnly": true, "nullable": true, "description": "Content-ID for inline images" } }, "required": [ "blobId", "cid", "created_at", "name", "sha256", "size", "type" ] }, "CalendarAddEventRequestRequest": { "type": "object", "properties": { "ics_data": { "type": "string", "minLength": 1, "description": "Raw ICS content of the event" }, "calendar_id": { "type": "string", "nullable": true, "minLength": 1, "description": "Optional specific calendar URL" } }, "required": [ "ics_data" ] }, "CalendarAddEventResponse": { "type": "object", "properties": { "task_id": { "type": "string" } }, "required": [ "task_id" ] }, "CalendarConflictsRequestRequest": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Start of the time range (ISO 8601)" }, "end": { "type": "string", "format": "date-time", "description": "End of the time range (ISO 8601)" }, "exclude_uid": { "type": "string", "nullable": true, "description": "Optional UID of an event to exclude from conflicts (avoids flagging prior imports of the same invite)." } }, "required": [ "end", "start" ] }, "CalendarConflictsResponse": { "type": "object", "properties": { "conflicts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "existing_partstats": { "type": "object", "additionalProperties": { "type": "string" }, "description": "PARTSTAT per attendee identity (calendar owner email, lowercased) on the prior copy of ``exclude_uid``. Lets the UI pre-select the right prior RSVP for the *selected* calendar when a mailbox can act through several attendee-owned calendars." } }, "required": [ "conflicts", "existing_partstats" ] }, "CalendarListResponse": { "type": "object", "properties": { "calendars": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "web_url": { "type": "string", "nullable": true, "description": "Public URL of the calendar web UI, if configured." }, "configured": { "type": "boolean", "description": "True when a CalDAV service is configured for this mailbox (per-mailbox channel or deployment default). False means the integration is disabled." } }, "required": [ "calendars", "configured", "web_url" ] }, "CalendarRsvpRequestRequest": { "type": "object", "properties": { "ics_data": { "type": "string", "minLength": 1, "description": "Raw ICS content of the event" }, "response": { "allOf": [ { "$ref": "#/components/schemas/ResponseEnum" } ], "description": "RSVP response\n\n* `ACCEPTED` - ACCEPTED\n* `DECLINED` - DECLINED\n* `TENTATIVE` - TENTATIVE" }, "calendar_id": { "type": "string", "nullable": true, "minLength": 1, "description": "Optional specific calendar URL" } }, "required": [ "ics_data", "response" ] }, "CalendarRsvpResponse": { "type": "object", "properties": { "task_id": { "type": "string" } }, "required": [ "task_id" ] }, "ChangeFlagRequestRequest": { "type": "object", "properties": { "flag": { "$ref": "#/components/schemas/FlagEnum" }, "value": { "type": "boolean" }, "message_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of message UUIDs to apply the flag change to." }, "thread_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of thread UUIDs where all messages should have the flag change applied." }, "mailbox_id": { "type": "string", "format": "uuid", "description": "Mailbox UUID. Required when flag is 'unread' or 'starred'." }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp up to which messages are considered read. When provided with flag='unread', sets ThreadAccess.read_at directly. null means nothing has been read (all messages unread)." }, "starred_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when the thread was starred. When provided with flag='starred' and value=true, sets ThreadAccess.starred_at. null or value=false removes the starred flag." } }, "required": [ "flag", "value" ] }, "Channel": { "type": "object", "description": "Serialize Channel model.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "description": "Human-readable name for this channel", "maxLength": 255 }, "type": { "type": "string", "description": "Type of channel", "maxLength": 255 }, "scope_level": { "allOf": [ { "$ref": "#/components/schemas/ScopeLevelEnum" } ], "readOnly": true }, "is_active": { "type": "boolean", "title": "Active", "description": "Uncheck to pause this channel without deleting it." }, "settings": { "description": "Channel-specific configuration settings" }, "mailbox": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "maildomain": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "user": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "last_used_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "token_hash": { "type": "string", "nullable": true, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "last_used_at", "mailbox", "maildomain", "name", "scope_level", "token_hash", "type", "updated_at", "user" ] }, "ChannelCreateResponse": { "type": "object", "description": "Schema-only view of the channel-create 201 response.\n\n``ChannelViewSet.create`` returns the full ``ChannelSerializer``\npayload plus the freshly-minted plaintext credentials — surfaced\nexactly once on creation and never retrievable again. They are\ndeclared here as read-only fields so generated API clients see them\nin the OpenAPI schema. This serializer is never used to serialize a\nresponse directly; the view assembles the body by hand.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "description": "Human-readable name for this channel", "maxLength": 255 }, "type": { "type": "string", "description": "Type of channel", "maxLength": 255 }, "scope_level": { "allOf": [ { "$ref": "#/components/schemas/ScopeLevelEnum" } ], "readOnly": true }, "is_active": { "type": "boolean", "title": "Active", "description": "Uncheck to pause this channel without deleting it." }, "settings": { "description": "Channel-specific configuration settings" }, "mailbox": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "maildomain": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "user": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "last_used_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "token_hash": { "type": "string", "nullable": true, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "api_key": { "type": "string", "description": "Plaintext API key — api_key channels and webhook channels with auth_method=api_key." }, "secret": { "type": "string", "description": "webhook channels with auth_method=jwt — the HMAC/JWT signing secret." } }, "required": [ "created_at", "id", "last_used_at", "mailbox", "maildomain", "name", "scope_level", "token_hash", "type", "updated_at", "user" ] }, "ChannelRequest": { "type": "object", "description": "Serialize Channel model.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Human-readable name for this channel", "maxLength": 255 }, "type": { "type": "string", "minLength": 1, "description": "Type of channel", "maxLength": 255 }, "is_active": { "type": "boolean", "title": "Active", "description": "Uncheck to pause this channel without deleting it." }, "settings": { "description": "Channel-specific configuration settings" } }, "required": [ "name", "type" ] }, "Contact": { "type": "object", "description": "Serialize contacts.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "nullable": true, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 254 } }, "required": [ "email", "id" ] }, "DNSCheckResponse": { "type": "object", "properties": { "domain": { "type": "string" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DNSRecordCheck" } } }, "required": [ "domain", "records" ] }, "DNSCheckResult": { "type": "object", "properties": { "status": { "type": "string" }, "found": { "type": "array", "items": { "type": "string" } }, "error": { "type": "string" } }, "required": [ "status" ] }, "DNSRecordCheck": { "type": "object", "properties": { "target": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "_check": { "allOf": [ { "$ref": "#/components/schemas/DNSCheckResult" } ], "title": " check" } }, "required": [ "_check", "target", "type", "value" ] }, "DeliveryStatusUpdateResponse": { "type": "object", "properties": { "updated_count": { "type": "integer" } }, "required": [ "updated_count" ] }, "DraftMessageRequestRequest": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid", "nullable": true, "description": "Message ID if updating an existing draft" }, "parentId": { "type": "string", "format": "uuid", "nullable": true, "description": "Message ID if replying to an existing message" }, "senderId": { "type": "string", "format": "uuid", "description": "Mailbox ID to use as sender" }, "subject": { "type": "string", "nullable": true, "description": "Subject of the message (optional; empty or null allowed)" }, "draftBody": { "type": "string", "description": "Content of the draft message as arbitrary text (usually JSON)" }, "to": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 }, "description": "List of recipient email addresses" }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 }, "description": "List of CC recipient email addresses" }, "bcc": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 }, "description": "List of BCC recipient email addresses" }, "attachments": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "List of attachment objects with blobId, partId, and name" }, "signatureId": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the signature template to use" } }, "required": [ "senderId" ] }, "DriveUploadAttachmentRequest": { "type": "object", "properties": { "blob_id": { "type": "string", "minLength": 1, "description": "ID of the attachment to upload (format: msg_{message_id}_{attachment_index})" } }, "required": [ "blob_id" ] }, "FlagEnum": { "enum": [ "unread", "starred", "trashed", "archived", "spam" ], "type": "string", "description": "* `unread` - unread\n* `starred` - starred\n* `trashed` - trashed\n* `archived` - archived\n* `spam` - spam" }, "ImportCreateRequest": { "type": "object", "description": "Body of ``POST /mailboxes/{id}/imports/`` — starts a file or IMAP import.\n\nThe target mailbox comes from the URL. ``source`` discriminates: ``file``\nneeds the ``file_key`` returned by the upload endpoint (unique per upload —\nnothing in the bucket is ever overwritten) plus the original ``filename``\n(display + MIME-type hint); ``imap`` needs the connection fields.\n``continuous`` mode is IMAP-only. Read-only run state is returned via\n``ImportRunSerializer``.", "properties": { "source": { "allOf": [ { "$ref": "#/components/schemas/SourceEnum" } ], "description": "'file' (an uploaded archive — the backend sniffs eml/mbox/pst) or 'imap' (a live server).\n\n* `file` - file\n* `imap` - imap" }, "file_key": { "type": "string", "minLength": 1, "description": "Storage key returned when the archive was uploaded." }, "filename": { "type": "string", "minLength": 1, "description": "Original archive filename (display + MIME-type hint)." }, "imap_server": { "type": "string", "minLength": 1 }, "imap_port": { "type": "integer", "maximum": 65535, "minimum": 1 }, "username": { "type": "string", "minLength": 1 }, "password": { "type": "string", "writeOnly": true, "minLength": 1 }, "use_ssl": { "type": "boolean", "default": true }, "mode": { "allOf": [ { "$ref": "#/components/schemas/ModeEnum" } ], "default": "oneshot" } }, "required": [ "source" ] }, "ImportRun": { "type": "object", "description": "Read-only view of an import run (a ``Channel`` with type=import).\n\nProgress lives in Redis and terminal state on the channel; the serializer\nreads the merged view so the frontend can poll the import resource\n(``GET /mailboxes/{id}/imports/{id}/``) instead of the raw Celery task state.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "readOnly": true, "description": "Human-readable name for this channel" }, "mailbox": { "type": "string", "format": "uuid", "description": "Mailbox that receives messages from this channel", "readOnly": true, "nullable": true }, "is_active": { "type": "boolean", "readOnly": true, "title": "Active", "description": "Uncheck to pause this channel without deleting it." }, "status": { "type": "string", "nullable": true, "readOnly": true }, "source_type": { "type": "string", "nullable": true, "readOnly": true }, "mode": { "type": "string", "nullable": true, "readOnly": true }, "poll_interval": { "type": "integer", "nullable": true, "readOnly": true }, "imap_username": { "type": "string", "nullable": true, "readOnly": true }, "total_messages": { "type": "integer", "readOnly": true }, "success_count": { "type": "integer", "readOnly": true }, "failure_count": { "type": "integer", "readOnly": true }, "failure_reasons": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true, "readOnly": true }, "progress": { "type": "number", "format": "double", "readOnly": true }, "error": { "type": "string", "nullable": true, "readOnly": true }, "started_at": { "type": "string", "nullable": true, "readOnly": true }, "finished_at": { "type": "string", "nullable": true, "readOnly": true }, "last_used_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Operational timestamp updated (throttled) whenever the channel is used." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "error", "failure_count", "failure_reasons", "finished_at", "id", "imap_username", "is_active", "last_used_at", "mailbox", "mode", "name", "poll_interval", "progress", "source_type", "started_at", "status", "success_count", "total_messages", "updated_at" ] }, "Label": { "type": "object", "description": "Serializer for Label model.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "description": "Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')", "maxLength": 255 }, "slug": { "type": "string", "readOnly": true, "description": "URL-friendly version of the name", "pattern": "^[-a-zA-Z0-9_]+$" }, "color": { "type": "string", "description": "Color of the label in hex format (e.g. #FF0000)", "maxLength": 7 }, "display_name": { "type": "string", "readOnly": true }, "mailbox": { "type": "string", "format": "uuid", "description": "Mailbox that owns this label" }, "threads": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Threads that have this label" }, "description": { "type": "string", "description": "Description of the label, used by AI to understand its purpose", "maxLength": 255 }, "is_auto": { "type": "boolean", "title": "Auto labeling", "description": "Whether this label should be automatically applied by AI" } }, "required": [ "display_name", "id", "mailbox", "name", "slug" ] }, "LabelRequest": { "type": "object", "description": "Serializer for Label model.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')", "maxLength": 255 }, "color": { "type": "string", "minLength": 1, "description": "Color of the label in hex format (e.g. #FF0000)", "maxLength": 7 }, "mailbox": { "type": "string", "format": "uuid", "description": "Mailbox that owns this label" }, "threads": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Threads that have this label" }, "description": { "type": "string", "description": "Description of the label, used by AI to understand its purpose", "maxLength": 255 }, "is_auto": { "type": "boolean", "title": "Auto labeling", "description": "Whether this label should be automatically applied by AI" } }, "required": [ "mailbox", "name" ] }, "MailDomainAccessRoleChoices": { "type": "string", "enum": [ "admin" ] }, "MailDomainAdmin": { "type": "object", "description": "Serialize mail domains for admin view.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "expected_dns_records": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "target": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "target", "type", "value" ] }, "readOnly": true }, "mailbox_count": { "type": "string", "readOnly": true }, "identity_sync": { "type": "boolean", "readOnly": true, "description": "Sync mailboxes to an identity provider." }, "abilities": { "type": "object", "description": "Instance permissions and capabilities", "properties": { "get": { "type": "boolean", "description": "Can read" }, "post": { "type": "boolean", "description": "Can create" }, "put": { "type": "boolean", "description": "Can update" }, "patch": { "type": "boolean", "description": "Can partially update" }, "delete": { "type": "boolean", "description": "Can delete" }, "manage_accesses": { "type": "boolean", "description": "Can manage accesses" }, "manage_mailboxes": { "type": "boolean", "description": "Can manage mailboxes" } }, "required": [ "get", "post", "put", "patch", "delete", "manage_accesses", "manage_mailboxes" ], "readOnly": true } }, "required": [ "abilities", "created_at", "expected_dns_records", "id", "identity_sync", "mailbox_count", "name", "updated_at" ] }, "MailDomainAdminWrite": { "type": "object", "description": "Serialize mail domains for creating / editing admin view.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$", "maxLength": 253 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "oidc_autojoin": { "type": "boolean", "description": "Create mailboxes automatically based on OIDC emails." }, "identity_sync": { "type": "boolean", "description": "Sync mailboxes to an identity provider." }, "custom_attributes": { "description": "Metadata to sync to the maildomain group in the identity provider." } }, "required": [ "created_at", "id", "name", "updated_at" ] }, "MailDomainAdminWriteRequest": { "type": "object", "description": "Serialize mail domains for creating / editing admin view.", "properties": { "name": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$", "maxLength": 253 }, "oidc_autojoin": { "type": "boolean", "description": "Create mailboxes automatically based on OIDC emails." }, "identity_sync": { "type": "boolean", "description": "Sync mailboxes to an identity provider." }, "custom_attributes": { "description": "Metadata to sync to the maildomain group in the identity provider." } }, "required": [ "name" ] }, "Mailbox": { "type": "object", "description": "Serialize mailboxes.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "email": { "type": "string", "readOnly": true }, "name": { "type": "string", "nullable": true, "description": "Return the display name of the mailbox (its contact name).", "readOnly": true }, "domain_id": { "type": "string", "format": "uuid", "readOnly": true }, "is_identity": { "type": "boolean", "readOnly": true, "description": "Whether this mailbox identifies a person (i.e. is not an alias or a group)" }, "is_shared": { "type": "boolean", "description": "Return True if the mailbox is shared (non-identity or has more than one access).\n\nDrives mailbox-level UI gating for collaboration features (assignment\nsub-folders, mention folder) that have no purpose in a mono-user\nidentity mailbox.", "readOnly": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/MailboxRoleChoices" } ], "nullable": true, "readOnly": true }, "count_unread_threads": { "type": "integer", "description": "Return the number of threads with unread messages in the mailbox.", "readOnly": true }, "count_threads": { "type": "integer", "description": "Return the number of threads in the mailbox.", "readOnly": true }, "count_delivering": { "type": "integer", "description": "Return the number of threads with messages being delivered.", "readOnly": true }, "count_unread_mentions": { "type": "integer", "description": "Return the number of threads with unread mentions for the current user.", "readOnly": true }, "count_assigned": { "type": "integer", "description": "Return the number of threads in this mailbox currently assigned to the current user.", "readOnly": true }, "abilities": { "type": "object", "description": "Instance permissions and capabilities", "properties": { "get": { "type": "boolean", "description": "Can read" }, "post": { "type": "boolean", "description": "Can create" }, "put": { "type": "boolean", "description": "Can update" }, "patch": { "type": "boolean", "description": "Can partially update" }, "delete": { "type": "boolean", "description": "Can delete" }, "manage_accesses": { "type": "boolean", "description": "Can manage accesses" }, "view_messages": { "type": "boolean", "description": "Can view mailbox messages" }, "send_messages": { "type": "boolean", "description": "Can send messages from mailbox" }, "manage_labels": { "type": "boolean", "description": "Can manage mailbox labels" }, "manage_message_templates": { "type": "boolean", "description": "Can manage mailbox message templates" }, "import_messages": { "type": "boolean", "description": "Can import messages" } }, "required": [ "get", "post", "put", "patch", "delete", "manage_accesses", "view_messages", "send_messages", "manage_labels", "manage_message_templates", "import_messages" ], "readOnly": true } }, "required": [ "abilities", "count_assigned", "count_delivering", "count_threads", "count_unread_mentions", "count_unread_threads", "domain_id", "email", "id", "is_identity", "is_shared", "name", "role" ] }, "MailboxAccessNestedUser": { "type": "object", "description": "Serialize MailboxAccess for nesting within MailboxAdminSerializer.\nShows user details and their role on the mailbox.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "user": { "allOf": [ { "$ref": "#/components/schemas/UserWithoutAbilities" } ], "readOnly": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/MailboxRoleChoices" } ], "readOnly": true } }, "required": [ "id", "role", "user" ] }, "MailboxAccessRead": { "type": "object", "description": "Serialize mailbox access information for read operations with nested user details.\nMailbox context is implied by the URL, so mailbox details are not included here.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "user_details": { "allOf": [ { "$ref": "#/components/schemas/UserWithoutAbilities" } ], "readOnly": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/MailboxRoleChoices" } ], "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "role", "updated_at", "user_details" ] }, "MailboxAccessWrite": { "type": "object", "description": "Serializer for creating and updating mailbox access records.\nMailbox is set from the view based on URL parameters.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "user": { "type": "string", "format": "uuid", "description": "User ID (UUID) or email address" }, "role": { "$ref": "#/components/schemas/MailboxRoleChoices" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "role", "updated_at", "user" ] }, "MailboxAccessWriteRequest": { "type": "object", "description": "Serializer for creating and updating mailbox access records.\nMailbox is set from the view based on URL parameters.", "properties": { "user": { "type": "string", "format": "uuid", "description": "User ID (UUID) or email address" }, "role": { "$ref": "#/components/schemas/MailboxRoleChoices" } }, "required": [ "role", "user" ] }, "MailboxAdmin": { "type": "object", "description": "Serialize Mailbox details for admin view, including users with access.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "local_part": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$", "maxLength": 64 }, "domain_name": { "type": "string", "readOnly": true }, "is_identity": { "type": "boolean", "readOnly": true, "description": "Whether this mailbox identifies a person (i.e. is not an alias or a group)" }, "alias_of": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "nullable": true }, "accesses": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxAccessNestedUser" }, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "can_reset_password": { "type": "boolean", "readOnly": true }, "contact": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "readOnly": true, "nullable": true }, "last_accessed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Most recent ``accessed_at`` across all mailbox accesses." }, "has_mandatory_totp": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Whether the Keycloak user backing this mailbox carries the KEYCLOAK_TOTP_ROLE_ID realm role. ``null`` when the feature is disabled or the role id isn't configured." } }, "required": [ "accesses", "can_reset_password", "contact", "created_at", "domain_name", "has_mandatory_totp", "id", "is_identity", "last_accessed_at", "local_part", "updated_at" ] }, "MailboxAdminCreate": { "type": "object", "description": "Serialize Mailbox details for create admin endpoint, including users with access and\nmetadata.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "local_part": { "type": "string", "readOnly": true }, "domain_name": { "type": "string", "readOnly": true }, "is_identity": { "type": "boolean", "readOnly": true, "description": "Whether this mailbox identifies a person (i.e. is not an alias or a group)" }, "alias_of": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "nullable": true }, "accesses": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxAccessNestedUser" }, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "can_reset_password": { "type": "boolean", "readOnly": true }, "contact": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "readOnly": true, "nullable": true }, "last_accessed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Most recent ``accessed_at`` across all mailbox accesses." }, "has_mandatory_totp": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Whether the Keycloak user backing this mailbox carries the KEYCLOAK_TOTP_ROLE_ID realm role. ``null`` when the feature is disabled or the role id isn't configured." }, "one_time_password": { "type": "string", "nullable": true, "description": "Fake method just to make the OpenAPI schema valid.", "readOnly": true } }, "required": [ "accesses", "can_reset_password", "contact", "created_at", "domain_name", "has_mandatory_totp", "id", "is_identity", "last_accessed_at", "local_part", "one_time_password", "updated_at" ] }, "MailboxAdminCreateMetadataRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MailboxAdminCreateMetadataTypeEnum" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "custom_attributes": {} }, "required": [ "type" ] }, "MailboxAdminCreateMetadataTypeEnum": { "enum": [ "personal", "shared", "redirect" ], "type": "string", "description": "* `personal` - personal\n* `shared` - shared\n* `redirect` - redirect" }, "MailboxAdminCreatePayloadRequest": { "type": "object", "properties": { "local_part": { "type": "string", "minLength": 1 }, "alias_of": { "type": "string", "format": "uuid" }, "metadata": { "$ref": "#/components/schemas/MailboxAdminCreateMetadataRequest" } }, "required": [ "local_part", "metadata" ] }, "MailboxAdminMandatoryTotpPayloadRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "MailboxAdminMandatoryTotpResponse": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "MailboxAdminResetTotpResponse": { "type": "object", "properties": { "removed_credentials": { "type": "integer" } }, "required": [ "removed_credentials" ] }, "MailboxAdminUpdateMetadataRequest": { "type": "object", "properties": { "full_name": { "type": "string" }, "name": { "type": "string" }, "custom_attributes": {} } }, "MailboxLight": { "type": "object", "description": "Serializer for mailbox details in thread access.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "email": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "is_identity": { "type": "boolean", "readOnly": true, "description": "Whether this mailbox identifies a person (i.e. is not an alias or a group)" } }, "required": [ "email", "id", "is_identity", "name" ] }, "MailboxRoleChoices": { "type": "string", "enum": [ "viewer", "editor", "sender", "admin" ] }, "MaildomainAccessRead": { "type": "object", "description": "Serialize maildomain access information for read operations with nested user details.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "user": { "allOf": [ { "$ref": "#/components/schemas/UserWithoutAbilities" } ], "readOnly": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/MailDomainAccessRoleChoices" } ], "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "role", "updated_at", "user" ] }, "MaildomainAccessWrite": { "type": "object", "description": "Serializer for creating and updating maildomain access records.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "user": { "type": "string", "format": "uuid", "description": "User ID (UUID) or email address" }, "role": { "$ref": "#/components/schemas/MailDomainAccessRoleChoices" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "role", "updated_at", "user" ] }, "MaildomainAccessWriteRequest": { "type": "object", "description": "Serializer for creating and updating maildomain access records.", "properties": { "user": { "type": "string", "format": "uuid", "description": "User ID (UUID) or email address" }, "role": { "$ref": "#/components/schemas/MailDomainAccessRoleChoices" } }, "required": [ "role", "user" ] }, "Message": { "type": "object", "description": "Serialize messages, getting parsed details from the Message model.\nAligns field names with JMAP where appropriate (textBody, htmlBody, to, cc, bcc).", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "parent_id": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true }, "thread_id": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true }, "subject": { "type": "string", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "htmlBody": { "type": "array", "items": { "$ref": "#/components/schemas/MessageBodyItem" }, "readOnly": true }, "textBody": { "type": "array", "items": { "$ref": "#/components/schemas/MessageBodyItem" }, "readOnly": true }, "draftBody": { "type": "string", "nullable": true, "readOnly": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "readOnly": true }, "sender": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "readOnly": true }, "sender_user": { "allOf": [ { "$ref": "#/components/schemas/MessageSenderUser" } ], "readOnly": true, "nullable": true }, "to": { "type": "array", "items": { "$ref": "#/components/schemas/MessageRecipient" }, "readOnly": true }, "cc": { "type": "array", "items": { "$ref": "#/components/schemas/MessageRecipient" }, "readOnly": true }, "bcc": { "type": "array", "items": { "$ref": "#/components/schemas/MessageRecipient" }, "readOnly": true }, "sent_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "is_sender": { "type": "boolean", "readOnly": true }, "is_draft": { "type": "boolean", "readOnly": true }, "is_unread": { "type": "boolean", "readOnly": true }, "is_trashed": { "type": "boolean", "readOnly": true }, "is_archived": { "type": "boolean", "readOnly": true }, "has_attachments": { "type": "boolean", "readOnly": true }, "mime_id": { "type": "string", "readOnly": true, "nullable": true }, "signature": { "allOf": [ { "$ref": "#/components/schemas/ReadMessageTemplate" } ], "nullable": true, "readOnly": true }, "stmsg_headers": { "type": "object", "additionalProperties": {}, "description": "Return the STMSG headers of the message.", "readOnly": true } }, "required": [ "attachments", "bcc", "cc", "created_at", "draftBody", "has_attachments", "htmlBody", "id", "is_archived", "is_draft", "is_sender", "is_trashed", "is_unread", "mime_id", "parent_id", "sender", "sender_user", "sent_at", "signature", "stmsg_headers", "subject", "textBody", "thread_id", "to", "updated_at" ] }, "MessageBodyItem": { "type": "object", "description": "Message body item serializer.", "properties": { "partId": { "type": "string" }, "type": { "type": "string" }, "content": { "type": "string" } }, "required": [ "content", "partId", "type" ] }, "MessageDeliveryStatusChoices": { "type": "string", "enum": [ "internal", "sent", "failed", "retry", "cancelled" ] }, "MessageRecipient": { "type": "object", "description": "Serialize message recipients.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "contact": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "readOnly": true }, "delivery_status": { "allOf": [ { "$ref": "#/components/schemas/MessageDeliveryStatusChoices" } ], "readOnly": true, "nullable": true }, "delivery_message": { "type": "string", "readOnly": true, "nullable": true }, "retry_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "delivered_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "contact", "delivered_at", "delivery_message", "delivery_status", "id", "retry_at" ] }, "MessageSenderUser": { "type": "object", "description": "Lightweight serializer for the user who sent a message.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "full_name": { "type": "string", "readOnly": true, "nullable": true }, "email": { "type": "string", "format": "email", "readOnly": true, "nullable": true, "title": "Identity email address" } }, "required": [ "email", "full_name", "id" ] }, "MessageTemplate": { "type": "object", "description": "Serialize message templates for POST/PUT/PATCH operations.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "description": "Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')", "maxLength": 255 }, "html_body": { "type": "string" }, "text_body": { "type": "string" }, "raw_body": { "type": "string" }, "type": { "$ref": "#/components/schemas/MessageTemplateTypeChoices" }, "is_active": { "type": "boolean", "description": "Whether this template is available for use" }, "is_forced": { "type": "boolean", "default": false, "description": "Set as forced template" }, "is_default": { "type": "boolean", "default": false, "description": "Set as default template (auto-loaded when composing a new message)" }, "metadata": { "type": "object", "additionalProperties": true }, "signature_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "name", "type", "updated_at" ] }, "MessageTemplateRequest": { "type": "object", "description": "Serialize message templates for POST/PUT/PATCH operations.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')", "maxLength": 255 }, "html_body": { "type": "string", "minLength": 1 }, "text_body": { "type": "string", "minLength": 1 }, "raw_body": { "type": "string", "minLength": 1 }, "type": { "$ref": "#/components/schemas/MessageTemplateTypeChoices" }, "is_active": { "type": "boolean", "description": "Whether this template is available for use" }, "is_forced": { "type": "boolean", "default": false, "description": "Set as forced template" }, "is_default": { "type": "boolean", "default": false, "description": "Set as default template (auto-loaded when composing a new message)" }, "metadata": { "type": "object", "additionalProperties": true }, "signature_id": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "name", "type" ] }, "MessageTemplateTypeChoices": { "type": "string", "enum": [ "message", "signature", "autoreply" ] }, "ModeEnum": { "enum": [ "oneshot", "continuous" ], "type": "string", "description": "* `oneshot` - oneshot\n* `continuous` - continuous" }, "PaginatedDriveItemResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PartialDriveItem" } } }, "required": [ "count", "next", "previous", "results" ] }, "PaginatedMailDomainAdminList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MailDomainAdmin" } } } }, "PaginatedMailboxAccessReadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxAccessRead" } } } }, "PaginatedMailboxAdminList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxAdmin" } } } }, "PaginatedThreadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } } } }, "PartialDriveItem": { "type": "object", "description": "Serializer for Drive Item resource (OpenAPI purpose only...).\nIt supports partially the Drive Item resource response structure.\nWe declare only fields that are useful in the Messages context.", "properties": { "id": { "type": "string", "format": "uuid" }, "filename": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "filename", "id", "mimetype", "size" ] }, "PatchedChannelRequest": { "type": "object", "description": "Serialize Channel model.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Human-readable name for this channel", "maxLength": 255 }, "type": { "type": "string", "minLength": 1, "description": "Type of channel", "maxLength": 255 }, "is_active": { "type": "boolean", "title": "Active", "description": "Uncheck to pause this channel without deleting it." }, "settings": { "description": "Channel-specific configuration settings" } } }, "PatchedImportUpdateRequest": { "type": "object", "description": "Body of ``PATCH /mailboxes/{id}/imports/{id}/`` — change how a run runs.\n\nBoth fields optional (partial). ``mode=continuous`` (re-)arms an IMAP import\nas a poller; ``mode=oneshot`` demotes a continuous poller (stops polling);\n``is_active=false`` pauses a continuous poller (credentials are kept). The\npoll cadence itself is a global operator setting, not settable here.\nValidation is source-aware: only IMAP imports can go continuous.", "properties": { "mode": { "$ref": "#/components/schemas/ModeEnum" }, "is_active": { "type": "boolean" } } }, "PatchedLabelRequest": { "type": "object", "description": "Serializer for Label model.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')", "maxLength": 255 }, "color": { "type": "string", "minLength": 1, "description": "Color of the label in hex format (e.g. #FF0000)", "maxLength": 7 }, "mailbox": { "type": "string", "format": "uuid", "description": "Mailbox that owns this label" }, "threads": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Threads that have this label" }, "description": { "type": "string", "description": "Description of the label, used by AI to understand its purpose", "maxLength": 255 }, "is_auto": { "type": "boolean", "title": "Auto labeling", "description": "Whether this label should be automatically applied by AI" } } }, "PatchedMailboxAccessWriteRequest": { "type": "object", "description": "Serializer for creating and updating mailbox access records.\nMailbox is set from the view based on URL parameters.", "properties": { "user": { "type": "string", "format": "uuid", "description": "User ID (UUID) or email address" }, "role": { "$ref": "#/components/schemas/MailboxRoleChoices" } } }, "PatchedMailboxAdminPartialUpdatePayloadRequest": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/MailboxAdminUpdateMetadataRequest" } } }, "PatchedMailboxNameUpdateRequest": { "type": "object", "description": "Validate and apply a mailbox display-name update (its contact name).", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "PatchedMessageTemplateRequest": { "type": "object", "description": "Serialize message templates for POST/PUT/PATCH operations.", "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')", "maxLength": 255 }, "html_body": { "type": "string", "minLength": 1 }, "text_body": { "type": "string", "minLength": 1 }, "raw_body": { "type": "string", "minLength": 1 }, "type": { "$ref": "#/components/schemas/MessageTemplateTypeChoices" }, "is_active": { "type": "boolean", "description": "Whether this template is available for use" }, "is_forced": { "type": "boolean", "default": false, "description": "Set as forced template" }, "is_default": { "type": "boolean", "default": false, "description": "Set as default template (auto-loaded when composing a new message)" }, "metadata": { "type": "object", "additionalProperties": true }, "signature_id": { "type": "string", "format": "uuid", "nullable": true } } }, "PatchedThreadAccessRequest": { "type": "object", "description": "Serialize thread access information.", "properties": { "thread": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "mailbox": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "role": { "$ref": "#/components/schemas/ThreadAccessRoleChoices" } } }, "PatchedThreadEventRequest": { "type": "object", "description": "Serialize thread event information.", "properties": { "type": { "$ref": "#/components/schemas/ThreadEventTypeEnum" }, "message": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "nullable": true }, "data": { "$ref": "#/components/schemas/ThreadEventDataRequest" } } }, "PlatformEnum": { "enum": [ "apns", "fcm", "web" ], "type": "string", "description": "* `apns` - Apple (APNs)\n* `fcm` - Google (FCM)\n* `web` - Web Push" }, "PushChannelCreateRequest": { "type": "object", "description": "Schema variant of the push registration body for ``POST .../channels/``.\n\nIdentical to ``PushDeviceRegistrationSerializer`` plus the ``type``\ndiscriminator, so the polymorphic create endpoint documents the push shape\n({type:\"push\", platform, token, keys?, name?, app_version?}) alongside the\ngeneric channel shape. Validation at runtime still uses the parent.", "properties": { "platform": { "$ref": "#/components/schemas/PlatformEnum" }, "token": { "type": "string", "minLength": 1, "maxLength": 8192 }, "app_version": { "type": "string", "maxLength": 64 }, "keys": { "$ref": "#/components/schemas/WebPushKeysRequest" }, "name": { "type": "string", "maxLength": 255 }, "type": { "$ref": "#/components/schemas/PushChannelCreateTypeEnum" } }, "required": [ "platform", "token", "type" ] }, "PushChannelCreateTypeEnum": { "enum": [ "push" ], "type": "string", "description": "* `push` - push" }, "ReadMessageTemplate": { "type": "object", "description": "Serialize message templates with dynamic body field inclusion.\n\nBody fields (html_body, text_body, raw_body) are only included when\nexplicitly requested via the ``?bodies=`` query parameter or the\n``body_fields`` keyword argument (for nested usage).\n\nAllowed values: ``raw``, ``html``, ``text`` (comma-separated).\nMapping: ``raw`` → ``raw_body``, ``html`` → ``html_body``, ``text`` → ``text_body``.\n\nWhen neither query param nor kwarg is provided, no body field is returned.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "readOnly": true, "description": "Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')" }, "html_body": { "type": "string", "nullable": true }, "text_body": { "type": "string", "nullable": true }, "raw_body": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/MessageTemplateTypeChoices" }, "is_active": { "type": "boolean", "readOnly": true, "description": "Whether this template is available for use" }, "is_forced": { "type": "boolean", "readOnly": true, "description": "Whether this template is forced; no other template of the same type can be used in the same scope" }, "is_default": { "type": "boolean", "readOnly": true, "description": "Whether this template is the default; it will be automatically loaded when composing a new message" }, "metadata": { "type": "object", "additionalProperties": true }, "signature": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true }, "is_active_autoreply": { "type": "boolean", "nullable": true, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "created_at", "id", "is_active", "is_active_autoreply", "is_default", "is_forced", "name", "signature", "type", "updated_at" ] }, "RegeneratedSecretResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Channel id." }, "api_key": { "type": "string", "description": "Present for ``api_key`` channels and webhook channels with ``auth_method='api_key'`` — the plaintext API key. api_key channels send it as ``X-API-Key`` on inbound API calls; api_key webhooks present it as ``Authorization: Bearer``. Returned ONCE; for api_key webhooks it changes whenever the root rotates." }, "secret": { "type": "string", "description": "Present for webhook channels with ``auth_method='jwt'`` — the freshly minted root receivers use to verify the HMAC sig and JWT." } }, "required": [ "id" ] }, "ResetPasswordError": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "ResetPasswordInternalServerError": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "ResetPasswordNotFound": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "ResetPasswordResponse": { "type": "object", "properties": { "one_time_password": { "type": "string" } }, "required": [ "one_time_password" ] }, "ResponseEnum": { "enum": [ "ACCEPTED", "DECLINED", "TENTATIVE" ], "type": "string", "description": "* `ACCEPTED` - ACCEPTED\n* `DECLINED` - DECLINED\n* `TENTATIVE` - TENTATIVE" }, "ScopeEnum": { "enum": [ "draft" ], "type": "string", "description": "* `draft` - draft" }, "ScopeLevelEnum": { "enum": [ "global", "maildomain", "mailbox", "user" ], "type": "string", "description": "* `global` - Global\n* `maildomain` - Maildomain\n* `mailbox` - Mailbox\n* `user` - User" }, "SendMessageRequest": { "type": "object", "description": "Serializer for sending messages.", "properties": { "messageId": { "type": "string", "format": "uuid" }, "senderId": { "type": "string", "format": "uuid" }, "archive": { "type": "boolean", "default": false }, "textBody": { "type": "string" }, "htmlBody": { "type": "string" } }, "required": [ "messageId", "senderId" ] }, "SendMessageResponse": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "Task ID for tracking" } }, "required": [ "task_id" ] }, "SourceEnum": { "enum": [ "file", "imap" ], "type": "string", "description": "* `file` - file\n* `imap` - imap" }, "StatusEnum": { "enum": [ "FAILURE", "PENDING", "PROGRESS", "RECEIVED", "RETRY", "REVOKED", "STARTED", "SUCCESS" ], "type": "string", "description": "* `FAILURE` - FAILURE\n* `PENDING` - PENDING\n* `PROGRESS` - PROGRESS\n* `RECEIVED` - RECEIVED\n* `RETRY` - RETRY\n* `REVOKED` - REVOKED\n* `STARTED` - STARTED\n* `SUCCESS` - SUCCESS" }, "TaskStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StatusEnum" }, "result": { "nullable": true }, "error": { "type": "string", "nullable": true } }, "required": [ "error", "result", "status" ] }, "Thread": { "type": "object", "description": "Serialize threads.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "subject": { "type": "string", "readOnly": true, "nullable": true }, "snippet": { "type": "string", "readOnly": true }, "messages": { "type": "string", "readOnly": true }, "has_unread": { "type": "boolean", "readOnly": true }, "has_unread_mention": { "type": "boolean", "readOnly": true }, "has_trashed": { "type": "boolean", "readOnly": true }, "is_trashed": { "type": "boolean", "readOnly": true, "description": "Whether all messages in the thread are trashed" }, "has_archived": { "type": "boolean", "readOnly": true }, "has_draft": { "type": "boolean", "readOnly": true }, "has_starred": { "type": "boolean", "readOnly": true }, "has_attachments": { "type": "boolean", "readOnly": true }, "has_sender": { "type": "boolean", "readOnly": true }, "has_messages": { "type": "boolean", "readOnly": true }, "has_delivery_failed": { "type": "boolean", "readOnly": true, "description": "True if thread has messages with permanent delivery failure." }, "has_delivery_pending": { "type": "boolean", "readOnly": true, "description": "True if thread has messages awaiting successful delivery (sending, retrying, or failed)." }, "is_spam": { "type": "boolean", "readOnly": true }, "has_active": { "type": "boolean", "readOnly": true }, "messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "active_messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Date of the last active (received, not spam/archived/trashed/draft) message." }, "draft_messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Date of the last draft (non-trashed) message." }, "sender_messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Date of the last sent (non-trashed, non-draft) message." }, "archived_messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Date of the last archived (non-trashed) message." }, "trashed_messaged_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Date of the last trashed message." }, "sender_names": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "user_role": { "allOf": [ { "$ref": "#/components/schemas/ThreadAccessRoleChoices" } ], "nullable": true, "readOnly": true }, "accesses": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadAccessDetail" }, "readOnly": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadLabel" }, "readOnly": true }, "summary": { "type": "string", "readOnly": true }, "events_count": { "type": "integer", "readOnly": true }, "abilities": { "type": "object", "additionalProperties": { "type": "boolean" }, "readOnly": true }, "assigned_users": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEventUser" }, "readOnly": true } }, "required": [ "abilities", "accesses", "active_messaged_at", "archived_messaged_at", "assigned_users", "draft_messaged_at", "events_count", "has_active", "has_archived", "has_attachments", "has_delivery_failed", "has_delivery_pending", "has_draft", "has_messages", "has_sender", "has_starred", "has_trashed", "has_unread", "has_unread_mention", "id", "is_spam", "is_trashed", "labels", "messaged_at", "messages", "sender_messaged_at", "sender_names", "snippet", "subject", "summary", "trashed_messaged_at", "updated_at", "user_role" ] }, "ThreadAccess": { "type": "object", "description": "Serialize thread access information.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "thread": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "mailbox": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "role": { "$ref": "#/components/schemas/ThreadAccessRoleChoices" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithoutAbilities" }, "readOnly": true } }, "required": [ "created_at", "id", "mailbox", "role", "thread", "updated_at", "users" ] }, "ThreadAccessDetail": { "type": "object", "description": "Serializer for thread access details.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "mailbox": { "$ref": "#/components/schemas/MailboxLight" }, "role": { "allOf": [ { "$ref": "#/components/schemas/ThreadAccessRoleChoices" } ], "readOnly": true }, "read_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "starred_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "id", "mailbox", "read_at", "role", "starred_at" ] }, "ThreadAccessRequest": { "type": "object", "description": "Serialize thread access information.", "properties": { "thread": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "mailbox": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID" }, "role": { "$ref": "#/components/schemas/ThreadAccessRoleChoices" } }, "required": [ "mailbox", "role", "thread" ] }, "ThreadAccessRoleChoices": { "type": "string", "enum": [ "viewer", "editor" ] }, "ThreadBulkDeleteRequestRequest": { "type": "object", "description": "Payload for the bulk-delete endpoint: a scope and the threads/messages\nto permanently delete.", "properties": { "scope": { "allOf": [ { "$ref": "#/components/schemas/ScopeEnum" } ], "description": "Which messages to permanently delete. Only 'draft' (draft messages) is supported.\n\n* `draft` - draft" }, "thread_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Threads whose scope-matching messages should be deleted." }, "message_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Specific messages to delete (still scope-filtered)." } }, "required": [ "scope" ] }, "ThreadEvent": { "type": "object", "description": "Serialize thread event information.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "thread": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true }, "type": { "$ref": "#/components/schemas/ThreadEventTypeEnum" }, "channel": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "readOnly": true, "nullable": true }, "message": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "nullable": true }, "author": { "allOf": [ { "$ref": "#/components/schemas/UserWithoutAbilities" } ], "readOnly": true }, "author_display": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/ThreadEventData" }, "has_unread_mention": { "type": "boolean", "readOnly": true }, "is_editable": { "type": "boolean", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Created on", "description": "date and time at which a record was created" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "title": "Updated on", "description": "date and time at which a record was last updated" } }, "required": [ "author", "author_display", "channel", "created_at", "data", "has_unread_mention", "id", "is_editable", "thread", "type", "updated_at" ] }, "ThreadEventAssigneesData": { "type": "object", "description": "OpenAPI-only serializer: shape of ``ThreadEvent.data`` for ``ASSIGN`` and ``UNASSIGN`` events.\n\nBoth event types share the exact same payload shape, so a single serializer\n(and thus a single generated TypeScript type) covers them.\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEventUser" } } }, "required": [ "assignees" ] }, "ThreadEventAssigneesDataRequest": { "type": "object", "description": "OpenAPI-only serializer: shape of ``ThreadEvent.data`` for ``ASSIGN`` and ``UNASSIGN`` events.\n\nBoth event types share the exact same payload shape, so a single serializer\n(and thus a single generated TypeScript type) covers them.\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEventUserRequest" } } }, "required": [ "assignees" ] }, "ThreadEventData": { "oneOf": [ { "$ref": "#/components/schemas/ThreadEventIMData" }, { "$ref": "#/components/schemas/ThreadEventAssigneesData" } ] }, "ThreadEventDataRequest": { "oneOf": [ { "$ref": "#/components/schemas/ThreadEventIMDataRequest" }, { "$ref": "#/components/schemas/ThreadEventAssigneesDataRequest" } ] }, "ThreadEventIMData": { "type": "object", "description": "OpenAPI-only serializer: shape of ``ThreadEvent.data`` for ``IM`` events.\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "content": { "type": "string" }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEventUser" } } }, "required": [ "content" ] }, "ThreadEventIMDataRequest": { "type": "object", "description": "OpenAPI-only serializer: shape of ``ThreadEvent.data`` for ``IM`` events.\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "content": { "type": "string", "minLength": 1 }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadEventUserRequest" } } }, "required": [ "content" ] }, "ThreadEventRequest": { "type": "object", "description": "Serialize thread event information.", "properties": { "type": { "$ref": "#/components/schemas/ThreadEventTypeEnum" }, "message": { "type": "string", "format": "uuid", "description": "primary key for the record as UUID", "nullable": true }, "data": { "$ref": "#/components/schemas/ThreadEventDataRequest" } }, "required": [ "data", "type" ] }, "ThreadEventTypeEnum": { "enum": [ "im", "assign", "unassign" ], "type": "string", "description": "* `im` - Instant message\n* `assign` - Assign\n* `unassign` - Unassign" }, "ThreadEventUser": { "type": "object", "description": "OpenAPI-only serializer: describes a single user inside\nan ThreadEvent.data payload. (used for ``IM`` and ``ASSIGNEES`` events)\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "ThreadEventUserRequest": { "type": "object", "description": "OpenAPI-only serializer: describes a single user inside\nan ThreadEvent.data payload. (used for ``IM`` and ``ASSIGNEES`` events)\n\nNot used for runtime validation (handled by\n``ThreadEvent.validate_data()`` against ``ThreadEvent.DATA_SCHEMAS``);\nexists solely to produce a named component in the OpenAPI schema consumed\nby the generated frontend client.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1 } }, "required": [ "id", "name" ] }, "ThreadLabel": { "type": "object", "description": "Serializer to get labels details for a thread.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "name": { "type": "string", "description": "Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')", "maxLength": 255 }, "slug": { "type": "string", "readOnly": true, "description": "URL-friendly version of the name", "pattern": "^[-a-zA-Z0-9_]+$" }, "color": { "type": "string", "description": "Color of the label in hex format (e.g. #FF0000)", "maxLength": 7 }, "display_name": { "type": "string", "readOnly": true }, "description": { "type": "string", "description": "Description of the label, used by AI to understand its purpose", "maxLength": 255 }, "is_auto": { "type": "boolean", "title": "Auto labeling", "description": "Whether this label should be automatically applied by AI" } }, "required": [ "display_name", "id", "name", "slug" ] }, "ThreadMentionableUser": { "type": "object", "description": "User listed in a thread's mention suggestions, with comment capability flag.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "email": { "type": "string", "format": "email", "readOnly": true, "nullable": true, "title": "Identity email address" }, "full_name": { "type": "string", "readOnly": true, "nullable": true }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Get custom attributes for the instance.", "readOnly": true }, "can_post_comments": { "type": "boolean", "readOnly": true } }, "required": [ "can_post_comments", "custom_attributes", "email", "full_name", "id" ] }, "ThreadSplitRequestRequest": { "type": "object", "properties": { "message_id": { "type": "string", "format": "uuid", "description": "ID of the message to split from. This message and all chronologically later messages will be moved to a new thread." } }, "required": [ "message_id" ] }, "TreeLabel": { "type": "object", "description": "Serializer for tree label response structure (OpenAPI purpose only...).", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "slug": { "type": "string", "readOnly": true }, "color": { "type": "string", "readOnly": true }, "display_name": { "type": "string", "readOnly": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/TreeLabel" }, "readOnly": true }, "description": { "type": "string", "readOnly": true }, "is_auto": { "type": "boolean", "readOnly": true } }, "required": [ "children", "color", "description", "display_name", "id", "is_auto", "name", "slug" ] }, "UserChannelCreateRequestRequest": { "oneOf": [ { "$ref": "#/components/schemas/ChannelRequest" }, { "$ref": "#/components/schemas/PushChannelCreateRequest" } ] }, "UserWithAbilities": { "type": "object", "description": "Serialize users with abilities.\nAllow to have separated OpenAPI definition for users with and without abilities.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "email": { "type": "string", "format": "email", "readOnly": true, "nullable": true, "title": "Identity email address" }, "full_name": { "type": "string", "readOnly": true, "nullable": true }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Get custom attributes for the instance.", "readOnly": true }, "csrf_token": { "type": "string", "description": "Return the session-bound CSRF token for the SPA to echo as X-CSRFToken.\n\nWith ``CSRF_USE_SESSIONS`` the secret lives in the session and is no\nlonger exposed as a cookie, so the token is delivered here over the\nauthenticated ``/users/me/`` channel.", "readOnly": true }, "abilities": { "type": "object", "description": "Instance permissions and capabilities", "properties": { "view_maildomains": { "type": "boolean", "description": "Can view domain admin" }, "create_maildomains": { "type": "boolean", "description": "Can create maildomains" }, "manage_maildomain_accesses": { "type": "boolean", "description": "Can manage maildomain accesses" } }, "required": [ "view_maildomains", "create_maildomains", "manage_maildomain_accesses" ], "readOnly": true } }, "required": [ "abilities", "csrf_token", "custom_attributes", "email", "full_name", "id" ] }, "UserWithoutAbilities": { "type": "object", "description": "Serialize users without abilities.\nAllow to have separated OpenAPI definition for users with and without abilities.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "primary key for the record as UUID" }, "email": { "type": "string", "format": "email", "readOnly": true, "nullable": true, "title": "Identity email address" }, "full_name": { "type": "string", "readOnly": true, "nullable": true }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Get custom attributes for the instance.", "readOnly": true } }, "required": [ "custom_attributes", "email", "full_name", "id" ] }, "WebPushKeysRequest": { "type": "object", "description": "The Web Push subscription key pair (``p256dh`` and ``auth``).", "properties": { "p256dh": { "type": "string", "minLength": 1 }, "auth": { "type": "string", "minLength": 1 } }, "required": [ "auth", "p256dh" ] } }, "securitySchemes": { "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "sessionid" } } } }