# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
method: generated
vocabulary:
  - term: server
    label: Server (Inbox)
    definition: >-
      A Mailosaur virtual SMTP/SMS endpoint that acts as a test inbox. Each
      server has its own domain (e.g., a1bcdef2.mailosaur.net) and SMTP, POP3,
      and IMAP credentials. Also referred to as an "inbox".
    synonyms:
      - inbox
      - test inbox
    related:
      - message
      - serverId

  - term: message
    label: Message
    definition: >-
      An email or SMS message received by a Mailosaur server (inbox). Messages
      contain full content including HTML/text body, attachments, headers, and
      metadata. Can be of type Email or SMS.
    synonyms:
      - email
      - SMS
    related:
      - server
      - attachment
      - messageId

  - term: searchCriteria
    label: Search Criteria
    definition: >-
      Filters used to find a specific message within a Mailosaur inbox. Criteria
      can include sentFrom (sender address), sentTo (recipient address), subject
      line, and body content. Can be matched with ALL (default) or ANY logic.
    related:
      - message
      - search

  - term: attachment
    label: Attachment
    definition: >-
      A file attached to an email message. Attachments have a content type,
      filename, and can be downloaded individually via the Files API using their
      unique identifier.
    related:
      - message
      - files

  - term: device
    label: Virtual Security Device
    definition: >-
      A virtual device that simulates an authenticator app for TOTP (Time-based
      One-Time Password) testing. Devices are created with a shared secret and
      can generate current OTPs for testing two-factor authentication flows.
    synonyms:
      - TOTP device
      - 2FA device
      - authenticator device
    related:
      - otp
      - sharedSecret

  - term: otp
    label: One-Time Password (OTP)
    definition: >-
      A time-based one-time password generated by a virtual security device.
      OTPs are used in automated testing of multi-factor authentication flows.
      Each OTP has a short expiry window (typically 30 seconds).
    synonyms:
      - TOTP
      - one-time password
      - verification code
    related:
      - device
      - sharedSecret

  - term: sharedSecret
    label: Shared Secret
    definition: >-
      A base32-encoded secret used to configure a TOTP device. The shared
      secret is typically provided by the application under test when setting
      up two-factor authentication and is used by Mailosaur to generate
      matching OTPs.
    related:
      - device
      - otp

  - term: spamAnalysis
    label: Spam Analysis
    definition: >-
      An analysis of an email message using SpamAssassin to evaluate the
      likelihood of the email being classified as spam. Returns a spam score
      and individual rule results that triggered.
    related:
      - spamScore
      - spamFilterResults
      - deliverabilityReport

  - term: deliverabilityReport
    label: Deliverability Report
    definition: >-
      A comprehensive analysis of an email's deliverability, including SPF,
      DKIM, and DMARC authentication results, blocklist checks, DNS records,
      content analysis, and SpamAssassin scoring.
    related:
      - spf
      - dkim
      - dmarc
      - blockList
      - spamAnalysis

  - term: spf
    label: SPF (Sender Policy Framework)
    definition: >-
      An email authentication method that specifies which mail servers are
      authorized to send email on behalf of a domain. Mailosaur checks SPF
      records as part of deliverability analysis.
    related:
      - dkim
      - dmarc
      - deliverabilityReport

  - term: dkim
    label: DKIM (DomainKeys Identified Mail)
    definition: >-
      An email authentication technique that adds a digital signature to
      outgoing emails. Mailosaur verifies DKIM signatures as part of
      deliverability analysis.
    related:
      - spf
      - dmarc
      - deliverabilityReport

  - term: dmarc
    label: DMARC (Domain-based Message Authentication)
    definition: >-
      An email authentication policy that builds on SPF and DKIM to provide
      domain-level protection against email spoofing and phishing. Mailosaur
      evaluates DMARC policies as part of deliverability analysis.
    related:
      - spf
      - dkim
      - deliverabilityReport

  - term: preview
    label: Email Preview
    definition: >-
      A screenshot of an email rendered in a real email client application.
      Mailosaur can generate previews in multiple email clients (e.g., Gmail,
      Outlook) to verify email rendering across platforms.
    related:
      - emailClient
      - message

  - term: emailClient
    label: Email Client
    definition: >-
      An email client application (e.g., Gmail Web, Apple Mail, Outlook) used
      to render email previews. Mailosaur supports a range of clients for
      cross-client testing.
    related:
      - preview

  - term: usageLimits
    label: Usage Limits
    definition: >-
      The maximum allowed quantities for your Mailosaur account, such as the
      number of servers, users, email messages, and SMS messages. Requires an
      account-level API key to access.
    related:
      - usageTransactions
      - apiKey

  - term: apiKey
    label: API Key
    definition: >-
      The credential used to authenticate with the Mailosaur REST API via
      HTTP Basic Auth. The API key is used as the username; the password field
      is left empty or also set to the API key. Account-level API keys grant
      access to usage endpoints.
    related:
      - authentication
      - usageLimits