Todos os produtos
Search
Central de documentação

Direct Mail:SingleSendMail

Última atualização: Jun 28, 2026

Envia um único e-mail.

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:SingleSendMail

none

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

AccountName

string

Sim

O endereço do remetente configurado no console do Direct Mail.

test***@example.net

AddressType

integer

Sim

O tipo de endereço. Valores válidos:

0: Uma conta aleatória.

1: Um endereço de remetente.

1

TagName

string

Não

Uma tag para categorizar lotes de e-mails, que você pode criar no console do Direct Mail. As tags permitem consultar o status de envio de cada lote e são obrigatórias se você ativar o rastreamento de e-mails. A tag deve ter de 1 a 128 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-).

test

ReplyToAddress

boolean

Sim

Especifica se deve ser usado o endereço de resposta padrão configurado no console. Este endereço deve ser verificado. Valores válidos: true, false.

true

ToAddress

string

Sim

O(s) endereço(s) de e-mail de destino. Para especificar vários endereços, separe-os por vírgulas (até 100).

test1***@example.net

Subject

string

Sim

O assunto do e-mail, com comprimento máximo de 256 caracteres.

Subject

HtmlBody

string

Não

O corpo HTML do e-mail.

Nota: Você deve especificar HtmlBody ou TextBody.

  • O tamanho do corpo é limitado a aproximadamente 80 KB quando passado como um parâmetro de URL.

  • Para SDKs recentes (Java 1.4.0+, Python 3 1.4.0+ e PHP 1.4.0+), o corpo da solicitação é limitado a aproximadamente 8 MB.

body

TextBody

string

Não

O corpo de texto do e-mail.

Nota: Você deve especificar HtmlBody ou TextBody.

  • O tamanho do corpo é limitado a aproximadamente 80 KB quando passado como um parâmetro de URL.

  • Para SDKs recentes (Java 1.4.0+, Python 3 1.4.0+ e PHP 1.4.0+), o corpo da solicitação é limitado a aproximadamente 8 MB.

body

FromAlias

string

Não

O nome do remetente. Deve ter 15 caracteres ou menos.

Por exemplo, se você definir o nome do remetente como "Xiaohong" e o endereço do remetente for test***@example.net, o destinatário verá o remetente como "Xiaohong" test***@example.net.

Jane

ReplyAddress

string

Não

O endereço de resposta.

test2***@example.net

ReplyAddressAlias

string

Não

O nome exibido para o endereço de resposta.

Jane

ClickTrace

string

Não

Especifica se o rastreamento de cliques deve ser ativado. Valores válidos: "1" ativa o rastreamento de cliques e "0" o desativa (padrão).

0

UnSubscribeLinkType

string

Não

disabled: Não gera um link de cancelamento de inscrição.

default: Usa a política padrão. Para endereços de remetente em lote, um link de cancelamento de inscrição é gerado ao enviar para domínios específicos que contenham palavras-chave como "gmail", "yahoo",

"google", "aol.com", "hotmail",

"outlook" e "ymail.com". Para mais informações, consulte Mecanismo de geração e filtragem de link de cancelamento de inscrição.

O idioma de exibição é determinado automaticamente com base nas configurações do navegador do destinatário.

default

UnSubscribeFilterLevel

string

Não

O nível de filtragem. Para mais informações, consulte Mecanismo de geração e filtragem de link de cancelamento de inscrição.

disabled: Sem filtragem.

default: Usa a política padrão. Para endereços em lote, a filtragem é aplicada no nível do endereço do remetente.

mailfrom: Filtra no nível do endereço do remetente.

mailfrom_domain: Filtra no nível do domínio do remetente.

edm_id: Filtra no nível da conta.

mailfrom_domain

Headers

string

Não

Configurações personalizadas de cabeçalho de e-mail.

Os campos padrão e não padrão devem estar em conformidade com a sintaxe de cabeçalho padrão. Você pode especificar até 10 cabeçalhos para uma chamada de API. Os cabeçalhos excedentes são ignorados. Este limite não se aplica ao SMTP.

