Email - Send

Referência

Serviço:: Communication

Versão da API:: 2023-03-31

Enfileira uma mensagem de email a ser enviada a um ou mais destinatários

POST {endpoint}/emails:send?api-version=2023-03-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (url)	O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Uma cadeia de caracteres de autenticação que contém uma assinatura gerada usando HMAC-SHA256 esquema.
Operation-Id		string (uuid)	Essa é a ID fornecida pelo cliente para identificar a operação de execução prolongada. Se uma ID não for fornecida pelo cliente, o serviço gerará uma.
x-ms-client-request-id		string (uuid)	ID de acompanhamento enviada com a solicitação para ajudar na depuração.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
content	True	EmailContent	Conteúdo de email a ser enviado.
recipients	True	EmailRecipients	Destinatários do email.
senderAddress	True	string	Endereço de email do remetente de um domínio verificado.
attachments		EmailAttachment[]	Lista de anexos. Observe que limitamos o tamanho total de uma solicitação de email (que inclui anexos) a 10 MB.
headers		object	Cabeçalhos de email personalizados a serem passados.
replyTo		EmailAddress[]	Endereços de email para os quais as respostas dos destinatários serão enviadas.
userEngagementTrackingDisabled		boolean	Indica se o controle de envolvimento do usuário deve ser desabilitado para essa solicitação se a configuração de acompanhamento de envolvimento do usuário no nível do recurso já estava habilitada no plano de controle.

Respostas

