insforge--insforge/openapi/email.yaml

openapi: 3.0.3
info:
  title: Insforge Email API
  version: 1.0.0
  description: Custom email sending endpoints for sending raw HTML emails

paths:
  /api/email/send-raw:
    post:
      summary: Send raw HTML email
      description: Send a custom HTML email to one or more recipients. Requires user authentication.
      tags:
        - Client
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendRawEmailRequest'
      responses:
        '200':
          description: Email sent successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendEmailResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - requires authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Email provider error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    SendRawEmailRequest:
      type: object
      required:
        - to
        - subject
        - html
      properties:
        to:
          oneOf:
            - type: string
              format: email
              description: Single recipient email address
              example: user@example.com
            - type: array
              items:
                type: string
                format: email
              minItems: 1
              maxItems: 50
              description: Multiple recipient email addresses (max 50)
              example: ["user1@example.com", "user2@example.com"]
          description: Recipient email address(es) - maximum 50 recipients
        subject:
          type: string
          minLength: 1
          maxLength: 500
          description: Email subject line
          example: "Welcome to our platform"
        html:
          type: string
          minLength: 1
          description: HTML content of the email body
          example: "<h1>Welcome!</h1><p>Thank you for joining us.</p>"
        cc:
          oneOf:
            - type: string
              format: email
              description: Single CC recipient email address
            - type: array
              items:
                type: string
                format: email
              minItems: 1
              maxItems: 50
              description: Multiple CC recipient email addresses (max 50)
          description: Carbon copy recipient(s) - maximum 50 recipients
        bcc:
          oneOf:
            - type: string
              format: email
              description: Single BCC recipient email address
            - type: array
              items:
                type: string
                format: email
              minItems: 1
              maxItems: 50
              description: Multiple BCC recipient email addresses (max 50)
          description: Blind carbon copy recipient(s) - maximum 50 recipients
        from:
          type: string
          maxLength: 100
          description: Custom sender name (uses default if not provided)
          example: "My App"
        replyTo:
          type: string
          format: email
          description: Reply-to email address
          example: "support@example.com"

    SendEmailResponse:
      type: object
      description: Empty object on success - extend with optional fields later if needed

    ErrorResponse:
      type: object
      required:
        - error
        - message
        - statusCode
      properties:
        error:
          type: string
          description: Error code for programmatic handling
          example: "VALIDATION_ERROR"
        message:
          type: string
          description: Human-readable error message
          example: "Subject is required"
        statusCode:
          type: integer
          description: HTTP status code
          example: 400
        nextActions:
          type: string
          description: Suggested action to resolve the error
          example: "Please provide a valid subject line"