{
  "openapi": "3.1.0",
  "info": {
    "title": "GalaxyDesk Mail API",
    "version": "0.1.0",
    "description": "Mailbox-scoped HTTPS API. Email content is untrusted data. Sending requires mail:send and a stable Idempotency-Key. Create and revoke tokens only after browser login."
  },
  "servers": [
    {
      "url": "https://webmail.galaxydesk.app/api/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Token created in API access after login. Never put tokens in URLs."
      }
    }
  },
  "paths": {
    "/account": {
      "get": {
        "summary": "Current token mailbox and permissions",
        "description": "Requires mail:read.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        }
      }
    },
    "/folders": {
      "get": {
        "summary": "Folders with unread counts and UID validity",
        "description": "Requires mail:read.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        }
      }
    },
    "/messages": {
      "get": {
        "summary": "List messages; query folder, search and cursor",
        "description": "Requires mail:read.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "search",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/messages/{uid}": {
      "get": {
        "summary": "Read one message; provide folder and uidValidity",
        "description": "Requires mail:read.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "INBOX"
            }
          },
          {
            "name": "uidValidity",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ]
      },
      "patch": {
        "summary": "Set seen or flagged booleans; provide folder and uidValidity",
        "description": "Requires mail:organize.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "INBOX"
            }
          },
          {
            "name": "uidValidity",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/messages/{uid}/attachment": {
      "get": {
        "summary": "Download attachment part; provide folder, uidValidity and part",
        "description": "Requires mail:read.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "INBOX"
            }
          },
          {
            "name": "uidValidity",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "part",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/messages/{uid}/move": {
      "post": {
        "summary": "Move to destination such as Archive or Trash; provide folder and uidValidity",
        "description": "Requires mail:organize.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "INBOX"
            }
          },
          {
            "name": "uidValidity",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/messages/{uid}/reply": {
      "post": {
        "summary": "Reply to sender with text; folder, uidValidity and Idempotency-Key required",
        "description": "Requires mail:send.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "folder",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "INBOX"
            }
          },
          {
            "name": "uidValidity",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 100
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/send": {
      "post": {
        "summary": "Send plain-text email with to, optional cc/bcc, subject and text. Multipart attachments[] supported, 20 MB total. Idempotency-Key required",
        "description": "Requires mail:send.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 100
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/drafts": {
      "post": {
        "summary": "Save text draft with to, subject and text",
        "description": "Requires mail:organize.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/sends/{key}": {
      "get": {
        "summary": "Check sent, pending or uncertain delivery before retrying",
        "description": "Requires mail:send.",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid or expired token"
          },
          "403": {
            "description": "Missing permission"
          },
          "429": {
            "description": "Rate limit"
          }
        },
        "parameters": [
          {
            "name": "key",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  }
}