Envia um único e-mail.
Experimente agora
Testar
Autorização RAM
|
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:
|
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.
|
body |
| TextBody |
string |
Não |
O corpo de texto do e-mail. Nota: Você deve especificar HtmlBody ou TextBody.
|
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: |
0 |
| UnSubscribeLinkType |
string |
Não |
"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.
|
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": " |
| 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 |
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.
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.