Microsoft Azure EmailSend API

openapi: 3.2.0
info:
  title: Microsoft Azure Email Send API
  version: '1.0'
  description: 'Operations tagged EmailSend across 2 of this provider''s published API definitions: communicationemailclient-openapi-original.yml, emailclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
security:
- Authorization: []
tags:
- name: EmailSend
paths:
  /emails:send:
    post:
      tags:
      - EmailSend
      summary: Microsoft Azure Queues An Email Message To Be Sent To One Or More Recipients
      operationId: microsoftAzureEmailSend
      parameters:
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        required: true
        schema:
          type: string
      - in: header
        name: repeatability-first-sent
        description: Must be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created in the IMF-fix date form of HTTP-date as defined in RFC7231. eg- Tue, 26 Mar 2019 16:06:51 GMT
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Message accepted, the `Operation-Location` header contains the URL to poll for the message status.
          headers:
            Repeatability-Result:
              description: Status of a repeatable request.
              schema:
                type: string
            Operation-Location:
              description: Location url of where to poll the status of this message from.
              schema:
                type: string
            Retry-After:
              description: 'Amount of time client should wait before retrying the request, specified in seconds '
              schema:
                type: integer
            x-ms-request-id:
              description: System generated GUID indicating the id of this specific message, to be used for tracking purposes.
              schema:
                type: string
        default:
          description: Error
          headers:
            x-ms-error-code:
              description: Error code - this will be the same as the code in the error property in the response body.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Send Email:
          $ref: ./examples/SendEmail.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailMessage'
        description: Message payload for sending an email
        required: true
