All Products
Search
Document Center

Direct Mail:QueryMailAddressByParam

Last Updated:Mar 13, 2024

You can call this operation QueryMailAddressByParam to query the list of sender addresses.

Debugging

You can directly run this interface in the OpenAPI Explorer, eliminating the trouble of calculating signatures. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request Parameters

Parameter

Type

Required

Description

Action

String

Yes

The operation that you want to perform. Valid values: QueryMailAddressByParam

PageNo

String

No

The number of pages. Default value: 1.

PageSize

String

No

The number of entries to return on each page. Default value: 10.

KeyWord

String

Yes

Email address, length 1-60, supports numbers, letters,.,-, and @

Sendtype

String

No

Email Address Type: batch or trigger; Default: All

For information about other request parameters, see Common request parameters.

Response Parameters

Name

Type

Description

data

data

Data

Name

Type

Description

data

Array

data record

Data Record

Parameter

Type

Description

mailAddressId

int

The ID of the sender address.

accountName

String

Sender Address

replyAddress

String

Reply-To Address

sendtype

String

Sending Type batch or trigger

accountStatus

int

The account status. Freezing: 1, normal: 0

replyStatus

int

Status of the Reply-To Address

createTime

Date

The time of creation.

dailyCount

int

Daily limit

monthCount

int

Monthly limit

dailyReqCount

int

The maximum number of emails that you can send every day.

monthReqCount

int

The maximum number of emails that you can send every month.

domainStatus

int

domain status, 0 is normal, 1 is abnormal

For more information about common response parameters, see Common response parameters.

Examples

Sample requests

http(s)://dm.aliyuncs.com/?Action=QueryMailAddressByParam
&KeyWord=xxx
&Sendtype=batch
&PageNo=1
&PageSize=2
&<Common request parameters>

Sample success responses

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, visit the API Error Center.