Halon Scripting Language

Halon is a fast, flexible and powerful email infrastructure software; designed for demanding uses such as large-scale email services. The Halon scripting language is a domain-specific language (DSL). It enables configuration of the behavior of email processing and delivery in a scriptable fashion.

This script language documentation references many other resources, such as:

• Manual

• Script library

• Knowledge base

Table of contents

• 1. About
  • 1.1. Design
• 2. Introduction
  • 2.1. Variables
  • 2.2. Functions
  • 2.3. Comments
• 3. Data types and literals
  • 3.1. Boolean
  • 3.2. Number
    • 3.2.1. Hexadecimal
    • 3.2.2. Octal
    • 3.2.3. Binary
  • 3.3. String
    • 3.3.1. Double-quoted string
    • 3.3.2. Raw string
  • 3.4. Regex
    • 3.4.1. Pattern modifiers
  • 3.5. Array
  • 3.6. Function
    • 3.6.1. Anonymous functions
    • 3.6.2. Named function pointers
  • 3.7. Object
  • 3.8. None
• 4. Operators
  • 4.1. Assignment
    • 4.1.1. Augmented assignment
    • 4.1.2. Nullish Coalescing assignment
    • 4.1.3. Destructuring assignment
    • 4.1.4. Slice assignment
  • 4.2. Arithmetic
  • 4.3. String
    • 4.3.1. Concatenation
    • 4.3.2. Format
    • 4.3.3. Repeat
  • 4.4. Array
    • 4.4.1. Subscript
    • 4.4.2. Slicing
    • 4.4.3. Push and pop
    • 4.4.4. Removing
    • 4.4.5. Repeat
    • 4.4.6. Spread
  • 4.5. Logic (boolean)
    • 4.5.1. Short-circuit evaluation
  • 4.6. Bitwise
  • 4.7. Comparison
    • 4.7.1. Loose equality table
    • 4.7.2. Truthiness
    • 4.7.3. Regular expression
  • 4.8. Function
    • 4.8.1. Call
  • 4.9. Class
    • 4.9.1. Property
    • 4.9.2. Scope resolution
      • 4.9.2.1. Static
• 5. Control structures
  • 5.1. echo
  • 5.2. if
    • 5.2.1. Ternary operator
    • 5.2.2. Null coalescing operator
  • 5.3. for
    • 5.3.1. break
    • 5.3.2. continue
  • 5.4. foreach
    • 5.4.1. break
    • 5.4.2. continue
  • 5.5. while
    • 5.5.1. break
    • 5.5.2. continue
  • 5.6. forever
    • 5.6.1. break
    • 5.6.2. continue
  • 5.7. switch
  • 5.8. match
  • 5.9. include
    • 5.9.1. include_once
  • 5.10. import
    • 5.10.1. variables
    • 5.10.2. functions
    • 5.10.3. wildcard
    • 5.10.4. data
      • 5.10.4.1. wildcard file imports
  • 5.11. function
    • 5.11.1. Named functions
      • 5.11.1.1. Function scope
    • 5.11.2. Anonymous functions
    • 5.11.3. Closure functions
    • 5.11.4. return
    • 5.11.5. Default argument
    • 5.11.6. Variadic function
    • 5.11.7. global
    • 5.11.8. Function calling
      • 5.11.8.1. Argument unpacking
      • 5.11.8.2. builtin
  • 5.12. function*
    • 5.12.1. generator object
    • 5.12.2. yield
  • 5.13. Exceptions
    • 5.13.1. try
    • 5.13.2. catch
    • 5.13.3. throw
  • 5.14. class
    • 5.14.1. constructor
    • 5.14.2. Instance
      • 5.14.2.1. $this
      • 5.14.2.2. variables
      • 5.14.2.3. functions
    • 5.14.3. Static
      • 5.14.3.1. variables
      • 5.14.3.2. functions
    • 5.14.4. Visibility
      • 5.14.4.1. private
    • 5.14.5. Permissions
      • 5.14.5.1. readonly
  • 5.15. cache
  • 5.16. barrier
• 6. Standard library
  • 6.1. Array
  • 6.2. Cryptographic
  • 6.3. Data types
  • 6.4. Date and time
  • 6.5. DNS
  • 6.6. Encodings and JSON
  • 6.7. File and HTTP
  • 6.8. Mail
  • 6.9. Mathematical
  • 6.10. MIME
  • 6.11. Misc
  • 6.12. Protocols
  • 6.13. String
  • 6.14. Regular expression
  • 6.15. Socket
  • 6.16. FFI
  • 6.17. Shared memory
  • 6.18. Queue
