API Evangelist conversational phrasing for Postmark Server Messages API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postmark Server Messages API
  version: 1.0.0
extends: openapi/postmark-messages-api-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: 11
- target: $.paths['/messages/outbound'].get
  update:
    x-apievangelist-phrasing:
      intent: Search sent emails
      effect: read
      questions:
      - Did my password reset email actually go out to a particular customer?
      - Can I search outgoing messages by sender address and tag?
      - Which outbound emails are still queued rather than sent?
      instructions:
      - text: Search sent emails to {recipient} from {fromdate} to {todate}.
        slots:
          recipient: query.recipient
          fromdate: query.fromdate
          todate: query.todate
      - text: List the latest {count} outbound messages tagged {tag}.
        slots:
          count: query.count
          tag: query.tag
      - text: Find outbound messages from {fromemail} with status {status}.
        slots:
          fromemail: query.fromemail
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/{messageid}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a sent email
      effect: read
      questions:
      - What happened to one specific email I sent — was it delivered?
      - Can I see the body and delivery events of a single outbound message?
      instructions:
      - text: Show the details and delivery events for sent message {messageid}.
        slots:
          messageid: path.messageid
      - text: Get outbound message {messageid}.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/{messageid}/dump'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the raw source of a sent email
      effect: read
      questions:
      - How do I see the raw SMTP source of an email I sent?
      - Can I download the full headers and MIME dump for an outbound message?
      instructions:
      - text: Dump the raw source of outbound message {messageid}.
        slots:
          messageid: path.messageid
      - text: Give me the full MIME dump of sent email {messageid}.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound'].get
  update:
    x-apievangelist-phrasing:
      intent: Search received inbound emails
      effect: read
      questions:
      - Which inbound emails failed processing or got blocked this week?
      - Can I search received mail by subject or mailbox hash?
      - Has anything arrived from a particular sender in my inbound stream?
      instructions:
      - text: Search inbound emails with subject {subject}.
        slots:
          subject: query.subject
      - text: List {count} inbound messages with status {status} since {fromdate}.
        slots:
          count: query.count
          status: query.status
          fromdate: query.fromdate
      - text: Find inbound mail from {fromemail} sent to mailbox hash {mailboxhash}.
        slots:
          fromemail: query.fromemail
          mailboxhash: query.mailboxhash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound/{messageid}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a received email
      effect: read
      questions:
      - What did a specific inbound email contain and how was it processed?
      - Can I look up one received message by its ID?
      instructions:
      - text: Show inbound message {messageid}.
        slots:
          messageid: path.messageid
      - text: Get the content and processing details of received email {messageid}.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound/{messageid}/bypass'].put
  update:
    x-apievangelist-phrasing:
      intent: Let a blocked inbound email through
      effect: write
      questions:
      - An inbound email got blocked by my rules — how do I let it through?
      - Can I bypass inbound rules for just one blocked message?
      instructions:
      - text: Bypass inbound rules for blocked message {messageid}.
        slots:
          messageid: path.messageid
      - text: Release blocked inbound email {messageid} past the rules.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound/{messageid}/retry'].put
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed inbound email
      effect: write
      questions:
      - My inbound webhook was down — how do I reprocess a failed message?
      - Can I retry delivery of a failed inbound email to my endpoint?
      instructions:
      - text: Retry processing of failed inbound message {messageid}.
        slots:
          messageid: path.messageid
      - text: Reprocess inbound email {messageid} now that the webhook is back.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/opens'].get
  update:
    x-apievangelist-phrasing:
      intent: Search email open events
      effect: read
      questions:
      - Who opened my emails, and from which email clients?
      - Can I filter open events by country or by mobile versus desktop?
      - Which recipients opened messages carrying a specific tag?
      instructions:
      - text: List opens across all messages tagged {tag}.
        slots:
          tag: query.tag
      - text: Show {count} email opens from {country} on platform {platform}.
        slots:
          count: query.count
          country: query.country
          platform: query.platform
      - text: Find open events by {recipient} using client {client_name}.
        slots:
          recipient: query.recipient
          client_name: query.client_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/opens/{messageid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get opens for one sent email
      effect: read
      questions:
      - Has a specific email I sent been opened, and how many times?
      - Can I see every open event recorded for one message?
      instructions:
      - text: Show the opens for message {messageid}.
        slots:
          messageid: path.messageid
      - text: List the first {count} open events on sent email {messageid}.
        slots:
          count: query.count
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/clicks'].get
  update:
    x-apievangelist-phrasing:
      intent: Search link click events
      effect: read
      questions:
      - Which links in my emails are recipients clicking, and from where?
      - Can I filter link clicks by operating system or city?
      - What browsers do people click my email links from?
      instructions:
      - text: List link clicks across all messages tagged {tag}.
        slots:
          tag: query.tag
      - text: Show {count} clicks from {city} on OS family {os_family}.
        slots:
          count: query.count
          city: query.city
          os_family: query.os_family
      - text: Find link clicks by recipient {recipient}.
        slots:
          recipient: query.recipient
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/clicks/{messageid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link clicks for one sent email
      effect: read
      questions:
      - Did anyone click the links in one particular email I sent?
      - Can I see each click event recorded for a single message?
      instructions:
      - text: Show link clicks for message {messageid}.
        slots:
          messageid: path.messageid
      - text: List the first {count} click events on sent email {messageid}.
        slots:
          count: query.count
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'