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
    • Iterator
      • Iterator.next()
  • 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
    • array_combine()
    • array_every()
    • array_filter()
    • array_find()
    • array_includes()
    • array_join()
    • array_keys()
    • array_map()
    • array_random()
    • array_range()
    • array_reduce()
    • array_reverse()
    • array_sort()
    • array_shuffle()
    • array_unique()
  • 6.2. Cryptographic
    • aes_decrypt()
    • aes_encrypt()
    • hmac_md5()
    • hmac_sha1()
    • hmac_sha2()
    • md5()
    • sha1()
    • sha2()
    • hash()
    • pkcs11_load()
    • rsa_privatekey()
    • is_rsa_privatekey()
    • rsa_sign()
    • rsa_verify()
    • ec_privatekey()
    • is_ec_privatekey()
    • ed25519_privatekey()
    • is_ed25519_privatekey()
    • ed25519_sign()
    • ed25519_verify()
    • pkcs7_sign()
    • cms_sign()
    • cms_verify()
    • cms_encrypt()
    • cms_decrypt()
    • cms_type()
    • cms_recipients()
    • random_bytes()
    • random_number()
    • crypt()
  • 6.3. Data types
    • length()
    • array()
    • boolean()
    • number()
    • string()
    • is_array()
    • is_boolean()
    • is_function()
    • is_number()
    • is_object()
    • is_string()
    • isset()
    • unset()
    • Map
      • Map.constructor()
      • Map.set()
      • Map.has()
      • Map.get()
      • Map.delete()
      • Map.merge()
      • Map.size()
      • Map.clear()
      • Map.toArray()
      • Map.entries()
    • Set
      • Set.constructor()
      • Set.add()
      • Set.has()
      • Set.delete()
      • Set.size()
      • Set.clear()
      • Set.toArray()
      • Set.values()
  • 6.4. Date and time
    • executiontime()
    • sleep()
    • strftime()
    • strptime()
    • strpduration()
    • time()
    • timelocal()
    • uptime()
  • 6.5. DNS
    • dns_query()
    • domain_includes()
    • domain_publicsuffix()
    • idna_encode()
    • idna_decode()
  • 6.6. Encodings and JSON
    • base32_encode()
    • base32_decode()
    • base64_encode()
    • base64_decode()
    • base64url_encode()
    • base64url_decode()
    • zlib_compress()
    • zlib_uncompress()
    • csv_encode()
    • csv_decode()
    • json_encode()
    • json_decode()
    • url_encode()
    • url_decode()
    • mimeword_encode()
    • mimeword_decode()
    • yaml_decode()
    • pack()
    • unpack()
    • Iconv
      • Iconv.constructor()
      • Iconv.close()
      • Iconv.convert()
      • Iconv.errno()
  • 6.7. File and HTTP
    • File
      • File.constructor()
      • File.close()
      • File.read()
      • File.readline()
      • File.seek()
      • File.tell()
      • File.getPath()
      • File.toFFIValue()
      • File.String()
    • http()
    • url_parse()
  • 6.8. Mail
    • envelope_address_parse()
    • envelope_localpart_escape()
    • header_addresslist_compile()
    • header_addresslist_extract()
    • header_dkim_decode()
    • xtext_encode()
    • xtext_decode()
    • spf_query()
  • 6.9. Mathematical
    • abs()
    • ceil()
    • floor()
    • log()
    • pow()
    • round()
    • sqrt()
  • 6.10. MIME
    • MIME
      • MIME.constructor()
      • MIME.addHeader()
      • MIME.appendPart()
      • MIME.setBody()
      • MIME.setType()
      • MIME.setBoundary()
      • MIME.setDate()
      • MIME.setFileName()
      • MIME.setDisposition()
      • MIME.signDKIM()
      • MIME.toString()
      • MIME.toFile()
      • MIME.setContext()
      • MIME.queue()
      • MIME.send()
    • MailMessage
      • MailMessage.reset()
      • MailMessage.snapshot()
      • MailMessage.restore()
      • MailMessage.modifyContent()
      • MailMessage.toFile()
      • MailMessage.toString()
      • MailMessage.signDKIM()
      • MailMessage.verifyDKIM()
      • MailMessage.setContext()
      • MailMessage.send()
      • MailMessage.queue()
      • MailMessage.String()
      • MailMessage.File()
    • MIMEPart
      • MIMEPart.getID()
      • MIMEPart.getSize()
      • MIMEPart.getFileName()
      • MIMEPart.getType()
      • MIMEPart.getTypeParameter()
      • MIMEPart.getHeader()
      • MIMEPart.getHeaders()
      • MIMEPart.getHeaderNames()
      • MIMEPart.setHeader()
      • MIMEPart.addHeader()
      • MIMEPart.delHeader()
      • MIMEPart.renameHeader()
      • MIMEPart.setDateLater()
      • MIMEPart.remove()
      • MIMEPart.getBody()
      • MIMEPart.setBody()
      • MIMEPart.getPreamble()
      • MIMEPart.setPreamble()
      • MIMEPart.getEpilogue()
      • MIMEPart.setEpilogue()
      • MIMEPart.prependPart()
      • MIMEPart.appendPart()
      • MIMEPart.replacePart()
      • MIMEPart.findByType()
      • MIMEPart.findByFileName()
      • MIMEPart.getByID()
      • MIMEPart.getParts()
      • MIMEPart.getErrors()
  • 6.11. Misc
    • gethostname()
    • uuid()
    • uuidv5()
    • echo()
    • syslog()
    • inet_includes()
    • inet_ntop()
    • inet_pton()
    • inet_reverse()
  • 6.12. Protocols
    • smtp_lookup_rcpt()
    • smtp_lookup_auth()
  • 6.13. String
    • chr()
    • ord()
    • str_repeat()
    • str_replace()
    • str_split()
    • str_find()
    • str_rfind()
    • str_lower()
    • str_upper()
    • str_slice()
    • str_strip()
    • str_lstrip()
    • str_rstrip()
    • str_chunk()
  • 6.14. Regular expression
    • pcre_match()
    • pcre_match_all()
    • pcre_quote()
    • pcre_compile()
    • pcre_replace()
  • 6.15. Socket
    • Socket
      • Socket.constructor()
      • Socket.bind()
      • Socket.close()
      • Socket.connect()
      • Socket.errno()
      • Socket.recv()
      • Socket.send()
      • Socket.settimeout()
      • Socket.shutdown()
      • Socket.toFFIValue()
      • Socket.AF()
      • Socket.Resource()
    • TLSSocket
      • TLSSocket.constructor()
      • TLSSocket.handshake()
      • TLSSocket.recv()
      • TLSSocket.send()
      • TLSSocket.shutdown()
      • TLSSocket.errno()
      • TLSSocket.getpeerx509()
      • TLSSocket.toSocket()
    • X509
      • X509.constructor()
      • X509.subject()
      • X509.issuer()
      • X509.subject_alt_name()
      • X509.version()
      • X509.serial_number()
      • X509.not_valid_before()
      • X509.not_valid_after()
      • X509.public_key()
      • X509.verify()
      • X509.chain()
      • X509.export()
      • X509.extensions()
      • X509.toResource()
      • X509.toFFIValue()
      • X509.String()
    • is_x509_resource()
    • X509CRL
      • X509CRL.constructor()
      • X509CRL.issuer()
      • X509CRL.revoked()
      • X509CRL.version()
      • X509CRL.last_update()
      • X509CRL.next_update()
      • X509CRL.export()
      • X509CRL.extensions()
      • X509CRL.toResource()
      • X509CRL.String()
    • is_x509crl_resource()
  • 6.16. FFI
    • FFI
      • FFI.constructor()
      • FFI.func()
      • FFI.symbol()
      • FFI.type()
      • FFI.cnumber()
      • FFI.cstring()
      • FFI.callback()
      • FFI.nullptr()
      • FFI.allocate()
      • FFI.memcpy()
      • FFI.byref()
      • FFI.deref()
      • FFI.offset()
      • FFI.string()
      • FFI.number()
      • FFI.number64()
      • FFI.attach()
      • FFI.detach()
    • FFIFunction()
    • FFIType
    • FFIValue
  • 6.17. Shared memory
    • memory_add()
    • memory_dec()
    • memory_delete()
    • memory_exists()
    • memory_fetch()
    • memory_inc()
    • memory_store()
    • memory_update()
  • 6.18. Server
    • server_concurrency()
  • 6.19. Queue
    • queue_suspend()
    • queue_policy()
    • queue_policy_delete()
    • queue_quota()
  • 6.20. Metrics
    • metrics_increment()
    • metrics_decrement()
    • metrics_set()
    • metrics_get()
  • 6.21. Classes
    • Exception
      • Exception.constructor()
      • Exception.toString()
      • Exception.message()
      • Exception.file()
      • Exception.line()
      • Exception.column()
• 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
      • Accept()
      • Reject()
      • Defer()
    • 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
      • Pass()
      • Reply()
      • Next()
    • 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
      • Accept()
      • Reject()
      • Defer()
    • 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
      • Accept()
      • Reject()
      • Defer()
      • Reply()
    • 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
      • Accept()
      • Reject()
      • Defer()
    • 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
      • Accept()
      • Reject()
      • Defer()
    • 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
        • Accept()
        • Reject()
        • Defer()
      • 7.7.2.2. DATA, MIME and attachments
        • EODMailMessage
        • EODMailMessage.queue()
    • 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
      • Pass()
    • 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
      • Try()
      • Queue()
      • Bounce()
      • Delete()
      • SetMetaData()
      • GetMetaData()
    • 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
      • Queue()
      • Bounce()
      • Delete()
      • Default()
      • SetMetaData()
      • GetMetaData()
    • 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