Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md
cloudmark.hsl

README.md

ScanCM(options, senderip, senderhelo, sender, recipients, fp)

Scan a message with Cloudmarks Authority server (using HTTP POST). This function should be used with the per_message cache.

Params

  • options array - options array

Returns: score as number, None on error.

The following options are available in the options array.

  • host string - IP-address of the Authority server. required
  • port number - TCP port. The default is 80.
  • timeout number - Timeout in seconds. The default is 5 seconds.
  • max_message_size number - The max message size in bytes. The default is 5 MiB.

ScanIPCM(options, senderip)

Scan an IP with Cloudmarks Authority server (using HTTP POST). This function should be used with the per_message cache.

Params

  • options array - options array
  • senderip string - IP address

Returns: score as number, None on error.

The following options are available in the options array.

  • host string - IP-address or hostname of the Authority server. required
  • port number - TCP port. The default is 80.
  • timeout number - Timeout in seconds. The default is 5 seconds.