- Development Integration
- /
- SDK
- /
- Python
- /
Authentication Module
- /
Message Service
- /
- Send Email
¶ Send email
Update time: 2025-07-23 07:34:21
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.
When sending emails, you must specify the email channel. Each mailbox can only send once in the same channel within one minute.
¶ Method name
AuthenticationClient.send_email
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| channel | string | Yes | - | SMS channel, specify the purpose of sending this SMS: - CHANNEL_LOGIN: for user login- CHANNEL_REGISTER: for user registration- CHANNEL_RESET_PASSWORD: for resetting password- CHANNEL_VERIFY_EMAIL_LINK: for verifying email address- CHANNEL_UPDATE_EMAIL: for modifying email- CHANNEL_BIND_EMAIL: used to bind an email- CHANNEL_UNBIND_EMAIL: used to unbind an email- CHANNEL_VERIFY_MFA: used to verify MFA- CHANNEL_UNLOCK_ACCOUNT: used for self-service unlocking- CHANNEL_COMPLETE_EMAIL: used to complete the email information when registering/logging in- CHANNEL_DELETE_ACCOUNT: used to cancel an account | CHANNEL_LOGIN |
| string | yes | - | email, case insensitive | test@example.com |
¶ Request response
Type: SendEmailRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful, 200 means success. |
| message | string | description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c"
}