QueryMailAddressByParam - Direct Mail - Alibaba Cloud Documentation Center

Queries a list of sender addresses.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:QueryMailAddressByParam

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	The current page number. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The default value is 10.	10
KeyWord	string	No	The email address. The length is 1 to 60 characters. The email address can contain digits, letters, periods (.), hyphens (-), and at signs (@).	账号+@+域名
Sendtype	string	No	The type of the sender address. Valid values: batch: batch emails trigger: triggered emails	batch

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	95A7D497-F8DD-4834-B81E-C1783236E55F
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries.	2
data	object
mailAddress	array<object>	The list of sender addresses.
	object
MailAddressId	string	The sender address ID.	12122
MonthCount	string	The monthly sending quota limit.	300000
AccountStatus	string	The account status. 1 indicates that the account is frozen. 0 indicates that the account is normal.	0
CreateTime	string	The creation time.	2019-09-29T13:28Z
ReplyStatus	string	The status of the reply-to address.	0
Sendtype	string	The type of the sender address. Valid values: batch: batch emails trigger: triggered emails	batch
MonthReqCount	string	The monthly sending quota.	20000
ReplyAddress	string	The reply-to address.	test@example.com
DailyReqCount	string	The daily quota.	100
DailyCount	string	The daily sending quota limit.	10000
DomainStatus	string	The domain status. 0 indicates that the domain is normal. 1 indicates that the domain is abnormal.	0
AccountName	string	The sender address.	账户+@+域名
ConfigSetId	string	The ID of the associated configuration set.	xxx
ConfigSetName	string	The name of the associated configuration set.	xxx

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "95A7D497-F8DD-4834-B81E-C1783236E55F",
  "PageNumber": 1,
  "TotalCount": 2,
  "data": {
    "mailAddress": [
      {
        "MailAddressId": "12122",
        "MonthCount": "300000",
        "AccountStatus": "0",
        "CreateTime": "2019-09-29T13:28Z",
        "ReplyStatus": "0",
        "Sendtype": "batch",
        "MonthReqCount": "20000",
        "ReplyAddress": "test@example.com",
        "DailyReqCount": "100",
        "DailyCount": "10000",
        "DomainStatus": "0",
        "AccountName": "账户+@+域名",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.