GetDomainSpam()

From Rackspace Email & Apps API
Jump to: navigation, search

This function will report the threshold of sensitivity for determining whether a message should be considered spam and also reports the action to be taken for messages that meet the threshold.

Threshold
  high = most common setting; flags more messages as spam
  low = flags less messages as spam
  exclusive = considers all messages as spam unless sender is on a safelist
Action
  ignore = deliver the message normally (not recommended)
  delete = immediately delete the message from the system
  folder = deliver the message to the spam folder (use SetDomainSpamCleaner())
  attach = 
  routeto = redirect the message to another email account (like an admin account)
  subject = add '[SPAM]' to the beginning of the subject line
  header = add custom text to the top of the message
  footer = add custom text to the bottom of the message

Parameters

Five to six strings

   Administrative username (string),
   Administrative password (string),
   Domain name,
   Threshold level (high, low, exclusive),
   Action (ignore, delete, folder, attach, routeto, subject, header, footer),
   Action value (needed for some actions:
     routeto email address, subject text, header text or footer text)

Return Values

If successful, the return value of the function will be 1.

If successful, the threshold string, action string, and potentially the action value string will contain the information associated with the domain name.

Consult the Result Code Table for a list of result codes and their meaning.