• 7. SMTP server
  • 7.1. Connect
    • 7.1.1. Variables
      • 7.1.1.1. Arguments
      • 7.1.1.2. Connection
      • 7.1.1.3. Transaction
    • 7.1.2. Functions
    • 7.1.3. On script error
    • 7.1.4. On implicit termination
  • 7.2. Proxy
    • 7.2.1. Variables
      • 7.2.1.1. Arguments
      • 7.2.1.2. Connection
        • 7.2.1.2.1. HELO
        • 7.2.1.2.2. TLS
          • 7.2.1.2.2.1. Peercert
        • 7.2.1.2.3. AUTH
      • 7.2.1.3. Transaction
        • 7.2.1.3.1. Recipient
        • 7.2.1.3.2. Address
    • 7.2.2. Functions
    • 7.2.3. On script error
    • 7.2.4. On implicit termination
  • 7.3. HELO
    • 7.3.1. Variables
      • 7.3.1.1. Arguments
      • 7.3.1.2. Connection
        • 7.3.1.2.1. TLS
          • 7.3.1.2.1.1. Peercert
        • 7.3.1.2.2. AUTH
      • 7.3.1.3. Transaction
    • 7.3.2. Functions
    • 7.3.3. On script error
    • 7.3.4. On implicit termination
  • 7.4. AUTH
    • 7.4.1. Variables
      • 7.4.1.1. Arguments
      • 7.4.1.2. Connection
        • 7.4.1.2.1. HELO
        • 7.4.1.2.2. TLS
          • 7.4.1.2.2.1. Peercert
      • 7.4.1.3. Transaction
    • 7.4.2. Functions
    • 7.4.3. On script error
    • 7.4.4. On implicit termination
    • 7.4.5. Authentication diagram
  • 7.5. MAIL FROM
    • 7.5.1. Variables
      • 7.5.1.1. Arguments
      • 7.5.1.2. Connection
        • 7.5.1.2.1. HELO
        • 7.5.1.2.2. TLS
          • 7.5.1.2.2.1. Peercert
        • 7.5.1.2.3. AUTH
      • 7.5.1.3. Transaction
        • 7.5.1.3.1. Address
    • 7.5.2. Functions
    • 7.5.3. On script error
    • 7.5.4. On implicit termination
  • 7.6. RCPT TO
    • 7.6.1. Variables
      • 7.6.1.1. Arguments
      • 7.6.1.2. Connection
        • 7.6.1.2.1. HELO
        • 7.6.1.2.2. TLS
          • 7.6.1.2.2.1. Peercert
        • 7.6.1.2.3. AUTH
      • 7.6.1.3. Transaction
        • 7.6.1.3.1. Recipient
        • 7.6.1.3.2. Address
    • 7.6.2. Functions
    • 7.6.3. On script error
    • 7.6.4. On implicit termination
  • 7.7. End-of-DATA
    • 7.7.1. Variables
      • 7.7.1.1. Arguments
      • 7.7.1.2. Connection
        • 7.7.1.2.1. HELO
        • 7.7.1.2.2. TLS
          • 7.7.1.2.2.1. Peercert
        • 7.7.1.2.3. AUTH
      • 7.7.1.3. Transaction
        • 7.7.1.3.1. Recipient
        • 7.7.1.3.2. Address
        • 7.7.1.3.3. http
    • 7.7.2. Functions
      • 7.7.2.1. Actions
      • 7.7.2.2. DATA, MIME and attachments
    • 7.7.3. On script error
    • 7.7.4. On implicit termination
  • 7.8. Disconnect
    • 7.8.1. Variables
      • 7.8.1.1. Arguments
        • 7.8.1.1.1. Error
        • 7.8.1.1.2. Reply
      • 7.8.1.2. Connection
        • 7.8.1.2.1. HELO
        • 7.8.1.2.2. TLS
          • 7.8.1.2.2.1. Peercert
        • 7.8.1.2.3. AUTH
    • 7.8.2. Functions
    • 7.8.3. On script error
    • 7.8.4. On implicit termination
• 8. SMTP queue
  • 8.1. Pre-delivery
    • 8.1.1. Variables
      • 8.1.1.1. Arguments
        • 8.1.1.1.1. Queue
          • 8.1.1.1.1.1. Plugin
      • 8.1.1.2. Message
        • 8.1.1.2.1. Id
        • 8.1.1.2.2. Address
        • 8.1.1.2.3. File
        • 8.1.1.2.4. DSN
    • 8.1.2. Functions
    • 8.1.3. On script error
    • 8.1.4. On implicit termination
  • 8.2. Post-delivery
    • 8.2.1. Variables
      • 8.2.1.1. Arguments
        • 8.2.1.1.1. Policy
          • 8.2.1.1.1.1. Policies
        • 8.2.1.1.2. Attempt
          • 8.2.1.1.2.1. Result
          • 8.2.1.1.2.2. Error
          • 8.2.1.1.2.3. Connection
            • 8.2.1.1.2.3.1. TLS
              • 8.2.1.1.2.3.1.1. Peercert
              • 8.2.1.1.2.3.1.2. TLSA
                • 8.2.1.1.2.3.1.2.1. Records
          • 8.2.1.1.2.4. Plugin
        • 8.2.1.1.3. DSN
        • 8.2.1.1.4. Queue
          • 8.2.1.1.4.1. Plugin
      • 8.2.1.2. Message
        • 8.2.1.2.1. Id
        • 8.2.1.2.2. Address
        • 8.2.1.2.3. File
        • 8.2.1.2.4. DSN
    • 8.2.2. Functions
    • 8.2.3. On script error
    • 8.2.4. On implicit termination
    • 8.2.5. References
      • 8.2.5.1. SMTP states
• 9. Integrations

Indices and tables

• Index

• Search Page