API Evangelist conversational phrasing for Live Direct Marketing Online Email Accounts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Email Accounts API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-email-accounts-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: 40
- target: $.paths['/api/email-accounts/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up SMTP/IMAP settings for an address
      effect: read
      questions:
      - What SMTP and IMAP server settings should I use for a given email address?
      - Can the platform detect the mail host and ports for an address before I add the mailbox?
      instructions:
      - text: Look up the SMTP and IMAP settings for {email}.
        slots:
          email: query.email
      - text: Find which mail provider hosts {email} and its server ports.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/test-unsaved'].post
  update:
    x-apievangelist-phrasing:
      intent: Test mailbox credentials before saving
      effect: read
      questions:
      - Can I check SMTP and IMAP credentials work before I save a new mailbox?
      - Is there a way to dry-run a login to a mail server without creating the account?
      instructions:
      - text: Test these SMTP/IMAP credentials without saving the mailbox.
      - text: Check that the unsaved mailbox login details connect before I add it.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List sending email accounts
      effect: read
      questions:
      - Which email accounts do I have connected for sending?
      - Can I filter my mailboxes by status, service or send method?
      - How do I find mailboxes in a particular account list?
      instructions:
      - text: List my email accounts with status {status}.
        slots:
          status: query.status
      - text: Show the mailboxes in account list {listId}.
        slots:
          listId: query.listId
      - text: Search my email accounts for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new email account
      effect: write
      questions:
      - How do I add a new mailbox for sending campaigns?
      - Can I set daily and hourly send limits when I connect a new email account?
      instructions:
      - text: Add a new email account for {email} with SMTP host {smtpHost}.
        slots:
          email: requestBody.email
          smtpHost: requestBody.smtpHost
      - text: Connect mailbox {email} with a daily send limit of {dailySendLimit}.
        slots:
          email: requestBody.email
          dailySendLimit: requestBody.dailySendLimit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get totals across all email accounts
      effect: read
      questions:
      - What are the aggregated stats across all my email accounts?
      - How many mailboxes do I have in total and in what state?
      instructions:
      - text: Show aggregate statistics across all my email accounts.
      - text: Summarize my whole mailbox fleet in one set of numbers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/check-duplicate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an email address is already added
      effect: read
      questions:
      - Is this email address already registered as a mailbox?
      - Can I check for a duplicate before adding an account?
      instructions:
      - text: Check whether {email} is already registered as an email account.
        slots:
          email: query.email
      - text: Tell me if {email} would be a duplicate mailbox.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/relay-health-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize relay health across the tenant
      effect: read
      questions:
      - How many of my relays are sending right now and how many dropped out?
      - Why did relays drop out of sending, such as bounce limits or auth errors?
      instructions:
      - text: Give me the tenant-wide relay health summary.
      - text: Show how many relays are active and the reasons the others dropped out.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/relay-health/attention'].get
  update:
    x-apievangelist-phrasing:
      intent: List relays that need a human to fix
      effect: read
      questions:
      - Which relays has automation given up recovering?
      - What relays in error state need manual attention, and why did probing fail?
      instructions:
      - text: List the relays escalated for human attention.
      - text: Show the error relays that repeated re-probing could not recover.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/relay-health/probe'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-probe failed relays now
      effect: write
      questions:
      - Can I re-check my errored relays now instead of waiting for the scheduled cron?
      - Does re-probing failed relays send a test email?
      instructions:
      - text: Re-probe all my errored relays right now.
      - text: Run the relay recovery probe immediately and tell me how many came back into the pool.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sending stats for one email account
      effect: read
      questions:
      - How many emails has one specific mailbox sent?
      - Where can I see per-account email statistics?
      instructions:
      - text: Show email statistics for account {id}.
        slots:
          id: path.id
      - text: Get the per-mailbox send stats for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email account's details
      effect: read
      questions:
      - What settings does a particular email account have configured?
      - Can I fetch a single mailbox record by its id?
      instructions:
      - text: Get email account {id}.
        slots:
          id: path.id
      - text: Show the configuration of mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email account
      effect: destructive
      questions:
      - How do I remove a mailbox I no longer use?
      - Can I permanently delete an email account from my workspace?
      instructions:
      - text: Delete email account {id}.
        slots:
          id: path.id
      - text: Remove mailbox {id} from my accounts.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email account
      effect: write
      questions:
      - Can I change the settings of a mailbox I already added?
      - Why can't I set an errored or suspended account to paused?
      instructions:
      - text: Update the settings of email account {id}.
        slots:
          id: path.id
      - text: Edit mailbox {id} I already connected.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/import-oauth'].post
  update:
    x-apievangelist-phrasing:
      intent: Import one Outlook account from an OAuth combo
      effect: write
      questions:
      - Can I import a single Outlook or Hotmail account using a refresh token combo?
      - Does the platform refresh the Outlook access token itself after import?
      instructions:
      - text: Import the Outlook account from combo {combo}.
        slots:
          combo: requestBody.combo
      - text: Add Hotmail account {email} using refresh token {refreshToken} and client id {clientId}.
        slots:
          email: requestBody.email
          refreshToken: requestBody.refreshToken
          clientId: requestBody.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/import-oauth/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-import Outlook accounts from OAuth combos
      effect: write
      questions:
      - How do I import many Outlook or Hotmail accounts at once?
      - Can I put a batch of imported OAuth mailboxes straight into one list?
      instructions:
      - text: 'Bulk-import these Outlook combos: {combos}.'
        slots:
          combos: requestBody.combos
      - text: Import the OAuth combo list {combos} into account list {listId}.
        slots:
          combos: requestBody.combos
          listId: requestBody.listId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/fetch-imap'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch new mail over IMAP for an account
      effect: write
      questions:
      - Can I pull new messages for a mailbox right now instead of waiting?
      - How do I trigger an IMAP fetch on one account?
      instructions:
      - text: Trigger an IMAP fetch for account {id}.
        slots:
          id: path.id
      - text: Pull the latest inbox messages for mailbox {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a saved account's SMTP/IMAP connection
      effect: read
      questions:
      - Is my saved mailbox still able to connect to its SMTP and IMAP servers?
      - Can I run a basic connectivity check on an existing account?
      instructions:
      - text: Test SMTP and IMAP connectivity for saved account {id}.
        slots:
          id: path.id
      - text: Check whether mailbox {id} can still reach its mail servers.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/test-receive'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the universal receive test on an account
      effect: read
      questions:
      - Can this mailbox actually receive mail through its real transport?
      - Which receive path, such as Graph or IMAP via agent, does my account use and does it work?
      instructions:
      - text: Run the receive test on account {id}.
        slots:
          id: path.id
      - text: Probe the real inbound transport for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/test-send'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the universal send test on an account
      effect: read
      questions:
      - Will this mailbox be able to send through its real transport?
      - Can I dry-run the send path of an account without mailing anyone?
      instructions:
      - text: Run the send test on account {id}.
        slots:
          id: path.id
      - text: Dry-run the outbound transport for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/dns-check'].get
  update:
    x-apievangelist-phrasing:
      intent: Check DNS health of an account's domain
      effect: read
      questions:
      - Are the DNS records for my mailbox's domain set up correctly?
      - Can I check SPF and other DNS health for the domain an account sends from?
      instructions:
      - text: Run a DNS health check for account {id}.
        slots:
          id: path.id
      - text: Check the sending domain DNS of mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/reset-counters'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an account's daily send counters
      effect: write
      questions:
      - Can I reset the daily send count on a mailbox that hit its limit?
      - How do I zero out today's sending counters for one account?
      instructions:
      - text: Reset the daily send counters for account {id}.
        slots:
          id: path.id
      - text: Clear today's send count on mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/warmup/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start warm-up for a mailbox
      effect: write
      questions:
      - How do I begin warming up a new mailbox?
      - Can I turn on warm-up for one email account?
      instructions:
      - text: Start warm-up for account {id}.
        slots:
          id: path.id
      - text: Begin warming up mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/warmup/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop warm-up for a mailbox
      effect: write
      questions:
      - Can I halt warm-up on a mailbox that is already warming?
      - What turns off warm-up for one account?
      instructions:
      - text: Stop warm-up for account {id}.
        slots:
          id: path.id
      - text: End the warm-up running on mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/warmup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get warm-up stats for a mailbox
      effect: read
      questions:
      - How is the warm-up progressing on my mailbox?
      - Where can I see warm-up statistics for one account?
      instructions:
      - text: Show warm-up stats for account {id}.
        slots:
          id: path.id
      - text: Get the warm-up progress of mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/warmup'].patch
  update:
    x-apievangelist-phrasing:
      intent: Configure warm-up settings for a mailbox
      effect: write
      questions:
      - Can I change the warm-up parameters for a mailbox?
      - How do I tune warm-up settings on one account?
      instructions:
      - text: Change the warm-up configuration of account {id}.
        slots:
          id: path.id
      - text: Adjust warm-up parameters for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend an email account
      effect: write
      questions:
      - Can I suspend a mailbox so it stops sending?
      - What happens when I suspend an email account?
      instructions:
      - text: Suspend email account {id}.
        slots:
          id: path.id
      - text: Put mailbox {id} into suspended state.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/unsuspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsuspend an email account
      effect: write
      questions:
      - How do I bring a suspended mailbox back into service?
      - Can I lift the suspension on an account?
      instructions:
      - text: Unsuspend email account {id}.
        slots:
          id: path.id
      - text: Reactivate suspended mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/work-status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an account's work status to idle or in progress
      effect: write
      questions:
      - Can I mark a mailbox as in progress or idle?
      - How do I flag that someone is currently working an account?
      instructions:
      - text: Set the work status of account {id} to in progress.
        slots:
          id: path.id
      - text: Mark mailbox {id} as idle.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/setup'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate Google Apps Script setup steps
      effect: write
      questions:
      - How do I set up a Google Apps Script web app for a Gmail account?
      - Can the platform generate GAS setup instructions for my mailbox?
      instructions:
      - text: Generate GAS setup instructions for account {id}.
        slots:
          id: path.id
      - text: Give me the Apps Script setup steps for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a deployed Apps Script web app URL
      effect: write
      questions:
      - Can I confirm my deployed Apps Script web app URL is correct?
      - What checks my GAS deployment after I publish it?
      instructions:
      - text: Verify the deployed GAS web app for account {id}.
        slots:
          id: path.id
      - text: Validate the Apps Script URL I deployed for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/ping'].post
  update:
    x-apievangelist-phrasing:
      intent: Ping an account's Apps Script web app
      effect: read
      questions:
      - Is my Apps Script web app still reachable?
      - Can I ping the GAS endpoint to check connectivity?
      instructions:
      - text: Ping the GAS web app of account {id}.
        slots:
          id: path.id
      - text: Check that the Apps Script endpoint for mailbox {id} responds.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/test-send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test email through Apps Script
      effect: write
      questions:
      - Can I send a real test email through the Apps Script integration?
      - Does sending via GAS work for my Gmail account?
      instructions:
      - text: Send a test email via GAS from account {id}.
        slots:
          id: path.id
      - text: Mail a test message through the Apps Script of mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/test-fetch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a test inbox fetch through Apps Script
      effect: read
      questions:
      - Can the Apps Script integration fetch messages from my inbox?
      - How do I test reading mail through GAS?
      instructions:
      - text: Run a test fetch via GAS for account {id}.
        slots:
          id: path.id
      - text: Try pulling inbox mail through the Apps Script of mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/disable'].patch
  update:
    x-apievangelist-phrasing:
      intent: Disable the Apps Script integration
      effect: destructive
      questions:
      - How do I turn off the Google Apps Script integration on a mailbox?
      - Can I stop an account from using GAS?
      instructions:
      - text: Disable the GAS integration for account {id}.
        slots:
          id: path.id
      - text: Switch off Apps Script on mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/gas/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List Gmail labels via Apps Script
      effect: read
      questions:
      - Which Gmail labels can the Apps Script integration see?
      - Can I list a Gmail account's labels through GAS?
      instructions:
      - text: List the Gmail labels for account {id}.
        slots:
          id: path.id
      - text: Show the labels available through Apps Script on mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-account-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List email account lists
      effect: read
      questions:
      - What lists or pools have I grouped my mailboxes into?
      - Can I see all my email account lists?
      instructions:
      - text: List my email account lists.
      - text: Show every mailbox group I've created.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-account-lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email account list
      effect: write
      questions:
      - How do I create a new group to organize my mailboxes?
      - Can I make a new relay pool list for accounts?
      instructions:
      - text: Create a new email account list.
      - text: Make a new mailbox group for my accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-account-lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email account list
      effect: destructive
      questions:
      - Can I delete a mailbox group I no longer need?
      - What happens when I remove an email account list?
      instructions:
      - text: Delete email account list {id}.
        slots:
          id: path.id
      - text: Remove mailbox group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-account-lists/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email account list
      effect: write
      questions:
      - Can I rename or edit an existing mailbox group?
      - How do I change the settings of an email account list?
      instructions:
      - text: Update email account list {id}.
        slots:
          id: path.id
      - text: Edit mailbox group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-account-lists/{id}/relay-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check health of one relay pool
      effect: read
      questions:
      - Which accounts in a relay pool are eligible to send right now?
      - Is my relay pool starving, and which relay goes next?
      instructions:
      - text: Show relay pool health for list {id}.
        slots:
          id: path.id
      - text: Check eligibility and recent dispatches in relay pool {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'