Validates an email address.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dm:ValidateEmail |
none |
*All Resource
|
None | None |
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
|
string |
Yes |
The email address to validate. |
xxx@yyy.com |
|
| Timeout |
integer |
No |
The timeout period. The default value is 60 seconds. |
20 |
| CheckGraylist |
boolean |
No |
Specifies whether to check the graylist. The default value is false. The result is sent through an asynchronous notification message from EventBridge. |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
xxxx-xxxx-xxxx-xxxx |
| Status |
string |
The validation status of the email address. Valid values:
|
VALID |
| SubStatus |
string |
The detailed validation status of the email address. This provides more information about the Status. Valid values:
|
UNSPECIFIED |
| Provider |
string |
The email service provider of the address. Valid values:
|
Gmail |
| IsFreeMail |
boolean |
Indicates whether the address is from a free email service. Valid values:
|
true |
| LocalPart |
string |
The local part of the email address parsed from the syntax check. The local part is converted to lowercase and the content after the plus sign (+) is removed. |
xxx |
| DomainPart |
string |
The domain part of the email address parsed from the syntax check. The domain part is converted to lowercase. |
yyy.com |
Examples
Success response
JSON format
{
"RequestId": "xxxx-xxxx-xxxx-xxxx",
"Status": "VALID",
"SubStatus": "UNSPECIFIED",
"Provider": "Gmail",
"IsFreeMail": true,
"LocalPart": "xxx",
"DomainPart": "yyy.com"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.