---
title: "POST /api/instance/settings/notification:testEmail"
method: POST
path: "/api/instance/settings/notification:testEmail"
tags: ["InstanceService"]
---

# POST /api/instance/settings/notification:testEmail

`POST /api/instance/settings/notification:testEmail`

## Request

- The document declares no server URL.
- Auth: none declared

TestInstanceEmailSetting sends a test email with the provided or stored SMTP settings. Admin only.

## Request body

- TestInstanceEmailSettingRequest: Request message for InstanceService.TestInstanceEmailSetting.
  - `email` NotificationSettingEmailSetting: EmailSetting is the SMTP configuration for notification emails.
    - `enabled` boolean: Whether email notifications are enabled.
    - `smtpHost` string: The SMTP server host.
    - `smtpPort` integer: The SMTP server port.
    - `smtpUsername` string: The SMTP username.
    - `smtpPassword` string: Input only. The SMTP password. Never returned. An empty value keeps the stored password, unless the host, port, username or encryption settings change.
    - `useTls` boolean: Whether to use STARTTLS.
    - `useSsl` boolean: Whether to use implicit SSL/TLS.
    - `fromEmail` string: The sender email address.
    - `fromName` string: The sender display name.
    - `replyTo` string: The Reply-To email address.
  - `recipientEmail` string: Optional. The recipient email address. If omitted, the current user's email address is used.

## Response `200`

OK

## Other responses

- `default`: Default error response

## Changes

- **2026-10-08** `1846a777b0ef`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usememos/apis/untitled-api/changes/api/instance/settings/notification:testEmail/post.md)

---

[API](https://skmtc.dev/usememos/apis/untitled-api.md) - [All operations](https://skmtc.dev/usememos/apis/untitled-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usememos/apis/untitled-api/revisions/f587355e35b4?raw)