For AI agents: the docs index is at https://docs.sublime.security/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Sublime SecuritySublime Security
DocumentationAPI ReferenceProduct Releases
Log InSublime Security
Documentation
Log In
DocumentationAPI ReferenceProduct Releases

Getting Started

  • Overview

Install Sublime

  • Installation Options
  • Sublime Cloud
  • Amazon AWS

Manage Sublime

  • Add Email/Message Sources
    • Microsoft 365
      • Sublime Cloud - Microsoft 365
      • Self Managed - Microsoft 365
    • Google Workspace
      • Sublime Cloud - Google Workspace
      • Self Managed - Google Workspace
    • IMAP
  • Configure "Report Phishing"
    • Add your abuse mailbox
    • Microsoft 365 Configure “Report Phishing”
    • Gmail Configure "Report Phishing"
  • Configure "Quarantine Digests"
  • Access & Authentication
    • Single Sign-On (SSO) Configuration
      • Okta
      • Entra ID (Azure)
      • Google
    • Role-Based Access Control (RBAC)
    • Message Access Controls
    • Customer Account Access
    • Managing API keys
  • Export to S3
    • Export Message MDMs
    • Export Audit Logs and Message Events
  • Email Data Loss Prevention (DLP)
  • Inline Protection for Inbound Messages
  • IP Authentication Override

Use Sublime

  • Message types
  • Message groups
  • MQL Detection Rules
    • Attack Surface Reduction
    • Rule Severity
    • Rule Feeds
      • Rules file format (YAML)
      • Private rule feed authentication
    • YARA
    • Using the MQL Editor
  • Automations
    • Auto-respond to User Reports
  • Actions
    • Quarantine
    • Trash
    • Warning Banners
    • Move to Spam
    • Auto-review
    • Track Link Clicks
    • Webhook
      • Tines Webhook
    • Alerts
      • Email Alert
      • Email Alert with EML Attached
      • Slack Alert
    • Move to Promotions
    • Delete Calendar Events
      • How to update permission settings to enable automatic deletion of calendar events
  • Lists
    • Configure the org_vips list
  • Exclusions
    • Configure Link Analysis Exclusions
  • Blocklisting
  • Attack Score
  • ASA: Autonomous Security Analyst
  • Prompt injection detection (beta)
  • ADÉ: Autonomous Detection Engineer
  • Email Bomb Protection
  • Advanced Graymail Protection
  • Tailored Phishing Simulations and Training

Tutorials

  • MQL Guides
    • How to use message header values in MQL
    • How to detect manual outbound forwards
    • How to detect text in attachments
    • How to detect lookalike domains
    • How to detect keywords or phrases in the body content of messages

Reference

  • Message Data Model (MDM)
  • Message Query Language (MQL)
    • Syntax
    • Composite type syntax
    • Missing or null values
    • Functions
      • Strings functions
      • RegEx functions
      • File functions
      • ML functions
      • Network functions
      • IP functions
      • HTML functions
      • Profile functions
    • Common snippets
  • Metrics Collection in Self-Hosted Deployments

How-to Guides

  • Onboarding Guide: MDR, MSP and MSSP Partners
  • Mimecast Migration Guide
  • Proofpoint Migration Guide

Integrations

  • OpenCTI
  • CrowdStrike Next-Gen SIEM
  • CrowdStrike Falcon Fusion (SOAR)
  • CrowdStrike Falcon Sandbox
    • Set up the CrowdStrike Falcon Sandbox integration
    • Submit EML Files to CrowdStrike Falcon Sandbox
    • Understand CrowdStrike Sandbox results in Sublime
    • Troubleshoot the CrowdStrike Sandbox integration

Support

  • Sublime Security - Access Requests

Message Data Model (MDM)

A standardized JSON schema for representing an email message.

Updated 2 months ago


How to detect keywords or phrases in the body content of messages
Message Query Language (MQL)