Difference between revisions of "AddUserSpam()"

Latest revision as of 14:52, 25 August 2008

This function will set the threshold of sensitivity for determining whether a message should be considered spam and also sets the action to be taken for messages that meet the threshold. Please note that these settings, if they exist, override settings at the domain level-- user trumpts domain for spam filter level and action.

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 SetUserSpamCleaner())
  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

Six to seven strings

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

Return Values

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

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