Halon Scripting Language
1. About
2. Introduction
3. Data types and literals
4. Operators
5. Control structures
6. Standard library
7. SMTP server
8. SMTP queue
9. Integrations
Halon Scripting Language
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
X
|
Y
|
Z
A
abs()
built-in function
Accept() (in module auth)
(in module connect)
(in module eod)
(in module helo)
(in module mailfrom)
(in module rcptto)
aes_decrypt()
built-in function
aes_encrypt()
built-in function
AF() (Socket static method)
allocate() (FFI static method)
array()
built-in function
array_combine()
built-in function
array_every()
built-in function
array_filter()
built-in function
array_find()
built-in function
array_includes()
built-in function
array_join()
built-in function
array_keys()
built-in function
array_map()
built-in function
array_random()
built-in function
array_range()
built-in function
array_reduce()
built-in function
array_reverse()
built-in function
array_shuffle()
built-in function
array_sort()
built-in function
array_unique()
built-in function
attach() (FFI static method)
auth
module
B
base32_decode()
built-in function
base32_encode()
built-in function
base64_decode()
built-in function
base64_encode()
built-in function
base64url_decode()
built-in function
base64url_encode()
built-in function
boolean()
built-in function
Bounce() (in module postdelivery)
(in module predelivery)
built-in function
abs()
aes_decrypt()
aes_encrypt()
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_shuffle()
array_sort()
array_unique()
base32_decode()
base32_encode()
base64_decode()
base64_encode()
base64url_decode()
base64url_encode()
boolean()
ceil()
chr()
cms_decrypt()
cms_encrypt()
cms_recipients()
cms_sign()
cms_type()
cms_verify()
crypt()
csv_decode()
csv_encode()
dns_query()
domain_includes()
domain_publicsuffix()
ec_privatekey()
echo()
ed25519_privatekey()
ed25519_sign()
ed25519_verify()
envelope_address_parse()
envelope_localpart_escape()
Exception.column()
Exception.constructor()
Exception.file()
Exception.line()
Exception.message()
Exception.toString()
executiontime()
FFI.constructor()
FFI.func()
FFI.symbol()
FFIFunction()
File.close()
File.constructor()
File.getPath()
File.read()
File.readline()
File.seek()
File.tell()
File.toFFIValue()
floor()
gethostname()
hash()
header_addresslist_compile()
header_addresslist_extract()
header_dkim_decode()
hmac_md5()
hmac_sha1()
hmac_sha2()
http()
Iconv.close()
Iconv.constructor()
Iconv.convert()
Iconv.errno()
idna_decode()
idna_encode()
inet_includes()
inet_ntop()
inet_pton()
inet_reverse()
is_array()
is_boolean()
is_ec_privatekey()
is_ed25519_privatekey()
is_function()
is_number()
is_object()
is_rsa_privatekey()
is_string()
is_x509_resource()
is_x509crl_resource()
isset()
Iterator.next()
json_decode()
json_encode()
length()
log()
MailMessage.modifyContent()
MailMessage.queue()
MailMessage.reset()
MailMessage.restore()
MailMessage.send()
MailMessage.setContext()
MailMessage.signDKIM()
MailMessage.snapshot()
MailMessage.toFile()
MailMessage.toString()
MailMessage.verifyDKIM()
Map.clear()
Map.constructor()
Map.delete()
Map.entries()
Map.get()
Map.has()
Map.merge()
Map.set()
Map.size()
Map.toArray()
md5()
memory_add()
memory_dec()
memory_delete()
memory_exists()
memory_fetch()
memory_inc()
memory_store()
memory_update()
metrics_decrement()
metrics_get()
metrics_increment()
metrics_set()
MIME.addHeader()
MIME.appendPart()
MIME.constructor()
MIME.queue()
MIME.send()
MIME.setBody()
MIME.setBoundary()
MIME.setContext()
MIME.setDate()
MIME.setDisposition()
MIME.setFileName()
MIME.setType()
MIME.signDKIM()
MIME.toFile()
MIME.toString()
MIMEPart.addHeader()
MIMEPart.appendPart()
MIMEPart.delHeader()
MIMEPart.findByFileName()
MIMEPart.findByType()
MIMEPart.getBody()
MIMEPart.getByID()
MIMEPart.getEpilogue()
MIMEPart.getErrors()
MIMEPart.getFileName()
MIMEPart.getHeader()
MIMEPart.getHeaderNames()
MIMEPart.getHeaders()
MIMEPart.getID()
MIMEPart.getParts()
MIMEPart.getPreamble()
MIMEPart.getSize()
MIMEPart.getType()
MIMEPart.getTypeParameter()
MIMEPart.prependPart()
MIMEPart.remove()
MIMEPart.renameHeader()
MIMEPart.replacePart()
MIMEPart.setBody()
MIMEPart.setDateLater()
MIMEPart.setEpilogue()
MIMEPart.setHeader()
MIMEPart.setPreamble()
mimeword_decode()
mimeword_encode()
number()
ord()
pack()
pcre_compile()
pcre_match()
pcre_match_all()
pcre_quote()
pcre_replace()
pkcs11_load()
pkcs7_sign()
pow()
queue_policy()
queue_policy_delete()
queue_quota()
queue_suspend()
random_bytes()
random_number()
round()
rsa_privatekey()
rsa_sign()
rsa_verify()
server_concurrency()
Set.add()
Set.clear()
Set.constructor()
Set.delete()
Set.has()
Set.size()
Set.toArray()
Set.values()
sha1()
sha2()
sleep()
smtp_lookup_auth()
smtp_lookup_rcpt()
Socket.bind()
Socket.close()
Socket.connect()
Socket.constructor()
Socket.errno()
Socket.recv()
Socket.send()
Socket.settimeout()
Socket.shutdown()
Socket.toFFIValue()
spf_query()
sqrt()
str_chunk()
str_find()
str_lower()
str_lstrip()
str_repeat()
str_replace()
str_rfind()
str_rstrip()
str_slice()
str_split()
str_strip()
str_upper()
strftime()
string()
strpduration()
strptime()
syslog()
time()
timelocal()
TLSSocket.constructor()
TLSSocket.errno()
TLSSocket.getpeerx509()
TLSSocket.handshake()
TLSSocket.recv()
TLSSocket.send()
TLSSocket.shutdown()
TLSSocket.toSocket()
unpack()
unset()
uptime()
url_decode()
url_encode()
url_parse()
uuid()
uuidv5()
X509.chain()
X509.constructor()
X509.export()
X509.extensions()
X509.issuer()
X509.not_valid_after()
X509.not_valid_before()
X509.public_key()
X509.serial_number()
X509.subject()
X509.subject_alt_name()
X509.toFFIValue()
X509.toResource()
X509.verify()
X509.version()
X509CRL.constructor()
X509CRL.export()
X509CRL.extensions()
X509CRL.issuer()
X509CRL.last_update()
X509CRL.next_update()
X509CRL.revoked()
X509CRL.toResource()
X509CRL.version()
xtext_decode()
xtext_encode()
yaml_decode()
zlib_compress()
zlib_uncompress()
byref() (FFI static method)
C
callback() (FFI static method)
ceil()
built-in function
chr()
built-in function
cms_decrypt()
built-in function
cms_encrypt()
built-in function
cms_recipients()
built-in function
cms_sign()
built-in function
cms_type()
built-in function
cms_verify()
built-in function
cnumber() (FFI static method)
connect
module
crypt()
built-in function
cstring() (FFI static method)
csv_decode()
built-in function
csv_encode()
built-in function
D
Default() (in module postdelivery)
Defer() (in module auth)
(in module connect)
(in module eod)
(in module helo)
(in module mailfrom)
(in module rcptto)
Delete() (in module postdelivery)
(in module predelivery)
deref() (FFI static method)
detach() (FFI static method)
disconnect
module
dns_query()
built-in function
domain_includes()
built-in function
domain_publicsuffix()
built-in function
E
ec_privatekey()
built-in function
echo()
built-in function
ed25519_privatekey()
built-in function
ed25519_sign()
built-in function
ed25519_verify()
built-in function
envelope_address_parse()
built-in function
envelope_localpart_escape()
built-in function
eod
module
EODMailMessage (C++ class)
EODMailMessage.queue() (in module eod)
Exception (C++ class)
Exception.column()
built-in function
Exception.constructor()
built-in function
Exception.file()
built-in function
Exception.line()
built-in function
Exception.message()
built-in function
Exception.toString()
built-in function
executiontime()
built-in function
F
FFI (built-in class)
FFI.constructor()
built-in function
FFI.func()
built-in function
FFI.symbol()
built-in function
FFIFunction()
built-in function
FFIType (built-in variable)
FFIValue (built-in variable)
File (built-in class)
File() (MailMessage static method)
File.close()
built-in function
File.constructor()
built-in function
File.getPath()
built-in function
File.read()
built-in function
File.readline()
built-in function
File.seek()
built-in function
File.tell()
built-in function
File.toFFIValue()
built-in function
floor()
built-in function
G
gethostname()
built-in function
GetMetaData() (in module postdelivery)
(in module predelivery)
H
hash()
built-in function
header_addresslist_compile()
built-in function
header_addresslist_extract()
built-in function
header_dkim_decode()
built-in function
helo
module
hmac_md5()
built-in function
hmac_sha1()
built-in function
hmac_sha2()
built-in function
http()
built-in function
I
Iconv (built-in class)
Iconv.close()
built-in function
Iconv.constructor()
built-in function
Iconv.convert()
built-in function
Iconv.errno()
built-in function
idna_decode()
built-in function
idna_encode()
built-in function
inet_includes()
built-in function
inet_ntop()
built-in function
inet_pton()
built-in function
inet_reverse()
built-in function
Integrations
module
integrations.arc
module
integrations.arf
module
integrations.argon2
module
integrations.authentication-results
module
integrations.avro
module
integrations.backoff
module
integrations.backoff-ng
module
integrations.batv
module
integrations.bimi
module
integrations.bounce-classifier
module
integrations.bounce-list
module
integrations.cassandra
module
integrations.clamav
module
integrations.cloudmark
module
integrations.couchbase
module
integrations.cyren
module
integrations.des
module
integrations.dkim2
module
integrations.dlp
module
integrations.dmarc
module
integrations.dovecot
module
integrations.dsn
module
integrations.eleven
module
integrations.emailconsul
module
integrations.env
module
integrations.f-secure
module
integrations.file-deliver
module
integrations.file-pickup
module
integrations.go-grpc-hello-world
module
integrations.grpc-deliver
module
integrations.handlebars
module
integrations.history-elastic
module
integrations.http-background
module
integrations.http-bulk
module
integrations.http-deliver
module
integrations.ident
module
integrations.influxdb
module
integrations.interfaces
module
integrations.ip-list
module
integrations.jlog
module
integrations.kafka
module
integrations.kaspersky
module
integrations.language-detection
module
integrations.ldap
module
integrations.levenshtein
module
integrations.logger
module
integrations.mariadb
module
integrations.maxmind-geoip
module
integrations.memcached
module
integrations.milter
module
integrations.minger
module
integrations.mongodb
module
integrations.msal
module
integrations.msui-client
module
integrations.mta-sts
module
integrations.pdf
module
integrations.pgp
module
integrations.pgp-mime
module
integrations.policyd-client
module
integrations.postgresql
module
integrations.postmastery
module
integrations.proxytlv
module
integrations.pubsub
module
integrations.queue-relinquish
module
integrations.rabbitmq
module
integrations.rabbitmq-consumer
module
integrations.radius
module
integrations.rate
module
integrations.rate-couchbase
module
integrations.rate-redis
module
integrations.redis
module
integrations.rspamd
module
integrations.rust-example
module
integrations.s3
module
integrations.sink
module
integrations.smime
module
integrations.smtp
module
integrations.sophos
module
integrations.spamassassin
module
integrations.sqlite
module
integrations.srs
module
integrations.static-policydivide
module
integrations.stdout
module
integrations.suppression-list
module
integrations.suspend-start
module
integrations.suspend-time
module
integrations.syslog
module
integrations.time-rfc2822
module
integrations.tls-rpt
module
integrations.totp
module
integrations.tracking
module
integrations.twilio
module
integrations.ulid
module
integrations.vade
module
integrations.varist
module
integrations.warmup
module
integrations.wforce
module
integrations.zip
module
is_array()
built-in function
is_boolean()
built-in function
is_ec_privatekey()
built-in function
is_ed25519_privatekey()
built-in function
is_function()
built-in function
is_number()
built-in function
is_object()
built-in function
is_rsa_privatekey()
built-in function
is_string()
built-in function
is_x509_resource()
built-in function
is_x509crl_resource()
built-in function
isset()
built-in function
Iterator (built-in class)
Iterator.next()
built-in function
J
json_decode()
built-in function
json_encode()
built-in function
L
length()
built-in function
log()
built-in function
M
mailfrom
module
MailMessage (C++ class)
MailMessage.modifyContent()
built-in function
MailMessage.queue()
built-in function
MailMessage.reset()
built-in function
MailMessage.restore()
built-in function
MailMessage.send()
built-in function
MailMessage.setContext()
built-in function
MailMessage.signDKIM()
built-in function
MailMessage.snapshot()
built-in function
MailMessage.toFile()
built-in function
MailMessage.toString()
built-in function
MailMessage.verifyDKIM()
built-in function
Map (built-in class)
Map.clear()
built-in function
Map.constructor()
built-in function
Map.delete()
built-in function
Map.entries()
built-in function
Map.get()
built-in function
Map.has()
built-in function
Map.merge()
built-in function
Map.set()
built-in function
Map.size()
built-in function
Map.toArray()
built-in function
md5()
built-in function
memcpy() (FFI static method)
memory_add()
built-in function
memory_dec()
built-in function
memory_delete()
built-in function
memory_exists()
built-in function
memory_fetch()
built-in function
memory_inc()
built-in function
memory_store()
built-in function
memory_update()
built-in function
metrics_decrement()
built-in function
metrics_get()
built-in function
metrics_increment()
built-in function
metrics_set()
built-in function
MIME (built-in class)
MIME.addHeader()
built-in function
MIME.appendPart()
built-in function
MIME.constructor()
built-in function
MIME.queue()
built-in function
MIME.send()
built-in function
MIME.setBody()
built-in function
MIME.setBoundary()
built-in function
MIME.setContext()
built-in function
MIME.setDate()
built-in function
MIME.setDisposition()
built-in function
MIME.setFileName()
built-in function
MIME.setType()
built-in function
MIME.signDKIM()
built-in function
MIME.toFile()
built-in function
MIME.toString()
built-in function
MIMEPart (C++ class)
MIMEPart.addHeader()
built-in function
MIMEPart.appendPart()
built-in function
MIMEPart.delHeader()
built-in function
MIMEPart.findByFileName()
built-in function
MIMEPart.findByType()
built-in function
MIMEPart.getBody()
built-in function
MIMEPart.getByID()
built-in function
MIMEPart.getEpilogue()
built-in function
MIMEPart.getErrors()
built-in function
MIMEPart.getFileName()
built-in function
MIMEPart.getHeader()
built-in function
MIMEPart.getHeaderNames()
built-in function
MIMEPart.getHeaders()
built-in function
MIMEPart.getID()
built-in function
MIMEPart.getParts()
built-in function
MIMEPart.getPreamble()
built-in function
MIMEPart.getSize()
built-in function
MIMEPart.getType()
built-in function
MIMEPart.getTypeParameter()
built-in function
MIMEPart.prependPart()
built-in function
MIMEPart.remove()
built-in function
MIMEPart.renameHeader()
built-in function
MIMEPart.replacePart()
built-in function
MIMEPart.setBody()
built-in function
MIMEPart.setDateLater()
built-in function
MIMEPart.setEpilogue()
built-in function
MIMEPart.setHeader()
built-in function
MIMEPart.setPreamble()
built-in function
mimeword_decode()
built-in function
mimeword_encode()
built-in function
module
auth
connect
disconnect
eod
helo
Integrations
integrations.arc
integrations.arf
integrations.argon2
integrations.authentication-results
integrations.avro
integrations.backoff
integrations.backoff-ng
integrations.batv
integrations.bimi
integrations.bounce-classifier
integrations.bounce-list
integrations.cassandra
integrations.clamav
integrations.cloudmark
integrations.couchbase
integrations.cyren
integrations.des
integrations.dkim2
integrations.dlp
integrations.dmarc
integrations.dovecot
integrations.dsn
integrations.eleven
integrations.emailconsul
integrations.env
integrations.f-secure
integrations.file-deliver
integrations.file-pickup
integrations.go-grpc-hello-world
integrations.grpc-deliver
integrations.handlebars
integrations.history-elastic
integrations.http-background
integrations.http-bulk
integrations.http-deliver
integrations.ident
integrations.influxdb
integrations.interfaces
integrations.ip-list
integrations.jlog
integrations.kafka
integrations.kaspersky
integrations.language-detection
integrations.ldap
integrations.levenshtein
integrations.logger
integrations.mariadb
integrations.maxmind-geoip
integrations.memcached
integrations.milter
integrations.minger
integrations.mongodb
integrations.msal
integrations.msui-client
integrations.mta-sts
integrations.pdf
integrations.pgp
integrations.pgp-mime
integrations.policyd-client
integrations.postgresql
integrations.postmastery
integrations.proxytlv
integrations.pubsub
integrations.queue-relinquish
integrations.rabbitmq
integrations.rabbitmq-consumer
integrations.radius
integrations.rate
integrations.rate-couchbase
integrations.rate-redis
integrations.redis
integrations.rspamd
integrations.rust-example
integrations.s3
integrations.sink
integrations.smime
integrations.smtp
integrations.sophos
integrations.spamassassin
integrations.sqlite
integrations.srs
integrations.static-policydivide
integrations.stdout
integrations.suppression-list
integrations.suspend-start
integrations.suspend-time
integrations.syslog
integrations.time-rfc2822
integrations.tls-rpt
integrations.totp
integrations.tracking
integrations.twilio
integrations.ulid
integrations.vade
integrations.varist
integrations.warmup
integrations.wforce
integrations.zip
mailfrom
postdelivery
predelivery
proxy
rcptto
N
Next() (in module proxy)
nullptr() (FFI static method)
number()
built-in function
number() (FFI static method)
number64() (FFI static method)
O
offset() (FFI static method)
ord()
built-in function
P
pack()
built-in function
Pass() (in module disconnect)
(in module proxy)
pcre_compile()
built-in function
pcre_match()
built-in function
pcre_match_all()
built-in function
pcre_quote()
built-in function
pcre_replace()
built-in function
pkcs11_load()
built-in function
pkcs7_sign()
built-in function
postdelivery
module
pow()
built-in function
predelivery
module
proxy
module
Q
Queue() (in module postdelivery)
(in module predelivery)
queue_policy()
built-in function
queue_policy_delete()
built-in function
queue_quota()
built-in function
queue_suspend()
built-in function
R
random_bytes()
built-in function
random_number()
built-in function
rcptto
module
Reject() (in module auth)
(in module connect)
(in module eod)
(in module helo)
(in module mailfrom)
(in module rcptto)
Reply() (in module auth)
(in module proxy)
Resource() (Socket static method)
round()
built-in function
rsa_privatekey()
built-in function
rsa_sign()
built-in function
rsa_verify()
built-in function
S
server_concurrency()
built-in function
Set (built-in class)
Set.add()
built-in function
Set.clear()
built-in function
Set.constructor()
built-in function
Set.delete()
built-in function
Set.has()
built-in function
Set.size()
built-in function
Set.toArray()
built-in function
Set.values()
built-in function
SetMetaData() (in module postdelivery)
(in module predelivery)
sha1()
built-in function
sha2()
built-in function
sleep()
built-in function
smtp_lookup_auth()
built-in function
smtp_lookup_rcpt()
built-in function
Socket (built-in class)
Socket.bind()
built-in function
Socket.close()
built-in function
Socket.connect()
built-in function
Socket.constructor()
built-in function
Socket.errno()
built-in function
Socket.recv()
built-in function
Socket.send()
built-in function
Socket.settimeout()
built-in function
Socket.shutdown()
built-in function
Socket.toFFIValue()
built-in function
spf_query()
built-in function
sqrt()
built-in function
str_chunk()
built-in function
str_find()
built-in function
str_lower()
built-in function
str_lstrip()
built-in function
str_repeat()
built-in function
str_replace()
built-in function
str_rfind()
built-in function
str_rstrip()
built-in function
str_slice()
built-in function
str_split()
built-in function
str_strip()
built-in function
str_upper()
built-in function
strftime()
built-in function
string()
built-in function
string() (FFI static method)
String() (File static method)
(MailMessage static method)
(X509 static method)
(X509CRL static method)
strpduration()
built-in function
strptime()
built-in function
syslog()
built-in function
T
time()
built-in function
timelocal()
built-in function
TLSSocket (built-in class)
TLSSocket.constructor()
built-in function
TLSSocket.errno()
built-in function
TLSSocket.getpeerx509()
built-in function
TLSSocket.handshake()
built-in function
TLSSocket.recv()
built-in function
TLSSocket.send()
built-in function
TLSSocket.shutdown()
built-in function
TLSSocket.toSocket()
built-in function
Try() (in module predelivery)
type() (FFI static method)
U
unpack()
built-in function
unset()
built-in function
uptime()
built-in function
url_decode()
built-in function
url_encode()
built-in function
url_parse()
built-in function
uuid()
built-in function
uuidv5()
built-in function
X
X509 (built-in class)
X509.chain()
built-in function
X509.constructor()
built-in function
X509.export()
built-in function
X509.extensions()
built-in function
X509.issuer()
built-in function
X509.not_valid_after()
built-in function
X509.not_valid_before()
built-in function
X509.public_key()
built-in function
X509.serial_number()
built-in function
X509.subject()
built-in function
X509.subject_alt_name()
built-in function
X509.toFFIValue()
built-in function
X509.toResource()
built-in function
X509.verify()
built-in function
X509.version()
built-in function
X509CRL (built-in class)
X509CRL.constructor()
built-in function
X509CRL.export()
built-in function
X509CRL.extensions()
built-in function
X509CRL.issuer()
built-in function
X509CRL.last_update()
built-in function
X509CRL.next_update()
built-in function
X509CRL.revoked()
built-in function
X509CRL.toResource()
built-in function
X509CRL.version()
built-in function
xtext_decode()
built-in function
xtext_encode()
built-in function
Y
yaml_decode()
built-in function
Z
zlib_compress()
built-in function
zlib_uncompress()
built-in function