1.8 KiB
1.8 KiB
name, description
| name | description |
|---|---|
| email-servers-routes | Handle 6 OpenAPI operation(s) under /api/v1/email-servers for the email servers route group. |
email servers API Routes
Handle 6 OpenAPI operation(s) under /api/v1/email-servers for the email servers route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_email_servers
- Operation ID:
list_email_servers - Route:
GET /api/v1/email-servers - Mode: READ
- Summary: List all enrolled SMTP servers
create_email_server
- Operation ID:
create_email_server - Route:
POST /api/v1/email-servers - Mode: WRITE
- Summary: Create a custom SMTP server
- Body: JSON request body accepted.
get_email_server
- Operation ID:
get_email_server - Route:
GET /api/v1/email-servers/{emailServerId} - Mode: READ
- Summary: Retrieve an SMTP server configuration
- Parameters:
emailServerIdinpathrequired
update_email_server
- Operation ID:
update_email_server - Route:
PATCH /api/v1/email-servers/{emailServerId} - Mode: WRITE
- Summary: Update an SMTP server configuration
- Parameters:
emailServerIdinpathrequired
- Body: JSON request body accepted.
delete_email_server
- Operation ID:
delete_email_server - Route:
DELETE /api/v1/email-servers/{emailServerId} - Mode: WRITE
- Summary: Delete an SMTP server configuration
- Parameters:
emailServerIdinpathrequired
test_email_server
- Operation ID:
test_email_server - Route:
POST /api/v1/email-servers/{emailServerId}/test - Mode: WRITE
- Summary: Test an SMTP server configuration
- Parameters:
emailServerIdinpathrequired
- Body: JSON request body accepted.