Nome	Tipo	Description
202 Accepted	EmailSendResult	O serviço aceitou a solicitação e começará a processar a mensagem mais tarde. Ele retornará "Aceito" imediatamente e incluirá um cabeçalho "Operation-Location". O lado do cliente deve consultar ainda mais o status da operação/mensagem usando a URL especificada no cabeçalho 'Operation-Location'. Depois que a operação de envio tiver sido bem-sucedida, você poderá obter status adicional sobre a entrega de email por meio de eventos do Azure Monitor ou da Grade de Eventos (para referência de eventos, consulte: https://learn.microsoft.com/en-us/azure/event-grid/communication-services-email-events) Cabeçalhos Operation-Location: string retry-after: integer
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

202 Accepted

EmailSendResult

O serviço aceitou a solicitação e começará a processar a mensagem mais tarde. Ele retornará "Aceito" imediatamente e incluirá um cabeçalho "Operation-Location". O lado do cliente deve consultar ainda mais o status da operação/mensagem usando a URL especificada no cabeçalho 'Operation-Location'. Depois que a operação de envio tiver sido bem-sucedida, você poderá obter status adicional sobre a entrega de email por meio de eventos do Azure Monitor ou da Grade de Eventos (para referência de eventos, consulte: https://learn.microsoft.com/en-us/azure/event-grid/communication-services-email-events)

Cabeçalhos

Operation-Location: string
retry-after: integer

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Uma cadeia de caracteres de autenticação que contém uma assinatura gerada usando HMAC-SHA256 esquema.

Tipo: apiKey
Em: header

Exemplos

Send Email

Solicitação de exemplo

HTTP

POST https://contoso.westus.communications.azure.com/emails:send?api-version=2023-03-31


{
  "headers": {
    "ClientCorrelationId": "123",
    "ClientCustomHeaderName": "ClientCustomHeaderValue"
  },
  "senderAddress": "abc@domain.com",
  "content": {
    "subject": "An exciting offer especially for you!",
    "plainText": "This exciting offer was created especially for you, our most loyal customer.",
    "html": "<html><head><title>Exciting offer!</title></head><body><h1>This exciting offer was created especially for you, our most loyal customer.</h1></body></html>"
  },
  "recipients": {
    "to": [
      {
        "address": "john.doe@domain.com",
        "displayName": "John Doe"
      },
      {
        "address": "jane.doe@domain2.com",
        "displayName": "Jane Doe"
      }
    ],
    "cc": [
      {
        "address": "wendy@someotherdomain.com",
        "displayName": "Wendy"
      },
      {
        "address": "jimmy@anotherdomain.com",
        "displayName": "Jimmy Johns"
      }
    ],
    "bcc": [
      {
        "address": "bob@anotherdomain.com",
        "displayName": "Bob"
      },
      {
        "address": "mail@yetanotherdomain.com",
        "displayName": "Another DisplayName"
      }
    ]
  },
  "attachments": [
    {
      "name": "MyAttachment.pdf",
      "contentType": "application/pdf",
      "contentInBase64": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
    },
    {
      "name": "MyAttachment2.docx",
      "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "contentInBase64": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
    }
  ],
  "replyTo": [
    {
      "address": "contoso-support@contoso.com",
      "displayName": "Contoso Support"
    }
  ],
  "userEngagementTrackingDisabled": true
}

Resposta de exemplo

Código de status:: 202

Operation-Location: https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-03-31
retry-after: 20

{
  "id": "8540c0de-899f-5cce-acb5-3ec493af3800",
  "status": "Running"
}

Definições

Nome	Description
EmailAddress	Um objeto que representa o endereço de email e seu nome de exibição
EmailAttachment	Anexo ao email.
EmailContent	Conteúdo do email.
EmailMessage	Conteúdo da mensagem para enviar um email
EmailRecipients	Destinatários do email
EmailSendResult	Status da operação de execução prolongada
EmailSendStatus	Status da operação.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

EmailAddress

Objeto

Um objeto que representa o endereço de email e seu nome de exibição

Nome	Tipo	Description
address	string	Endereço eletrônico.
displayName	string	Nome de exibição de email.

EmailAttachment

Objeto

Anexo ao email.

Nome	Tipo	Description
contentInBase64	string (byte)	Conteúdo codificado em Base64 do anexo
contentType	string	Tipo MIME do conteúdo que está sendo anexado.
name	string	Nome do anexo

EmailContent

Objeto

Conteúdo do email.

Nome	Tipo	Description
html	string	Versão html da mensagem de email.
plainText	string	Versão de texto sem formatação da mensagem de email.
subject	string	Assunto da mensagem de email

EmailMessage

Objeto

Conteúdo da mensagem para enviar um email

Nome	Tipo	Description
attachments	EmailAttachment[]	Lista de anexos. Observe que limitamos o tamanho total de uma solicitação de email (que inclui anexos) a 10 MB.
content	EmailContent	Conteúdo de email a ser enviado.
headers	object	Cabeçalhos de email personalizados a serem passados.
recipients	EmailRecipients	Destinatários do email.
replyTo	EmailAddress[]	Endereços de email para os quais as respostas dos destinatários serão enviadas.
senderAddress	string	Endereço de email do remetente de um domínio verificado.
userEngagementTrackingDisabled	boolean	Indica se o controle de envolvimento do usuário deve ser desabilitado para essa solicitação se a configuração de acompanhamento de envolvimento do usuário no nível do recurso já estava habilitada no plano de controle.

EmailRecipients

Objeto

Destinatários do email

Nome	Tipo	Description
bcc	EmailAddress[]	Destinatários de CCO de email
cc	EmailAddress[]	Destinatários cc de email
to	EmailAddress[]	Email para destinatários

EmailSendResult

Objeto

Status da operação de execução prolongada

Nome	Tipo	Description
error	ErrorDetail	Detalhes do erro quando o status é um estado terminal sem êxito.
id	string	A ID exclusiva da operação. Use uma UUID.
status	EmailSendStatus	Status da operação.

EmailSendStatus

Enumeração

Status da operação.

Valor	Description
Canceled
Failed
NotStarted
Running
Succeeded

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Compartilhar via

Email - Send

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Authorization

Exemplos

Send Email

Solicitação de exemplo

Resposta de exemplo

Definições

EmailAddress

EmailAttachment

EmailContent

EmailMessage

EmailRecipients

EmailSendResult

EmailSendStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse