SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO EMAILS API

6 actions 6 updates phrasing extends openapi/smtp2go-emails-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SMTP2GO's API. It is a proposal applied on top of the contract, not a document SMTP2GO publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/email/batch'].post
$.paths['/email/mime'].post
$.paths['/email/scheduled/remove'].post
$.paths['/email/scheduled/search'].post
$.paths['/email/send'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO EMAILS API
  version: 1.0.0
extends: openapi/smtp2go-emails-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/email/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a batch of emails
      effect: write
      questions:
      - Can I send many different emails in a single request?
      - How do I submit a batch of email messages together?
      instructions:
      - text: 'Send this batch of emails: {emails}.'
        slots:
          emails: requestBody.emails
      - text: Submit {emails} as one batch send.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/mime'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a pre-encoded MIME email
      effect: write
      questions:
      - How do I send an email I've already built as a raw MIME string?
      - Can a MIME message be scheduled for later delivery?
      instructions:
      - text: Send the MIME message {mime_email}.
        slots:
          mime_email: requestBody.mime_email
      - text: Send MIME email {mime_email} scheduled for {schedule}.
        slots:
          mime_email: requestBody.mime_email
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/scheduled/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled email
      effect: destructive
      questions:
      - How do I cancel an email that's scheduled but not yet sent?
      - Can I stop a scheduled send using its schedule ID?
      instructions:
      - text: Cancel scheduled email {schedule_id}.
        slots:
          schedule_id: requestBody.schedule_id
      - text: Remove the scheduled send {schedule_id} so it never goes out.
        slots:
          schedule_id: requestBody.schedule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/scheduled/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search scheduled emails
      effect: read
      questions:
      - Which emails do I have scheduled to go out later?
      - Can I look up queued scheduled emails by recipient or subject?
      instructions:
      - text: List my scheduled emails.
      - text: Find scheduled emails addressed to {search_recipient}.
        slots:
          search_recipient: requestBody.search_recipient
      - text: Search scheduled emails with subject {search_subject}.
        slots:
          search_subject: requestBody.search_subject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email
      effect: write
      questions:
      - How do I send a transactional email with SMTP2GO using JSON?
      - Can I send an email using a saved template and fill in its variables?
      - What fields do I need to send a single email with attachments?
      instructions:
      - text: Send an email from {sender} to {to} with subject {subject}.
        slots:
          sender: requestBody.sender
          to: requestBody.to
          subject: requestBody.subject
      - text: Email {to} from {sender} using template {template_id} with data {template_data}.
        slots:
          to: requestBody.to
          sender: requestBody.sender
          template_id: requestBody.template_id
          template_data: requestBody.template_data
      - text: Send an email from {sender} to {to} scheduled for {schedule}.
        slots:
          sender: requestBody.sender
          to: requestBody.to
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'