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

# Send a test email

> Send a test email to the calling administrator's own address to check the SMTP settings. There is no recipient parameter. Limited to 5 per administrator every 10 minutes on each API instance. Requires the `system:read` instance permission; API keys are rejected.



## OpenAPI

````yaml /openapi.json post /admin/system/test-email
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /admin/system/test-email:
    post:
      tags:
        - Admin
      summary: Send a test email
      description: >-
        Send a test email to the calling administrator's own address to check
        the SMTP settings. There is no recipient parameter. Limited to 5 per
        administrator every 10 minutes on each API instance. Requires the
        `system:read` instance permission; API keys are rejected.
      operationId: sendAdminTestEmail
      responses:
        '200':
          description: The mail server accepted the test email
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminTestEmailResult'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The caller lacks the instance permission or is authenticated with an
            API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: SMTP is not configured on this instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Too many test emails; retry after Retry-After seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '502':
          description: The mail server did not accept the test email
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    AdminTestEmailResult:
      type: object
      properties:
        sent:
          type: boolean
          enum:
            - true
        to:
          type: string
          description: The administrator's own address, the only recipient.
      required:
        - sent
        - to
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

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