QueryMailAddressByParam - Direct Mail: Central de Documentação do Alibaba Cloud

Consulta a lista de endereços de remetente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dm:QueryMailAddressByParam

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNo	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
KeyWord	string	Não	O endereço de e-mail. O valor deve ter de 1 a 60 caracteres e pode conter dígitos, letras, pontos (.), hifens (-) e arrobas (@).	account@domain
Sendtype	string	Não	O tipo do endereço de remetente. Valores válidos: batch: e-mail em massa. trigger: e-mail acionado.	batch

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	95A7D497-F8DD-4834-B81E-C1783236E55F
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas.	2
data	object
mailAddress	array<object>	A lista de endereços de remetente.
	object	As informações do endereço de remetente.
MailAddressId	string	O ID do endereço de remetente.	12122
MonthCount	string	O limite de cota mensal.	300000
AccountStatus	string	O status da conta. Valores válidos: 1: congelada. 0: normal.	0
CreateTime	string	A hora de criação no formato ISO 8601 UTC, com precisão de minutos.	2019-09-29T13:28Z
ReplyStatus	string	O status do endereço de resposta. Valores válidos: Not returned: Nenhum endereço de resposta está configurado. 0: O endereço de resposta foi verificado. O frontend exibe "Passed". 1: O endereço de resposta falhou na verificação. O frontend exibe "Failed".	0
Sendtype	string	O tipo do endereço de remetente. Valores válidos: batch: e-mail em massa. trigger: e-mail acionado.	batch
MonthReqCount	string	A cota mensal.	20000
ReplyAddress	string	O endereço de resposta.	test@example.com
DailyReqCount	string	A cota diária.	100
DailyCount	string	O limite de cota diária.	10000
DomainStatus	string	O status do nome de domínio. Valores válidos: 0: normal. 1: anormal.	0
AccountName	string	O endereço de remetente.	account@domain
ConfigSetId	string	O ID do conjunto de configurações associado.	xxx
ConfigSetName	string	O nome do conjunto de configurações associado.	xxx
AddressType	string	O tipo de endereço de e-mail. Valores válidos: EXTERNAL: endereço externo. INTERNAL: endereço interno.	EXTERNAL
MailAddressVerificationStatus	string	O status de verificação do endereço de e-mail. Valores válidos: 0: não verificado. 1: verificado. 2: verificação não necessária. Todos os endereços internos estão neste estado.	0
SenderAddress	string	O endereço de remetente interno.	user@example.com

Exemplos

Resposta de sucesso

JSON formato

{
  "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": "account+@+domain",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx",
        "AddressType": "EXTERNAL",
        "MailAddressVerificationStatus": "0",
        "SenderAddress": "user@example.com"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.