components:
  schemas:
    EmailAddress:
      description: An object representing the email address and its display name
      type: object
      required:
      - email
      properties:
        email:
          description: Email address.
          type: string
          example: abc@contoso.com
        displayName:
          description: Email display name.
          type: string
          example: abc
    EmailImportance:
      description: The importance type for the email.
      enum:
      - high
      - normal
      - low
      type: string
      default: normal
      x-ms-enum:
        name: EmailImportance
        modelAsString: true
    EmailAttachment:
      description: Attachment to the email.
      type: object
      required:
      - name
      - attachmentType
      - contentBytesBase64
      properties:
        name:
          description: Name of the attachment
          type: string
          example: attachment.pdf
        attachmentType:
          $ref: '#/components/schemas/EmailAttachmentType'
        contentBytesBase64:
          description: Base64 encoded contents of the attachment
          type: string
          example: TWFueSBoYW5kcyBtYWtlIGxpZ2h0I
    EmailRecipients:
      description: Recipients of the email
      type: object
      required:
      - to
      properties:
        to:
          description: Email To recipients
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        CC:
          description: Email CC recipients
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        bCC:
          description: Email BCC recipients
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
    EmailContent:
      description: Content of the email.
      type: object
      required:
      - subject
      properties:
        subject:
          description: Subject of the email message
          type: string
          example: An exciting offer especially for you!
        plainText:
          description: Plain text version of the email message.
          type: string
          example: This exciting offer was created especially for you, our most loyal customer.
        html:
          description: Html version of the email message.
          type: string
          example: <html><head><title>Exciting offer!</title></head><body><h1>This exciting offer was created especially for you, our most loyal customer.</h1></body></html>
    EmailMessage:
      description: Message payload for sending an email
      required:
      - sender
      - content
      - recipients
      type: object
      properties:
        headers:
          description: Custom email headers to be passed.
          type: array
          x-ms-client-name: CustomHeaders
          items:
            $ref: '#/components/schemas/EmailCustomHeader'
        sender:
          description: Sender email address from a verified domain.
          type: string
          example: info@contoso.com
        content:
          description: Email content to be sent.
          $ref: '#/components/schemas/EmailContent'
        importance:
          description: The importance type for the email.
          $ref: '#/components/schemas/EmailImportance'
        recipients:
          description: Recipients for the email.
          $ref: '#/components/schemas/EmailRecipients'
        attachments:
          description: list of attachments
          type: array
          items:
            $ref: '#/components/schemas/EmailAttachment'
        replyTo:
          description: Email addresses where recipients' replies will be sent to.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        disableUserEngagementTracking:
          description: Indicates whether user engagement tracking should be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane.
          type: boolean
    EmailAttachmentType:
      description: The type of attachment file.
      enum:
      - avi
      - bmp
      - doc
      - docm
      - docx
      - gif
      - jpeg
      - mp3
      - one
      - pdf
      - png
      - ppsm
      - ppsx
      - ppt
      - pptm
      - pptx
      - pub
      - rpmsg
      - rtf
      - tif
      - txt
      - vsd
      - wav
      - wma
      - xls
      - xlsb
      - xlsm
      - xlsx
      type: string
      x-ms-enum:
        name: EmailAttachmentType
        modelAsString: true
    EmailCustomHeader:
      description: Custom header for email.
      type: object
      required:
      - name
      - value
      properties:
        name:
          description: Header name.
          type: string
          example: ''
        value:
          description: Header value.
          type: string
          example: ''
    EmailAddress_2:
      description: An object representing the email address and its display name
      type: object
      required:
      - address
      properties:
        address:
          description: Email address.
          type: string
          example: abc@contoso.com
        displayName:
          description: Email display name.
          type: string
          example: abc
    EmailAttachment_2:
      description: Attachment to the email.
      type: object
      required:
      - name
      - contentType
      - contentInBase64
      properties:
        name:
          description: Name of the attachment
          type: string
          example: attachment.pdf
        contentType:
          description: MIME type of the content being attached.
          type: string
          example: text/plain
        contentInBase64:
          description: Base64 encoded contents of the attachment
          type: string
          format: byte
          example: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=
    EmailRecipients_2:
      description: Recipients of the email
      type: object
      required:
      - to
      properties:
        to:
          description: Email To recipients
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress_2'
        cc:
          description: Email CC recipients
          type: array
          x-ms-client-name: CC
          items:
            $ref: '#/components/schemas/EmailAddress_2'
        bcc:
          description: Email BCC recipients
          type: array
          x-ms-client-name: BCC
          items:
            $ref: '#/components/schemas/EmailAddress_2'
    EmailMessage_2:
      description: Message payload for sending an email
      required:
      - senderAddress
      - content
      - recipients
      type: object
      properties:
        headers:
          description: Custom email headers to be passed.
          type: object
          additionalProperties:
            type: string
        senderAddress:
          description: Sender email address from a verified domain.
          type: string
          example: info@contoso.com
        content:
          description: Email content to be sent.
          $ref: '#/components/schemas/EmailContent'
        recipients:
          description: Recipients for the email.
          $ref: '#/components/schemas/EmailRecipients_2'
        attachments:
          description: List of attachments. Please note that we limit the total size of an email request (which includes attachments) to 10MB.
          type: array
          items:
            $ref: '#/components/schemas/EmailAttachment_2'
        replyTo:
          description: Email addresses where recipients' replies will be sent to.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress_2'
        userEngagementTrackingDisabled:
          description: Indicates whether user engagement tracking should be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane.
          type: boolean
    EmailSendResult:
      description: Status of the long running operation
      required:
      - id
      - status
      type: object
      properties:
        id:
          description: The unique id of the operation. Use a UUID.
          type: string
          example: 8540c0de-899f-5cce-acb5-3ec493af3800
        status:
          description: Status of operation.
          enum:
          - NotStarted
          - Running
          - Succeeded
          - Failed
          - Canceled
          type: string
          x-ms-enum:
            name: EmailSendStatus
            modelAsString: true
        error:
          description: Error details when status is a non-success terminal state.
          $ref: ../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail
  parameters:
    ApiVersionParameter:
      in: query
      name: api-version
      description: Version of API to invoke.
      required: true
      schema:
        type: string
        enum:
        - 2021-10-01-preview
    ApiVersionParameter_2:
      in: query
      name: api-version
      description: Version of API to invoke.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
      description: An authentication string containing a signature generated using HMAC-SHA256 scheme.
x-refined-from:
- communicationemailclient-openapi-original.yml
- emailclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'