- Development Integration
- /
- SDK
- /
- Java
- /
Management module
- /
Manage message service
- /
- Get third-party email service configuration
¶ Get third-party email service configuration
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 this document description is incorrect, please refer to V3 API.
Get third-party email service configuration
¶ Method Name
ManagementClient.getEmailProvider
¶ Request Parameters
| Name | Type | Is it required | Default Value | Description | Example Value |
|---|
¶ Sample Code
package test.management;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.EmailProviderRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
public class GetEmailProviderTest {
// Need to be replaced with your GenAuth Access Key ID
private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
// Need to be replaced with your GenAuth Access Key Secret
private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";
public static void main(String[] args) throws Throwable {
ManagementClientOptions clientOptions = new ManagementClientOptions();
clientOptions.setAccessKeyId(ACCESS_KEY_ID);
clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
// If you are a private deployment customer, you need to set the GenAuth service domain name
// clientOptions.setHost("https://api.your-authing-service.com");
ManagementClient client = new ManagementClient(clientOptions);
EmailProviderRespDto response = client.getEmailProvider();
System.out.println(JsonUtils.serialize(response));
}
}
¶ Request Response
Type: EmailProviderRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code. You can use this status code to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segment error code, through which the specific error type can be obtained (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. |
| data | EmailProviderDto | Response data |
Example Results:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"enabled": true,
"type": "custom",
"smtpConfig": {
"smtp_host": "smtp.example.com",
"smtp_port": 465,
"sender": "test",
"senderPass": "passw0rd",
"secure": true
},
"sendGridConfig": {
"sender": "test",
"apikey": "xxxxxxxxxx"
},
"aliExmailConfig": {
"sender": "test",
"senderPass": "passw0rd"
},
"tencentExmailConfig": {
"sender": "test",
"senderPass": "passw0rd"
}
}
}
¶ Data Structure
¶ EmailProviderDto
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| enabled | boolean | yes | Whether to enable. If not enabled, the built-in mail service of GenAuth will be used by default | true |
| type | string | no | Third-party mail service provider type: - custom: Custom SMTP mail service- ali: Ali Enterprise Mailbox (opens new window)- qq: Tencent Enterprise Mailbox (opens new window)- sendgrid: SendGrid Mail Service (opens new window) | ali |
| smtpConfig | no | SMTP mail service configuration Nested Type: SMTPEmailProviderConfig. | ||
| sendGridConfig | No | SendGrid email service configuration Nested Type: SendGridEmailProviderConfig. | ||
| aliExmailConfig | No | Ali enterprise email service configuration Nested Type: AliExmailEmailProviderConfig. | ||
| tencentExmailConfig | No | Tencent enterprise email service configuration Nested Type:TencentExmailEmailProviderConfig。 |
¶ SMTPEmailProviderConfig
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| smtp_host | string | yes | SMTP address | smtp.example.com |
| smtp_port | number | yes | SMTP port | 465 |
| sender | string | yes | Username | test |
| senderPass | string | yes | Password | passw0rd |
| secure | boolean | yes | Whether to enable SSL | true |
¶ SendGridEmailProviderConfig
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| sender | string | yes | username | test |
| apikey | string | yes | SendGrid API Key, see [SendGrid documentation] for details(https://docs.sendgrid.com/ui/account-and-settings/api-keys)。 | xxxxxxxxxx |
¶ AliExmailEmailProviderConfig
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| sender | string | yes | username | test |
| senderPass | string | yes | password | passw0rd |
¶ TencentExmailEmailProviderConfig
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| sender | string | yes | username | test |
| senderPass | string | yes | password | passw0rd |
