Call the QueryMailAddressByParam operation to query a list of sender addresses.
Test
You can call this operation directly in OpenAPI Explorer. This eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates software development kit (SDK) code examples.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to QueryMailAddressByParam. |
PageNo | String | No | The page number. Default value: 1. |
PageSize | String | No | The number of entries to return on each page. Default value: 10. |
KeyWord | String | Yes | The email address. The address can be 1 to 60 characters in length and can contain digits, letters, periods (.), hyphens (-), and at signs (@). |
Sendtype | String | No | The type of the email address. Valid values: `batch` and `trigger`. If you do not specify this parameter, all types of email addresses are returned. |
For more information about common request parameters, see Common parameters.
Response parameters
Name | Type | Description |
data | data |
data
Name | Type | Description |
data | Array | data record |
data record
Name | Type | Description |
mailAddressId | int | The ID of the sender address. |
accountName | String | The sender address. |
replyAddress | String | The reply-to address. |
sendtype | String | The type of the sender address. Valid values: `batch` and `trigger`. |
accountStatus | int | The account status. Valid values: `0`: Normal. `1`: Frozen. |
replyStatus | int | The status of the reply-to address. |
createTime | Date | |
dailyCount | int | The daily sending quota limit. |
monthCount | int | The monthly sending quota limit. |
dailyReqCount | int | The daily sending quota. |
monthReqCount | int | The monthly sending quota. |
domainStatus | int | The domain status. Valid values: `0`: Normal. `1`: Abnormal. |
For more information about common response parameters, see Common parameters.
Examples
Request example
http(s)://dm.aliyuncs.com/?Action=QueryMailAddressByParam
&KeyWord=xxx
&Sendtype=batch
&PageNo=1
&PageSize=2
&<Common request parameters>Successful response example
JSON format
{
"TotalCount": 2,
"RequestId": "13EC32FA-61EB-5401-AB59-EA943CF25F14",
"PageSize": 1,
"data": {
"mailAddress": [
{
"Sendtype": "batch",
"AccountStatus": 0,
"ReplyStatus": 0,
"DailyReqCount": 0,
"CreateTime": "2021-05-13T15:54Z",
"MonthReqCount": 0,
"ReplyAddress": "xxxxx",
"MailAddressId": 237915,
"MonthCount": -1,
"DailyCount": -1,
"DomainStatus": 0,
"AccountName": "xxxxx"
}
]
},
"PageNumber": 1
}Error codes
For a list of error codes, see the Error Center.