1. Campos padrão

Message-ID, List-Unsubscribe, List-Unsubscribe-Post

Os campos padrão substituem os valores existentes no cabeçalho do e-mail.

2. Campos não padrão

Não diferenciam maiúsculas de minúsculas.

a. Campos que começam com X-User-: Estes não são enviados para o EventBridge ou Message Service (MNS). Este prefixo é necessário apenas para chamadas de API, não para SMTP.

b. Campos que começam com X-User-Notify-: Estes são enviados para o EventBridge e MNS. Isso é suportado tanto para chamadas de API quanto de SMTP.

Quando enviados para o EventBridge ou MNS, o objeto de cabeçalho conterá esses campos.

{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001", "X-User-Notify-UID1": "UID-3-000001", "X-User-Notify-UID2": "UID-4-000001" }

IpPoolId

string

Não

O ID do pool de IPs dedicados. Se você comprou IPs dedicados, pode usar este parâmetro para selecionar qual pool de IPs dedicados usar para enviar o e-mail. Para mais informações, consulte IP dedicado.

e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef

Attachments

array<object>

Não

Este recurso está disponível apenas por meio dos SDKs mais recentes. Não é suportado para chamadas OpenAPI ou autenticação baseada em assinatura. Para mais informações, consulte Como envio um e-mail com anexo usando um SDK?.

object

Não

Um objeto que representa um único anexo.

AttachmentName

string

Não

O nome do arquivo do anexo.

test.txt

AttachmentUrl

string

Não

O caminho do arquivo local do anexo que o SDK usará.

C:\Users\Downloads\test.txt

Template

object

Não

As informações do modelo para envio de um e-mail com modelo.

TemplateId

string

Não

O ID do modelo.

xxx

TemplateData

object

Não

As variáveis e seus valores para o modelo.

string

Não

Os parâmetros e valores das variáveis do modelo.

{ "name": "Tom", "age": "22" }

BccAddress

string

Não

  • Uma lista separada por vírgulas de destinatários de CCO.

  • O sistema envia uma cópia do e-mail para cada destinatário de CCO. As informações de CCO ficam ocultas para todos os destinatários, incluindo aqueles especificados em ToAddress e BccAddress.

  • Para proteger a privacidade, os recursos de rastreamento de e-mail (como rastreamento de abertura e clique) são desativados para e-mails enviados a destinatários de CCO. No entanto, o faturamento e o status de envio ainda são rastreados.

  • São permitidos no máximo dois destinatários de CCO por solicitação.

Nota: A operação de API SingleSendMail não suporta um campo CC. Para enviar cópias, use SMTP.

1@example.com,2@example.com

DomainAuth

boolean

Não

Especifica se a autenticação no nível do domínio deve ser ativada.

  • true

  • false

Este parâmetro é usado apenas para autenticação no nível do domínio. Ignore-o para autenticação no nível do endereço do remetente.

1. Crie o endereço domain-auth-created-by-system@example.com no console. O prefixo deve ser fixo e o sufixo deve ser o seu domínio.

2.

Cenário de API

Defina AccountName como o seu domínio. Os destinatários verão o remetente como domain-auth-created-by-system@example.com.

Cenário de SMTP

a. Chame a operação de API ModifyPWByDomain para definir uma senha para o domínio.

b. Autentique-se com o domínio e a senha configurada. Passe um endereço personalizado, como user@example.com, como o remetente real no comando MAIL FROM. Os destinatários verão user@example.com como o remetente.

true

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

EnvId

string

O ID do evento.

600000xxxxxxxxxx642

RequestId

string

O ID da solicitação.

2D086F6-xxxx-xxxx-xxxx-006DED011A85

Exemplos

Resposta de sucesso

JSON formato

{
  "EnvId": "600000xxxxxxxxxx642",
  "RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidReceiverName.Malformed The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods. The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods.
404 InvalidMailAddress.NotFound The specified mail address is not found. The specified mail address is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.