Oracle ${email Configuration Tag} API

openapi: 3.2.0
info:
  description: "Use the Email Delivery API to do the necessary set up to send high-volume and application-generated emails through the OCI Email Delivery service.\nFor more information, see [Overview of the Email Delivery Service](/iaas/Content/Email/Concepts/overview.htm).\n\n **Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API.\n If a subsequent read request fails to reflect your changes, wait a few minutes and try again.\n"
  license:
    name: Oracle Corporation
  title: Email Delivery ${email Configuration Tag} ${email Configuration Tag} API
  version: '20170907'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Email Delivery API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    what: the harvested document for Email Delivery API
servers:
- url: https://127.0.0.1/20170907
tags:
- name: ${email-configuration-tag}
paths:
  /configuration:
    get:
      description: 'Returns  email configuration associated with the specified compartment.

        '
      operationId: GetEmailConfiguration
      parameters:
      - $ref: '#/components/parameters/compartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        '200':
          description: Email configuration object.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Configuration'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Get Email Configuration
      tags:
      - ${email-configuration-tag}
      x-related-resource: '#/definitions/Configuration'
components:
  schemas:
    Configuration:
      description: Tenancy level customer email configuration details.
      properties:
        compartmentId:
          description: The root compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) (same as the tenancy OCID)
          maxLength: 255
          minLength: 1
          type: string
        httpSubmitEndpoint:
          description: Endpoint used to submit emails via the HTTP email submission API
          maxLength: 255
          minLength: 1
          type: string
        smtpSubmitEndpoint:
          description: Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - httpSubmitEndpoint
      - smtpSubmitEndpoint
      type: object
    Error:
      description: An error has occurred.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
  parameters:
    compartmentIdQueryParam:
      description: The OCID for the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    RequestIdHeader:
      description: The request ID for tracing from the system
      in: header
      name: opc-request-id
      schema:
        type: string
  responses:
    '400':
      description: Incorrectly formatted request.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '500':
      description: Internal Server Error.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '401':
      description: 'The required information to complete authentication was not provided or

        was incorrect. Extra detail may be provided in the response body.

        '
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '404':
      description: Authorization failed or the requested resource was not found.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: Too Many Requests
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    location:
      description: 'The full URI of the resource related to the request

        '
      format: uri-reference
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages of results remain.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-previous-page:
      description: 'For list pagination. When this header appears in the response, previous pages of results remain.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-total-items:
      description: 'The total number of items returned from the request.

        '
      type: integer
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string type is supported as valid value type.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


        Example: `{"Department": "Finance"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-oracle-package: com.oracle.pic.email