Skip to content

SpamAiVariable

Variables available in expression contexts that reference SpamAiVariable.

VariableDescription
spam_scoreSpam score accumulated so far
spam_thresholdScore at which a message is classified as spam
remote_ipIP address of the client
remote_ip.ptrFirst PTR name of the client IP in lowercase, empty when there is none
helo_domainHost name given in EHLO, or unknown when none was sent
authenticated_asName of the authenticated account, empty when not authenticated
asnAutonomous system number of the client, 0 when unknown
countryCountry code of the client, empty when unknown
is_tlsWhether the message arrived over TLS (boolean)
env_fromEnvelope sender in lowercase, empty for the null sender
env_from.localLocal part of the envelope sender
env_from.domainDomain of the envelope sender
env_toList of the original RCPT TO addresses in lowercase
fromAddress in the From header in lowercase, empty when missing
from.nameDisplay name in the From header in lowercase
from.localLocal part of the From address
from.domainDomain of the From address
reply_toAddress in the Reply-To header, empty when missing
reply_to.nameDisplay name in the Reply-To header
reply_to.localLocal part of the Reply-To address
reply_to.domainDomain of the Reply-To address
toList of addresses in the To header in lowercase
to.nameList of the display names in the To header (recipients without one are left out)
to.localList of the local parts of the To addresses
to.domainList of the domains of the To addresses
ccList of addresses in the Cc header in lowercase
cc.nameList of the display names in the Cc header (recipients without one are left out)
cc.localList of the local parts of the Cc addresses
cc.domainList of the domains of the Cc addresses
bccList of addresses in the Bcc header in lowercase
bcc.nameList of the display names in the Bcc header (recipients without one are left out)
bcc.localList of the local parts of the Bcc addresses
bcc.domainList of the domains of the Bcc addresses
bodyText of the first body part, or the visible text of the HTML body when there is no plain text part
body.textSame as body
body.htmlVisible text of the first HTML body part (not the markup), empty when that part is plain text
body.wordsList of the words and numbers in the first HTML body part, case preserved
body.rawWhole raw message, headers included
subjectSubject in lowercase, trimmed
subject.threadSubject in lowercase with reply and forward prefixes removed
subject.wordsList of the words and numbers in the subject, case preserved
locationWhere the checked element was found, such as env_from, from, subject, body_text or attachment
spam_probabilitySpam probability from the classifier, from 0 to 1, or -1 when there is none (always -1 in DNSBL expressions)