[Index]
Model ref.: device/exchangeonline/HostedContentFilterPolicy
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"IsValid": {
"__type_requested": "System.Boolean",
"required": false,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"TestModeAction": {
"__type_requested": "System.String",
"required": false,
"description": "The TestModeAction parameter specifies the additional action to take on messages that match any of the IncreaseScoreWith or MarkAsSpam parameters that are set to the value Test. Valid values for this parameter are:\nNone\nAddXHeader: The X-header value X-CustomSpam: This message was filtered by the custom spam filter option is added to the message.\nBccMessage: Redirect the message to the recipients specified by the TestModeBccToRecipients parameter.\nThe default value is None.",
"title": "TestModeAction",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "TestModeAction"
},
"Group": {
"__type_requested": "String",
"required": false,
"description": "PARAMVALUE: String",
"title": "Group",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Group"
},
"ModifySubjectValue": {
"__type_requested": "String",
"required": false,
"description": "The ModifySubjectValue parameter specifies the text to prepend to the existing subject of spam messages when an action parameter is set to the value ModifySubject. The action parameters that use the value of ModifySubjectValue are HighConfidenceSpamAction and SpamAction.\nThe value you specify must contain less than 256 characters If the value contains spaces, enclose the value in quotation marks (\").",
"title": "ModifySubjectValue",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ModifySubjectValue"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": false,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RegionBlockList": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The RegionBlockList parameter specifies the region to block when messages are blocked based on their source region. Valid input for this parameter is a supported ISO 3166-1 uppercase two-letter country code. You can specify multiple values separated by commas. This parameter is only used when the EnableRegionBlockList parameter is set to $true.\nA reference for two-letter country codes is available at the International Organization for Standardization (ISO) website: ISO 3166-1 decoding table (http://www.iso.org/iso/country_codes/iso-3166-1_decoding_table.htm). Note that not all possible country codes are available as input for this parameter.",
"title": "RegionBlockList",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "RegionBlockList"
},
"MarkAsSpamBulkMail": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamBulkMail parameter classifies the message as spam when the message is identified as a bulk email message. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamBulkMail",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamBulkMail"
},
"MarkAsSpamWebBugsInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamWebBugsInHtml parameter classifies the message as spam when the message contains web bugs. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamWebBugsInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamWebBugsInHtml"
},
"IncreaseScoreWithNumericIps": {
"__type_requested": "System.String",
"required": false,
"description": "The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "IncreaseScoreWithNumericIps",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IncreaseScoreWithNumericIps"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"BlockedSenderDomains": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP domains.\nTo enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<value1>\",\"<value2>\",...\"<valueX>\".",
"title": "BlockedSenderDomains",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "BlockedSenderDomains"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"FalsePositiveAdditionalRecipients": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.SmtpAddress,",
"required": false,
"name": "FalsePositiveAdditionalRecipients",
"title": "FalsePositiveAdditionalRecipients",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"BulkSpamAction": {
"__type_requested": "System.String",
"required": false,
"description": "PARAMVALUE: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction",
"title": "BulkSpamAction",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "BulkSpamAction"
},
"MarkAsSpamEmbedTagsInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamEmbedTagsInHtml parameter classifies the message as spam when the message contains HTML <embed> tags. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamEmbedTagsInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamEmbedTagsInHtml"
},
"EndUserSpamNotificationLanguage": {
"__type_requested": "System.String",
"required": false,
"description": "The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam notification messages. The default value is Default. This means the default language of end-user spam notification messages is the default language of the cloud-based organization.",
"title": "EndUserSpamNotificationLanguage",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "EndUserSpamNotificationLanguage"
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": false,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"MarkAsSpamJavaScriptInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamJavaScriptInHtml parameter classifies the message as spam when the message contains JavaScript or VBScript. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamJavaScriptInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamJavaScriptInHtml"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowedSenderDomains": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains.\nTo enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<value1>\",\"<value2>\",...\"<valueX>\".",
"title": "AllowedSenderDomains",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "AllowedSenderDomains"
},
"EnableLanguageBlockList": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EnableLanguageBlockList parameter enables or disables blocking email messages that are written in specific languages, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false.\nWhen you enable the language block list, you may specify one or more languages by using the LanguageBlockList parameter.",
"title": "EnableLanguageBlockList",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableLanguageBlockList"
},
"SpamAction": {
"__type_requested": "System.String",
"required": false,
"description": "The SpamAction parameter specifies the action to take on messages that may be spam. Valid values for this parameter are:\nAddXHeader: The value specified by the AddXHeaderValue parameter is added to the message.\nDelete\nModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message.\nMoveToJmf: Move the message to the user's Junk E-mail Folder.\nQuarantine\nRedirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter.\nThe default value is Quarantine.",
"title": "SpamAction",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SpamAction"
},
"EnableRegionBlockList": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EnableRegionBlockList parameter enables or disables blocking email messages that are sent from specific countries or regions, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false.\nWhen you enable the region block list, you may specify one or more regions by using the RegionBlockList parameter.",
"title": "EnableRegionBlockList",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableRegionBlockList"
},
"IncreaseScoreWithImageLinks": {
"__type_requested": "System.String",
"required": false,
"description": "The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "IncreaseScoreWithImageLinks",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IncreaseScoreWithImageLinks"
},
"BulkThreshold": {
"__type_requested": "Int32",
"required": false,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "BulkThreshold",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "BulkThreshold"
},
"EndUserSpamNotificationFrequency": {
"__type_requested": "Int32",
"required": false,
"description": "The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam notification messages are sent. Valid input for this parameter is an integer between 1 and 15. The default value is 3.",
"title": "EndUserSpamNotificationFrequency",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "EndUserSpamNotificationFrequency"
},
"LanguageBlockList": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The LanguageBlockList parameter specifies the languages to block when messages are blocked based on their language. Valid input for this parameter is a supported ISO 639-1 lowercase two-letter language code. You can specify multiple values separated by commas. This parameter is only use when the EnableRegionBlockList parameter is set to $true.\nA reference for two-letter language codes is available at the Library of Congress website: ISO 639-2 Code (http://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter.",
"title": "LanguageBlockList",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "LanguageBlockList"
},
"ZapEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "PARAMVALUE: $true | $false",
"title": "ZapEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ZapEnabled"
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": false,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"MarkAsSpamSensitiveWordList": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamSensitiveWordList parameter classifies the message as spam when the message contains words from the sensitive words list. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamSensitiveWordList",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamSensitiveWordList"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": false,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"Name": {
"__type_requested": "String",
"required": true,
"description": "The Name parameter specifies a unique name for the content filter policy.",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Name"
},
"MarkAsSpamObjectTagsInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamObjectTagsInHtml parameter classifies the message as spam when the message contains HTML <object> tags. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamObjectTagsInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamObjectTagsInHtml"
},
"InlineSafetyTipsEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "PARAMVALUE: $true | $false",
"title": "InlineSafetyTipsEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "InlineSafetyTipsEnabled"
},
"IncreaseScoreWithBizOrInfoUrls": {
"__type_requested": "System.String",
"required": false,
"description": "The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "IncreaseScoreWithBizOrInfoUrls",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IncreaseScoreWithBizOrInfoUrls"
},
"MarkAsSpamFormTagsInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamFormTagsInHtml parameter classifies the message as spam when the message contains HTML <form> tags. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamFormTagsInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamFormTagsInHtml"
},
"MarkAsSpamSpfRecordHardFail": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamFromAddressAuthFail parameter classifies the message as spam when Sender Policy Framework (SPF) record checking encounters a hard fail. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamSpfRecordHardFail",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamSpfRecordHardFail"
},
"EndUserSpamNotificationCustomFromAddress": {
"__type_requested": "System.String",
"required": false,
"description": "The EndUserSpamNotificationCustomFromAddress parameter specifies a custom From address for end-user spam notification messages. Valid input for this parameter is an SMTP email address.",
"title": "EndUserSpamNotificationCustomFromAddress",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "EndUserSpamNotificationCustomFromAddress"
},
"AddXHeaderValue": {
"__type_requested": "String",
"required": false,
"description": "The AddXHeaderValue parameter specifies the X-header value to add to spam messages when an action parameter is set to the value AddXHeader. The action parameters that use the value of AddXHeaderValue are HighConfidenceSpamAction, and SpamAction. Note that when the TestModeAction parameter is set to AddXHeader, the X-header value X-CustomSpam: This message was filtered by the custom spam filter option is added to the message.\nAn X-header is a user-defined, unofficial header field that exists in the message header. X-headers aren't specifically mentioned in RFC 2822, but the use of an undefined header field starting with X- has become an accepted way to add unofficial header fields to a message. The value you specify must contain less than 256 characters, and it can't contain spaces.",
"title": "AddXHeaderValue",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "AddXHeaderValue"
},
"IncreaseScoreWithRedirectToOtherPort": {
"__type_requested": "System.String",
"required": false,
"description": "The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to other TCP ports. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "IncreaseScoreWithRedirectToOtherPort",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IncreaseScoreWithRedirectToOtherPort"
},
"MarkAsSpamFromAddressAuthFail": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamFromAddressAuthFail parameter classifies the message as spam when Sender ID filtering encounters a hard fail. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamFromAddressAuthFail",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamFromAddressAuthFail"
},
"PhishSpamAction": {
"__type_requested": "System.String",
"required": false,
"description": "PARAMVALUE: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction",
"title": "PhishSpamAction",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "PhishSpamAction"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": false,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"BlockedSenders": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP email addresses.\nTo enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<value1>\",\"<value2>\",...\"<valueX>\".",
"title": "BlockedSenders",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "BlockedSenders"
},
"IsDefault": {
"__type_requested": "System.Boolean",
"required": false,
"name": "IsDefault",
"title": "IsDefault",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"MarkAsSpamEmptyMessages": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamEmptyMessages parameter classifies the message as spam when the message is empty. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamEmptyMessages",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamEmptyMessages"
},
"RedirectToRecipients": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The RedirectToRecipients parameter specifies the replacement recipients in spam messages when an action parameter is set to the value Redirect. The action parameters that use the value of RedirectToRecipients are HighConfidenceSpamAction and SpamAction.\nValid input for this parameter is an email address. Separate multiple email addresses with commas.",
"title": "RedirectToRecipients",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "RedirectToRecipients"
},
"AllowedSenders": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The AllowedSenders parameter specifies a list of trusted senders that aren't processed by the spam filter. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses.\nTo enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<value1>\",\"<value2>\",...\"<valueX>\".",
"title": "AllowedSenders",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "AllowedSenders"
},
"HighConfidenceSpamAction": {
"__type_requested": "System.String",
"required": false,
"description": "The HighConfidenceSpamAction parameter specifies the action to take when a message is very likely to be spam. Valid values for this parameter are:\nAddXHeader: The value specified by the AddXHeaderValue parameter is added to the message.\nDelete\nModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message.\nMoveToJmf: Move the message to the user's Junk E-mail Folder.\nQuarantine: Move the message to the quarantine.\nRedirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter.\nThe default value is Quarantine.",
"title": "HighConfidenceSpamAction",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "HighConfidenceSpamAction"
},
"EndUserSpamNotificationCustomSubject": {
"__type_requested": "String",
"required": false,
"description": "The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks (\").",
"title": "EndUserSpamNotificationCustomSubject",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "EndUserSpamNotificationCustomSubject"
},
"EnableEndUserSpamNotifications": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notification messages. Valid input for this parameter is $true or $false. The default value is $false.\nEnd-user spam notification messages periodically alert users when they have messages in the quarantine. When you enable end-user spam notifications, you may also specify values for the EndUserSpamNotificationCustomFromAddress, EndUserSpamNotificationCustomFromName, and EndUserSpamNotificationCustomSubject parameters.",
"title": "EnableEndUserSpamNotifications",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableEndUserSpamNotifications"
},
"EndUserSpamNotificationCustomFromName": {
"__type_requested": "String",
"required": false,
"description": "The EndUserSpamNotificationCustomFromName parameter specifies a custom display name in the From field for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks (\").",
"title": "EndUserSpamNotificationCustomFromName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "EndUserSpamNotificationCustomFromName"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"DownloadLink": {
"__type_requested": "$true | $false",
"required": false,
"description": "The DownloadLink parameter shows or hides a link in end-user spam notification messages to download the Junk E-mail Reporting Tool plugin for Microsoft Outlook. Valid input for this parameter is $true or $false. The default value is $false.\nThis parameter is only useful if the EnableEndUserSpamNotifications parameter is set to $true.",
"title": "DownloadLink",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DownloadLink"
},
"EndUserSpamNotificationLimit": {
"__type_requested": "Int32",
"required": false,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "EndUserSpamNotificationLimit",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "EndUserSpamNotificationLimit"
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"MatchSubDomains": {
"__type_requested": "SwitchParameter",
"required": false,
"description": "PARAMVALUE: SwitchParameter",
"title": "MatchSubDomains",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "MatchSubDomains"
},
"MarkAsSpamFramesInHtml": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamFramesInHtml parameter classifies the message as spam when the message contains HTML <frame> or <iframe> tags. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamFramesInHtml",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamFramesInHtml"
},
"ObjectState": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Identity": {
"__type_requested": "System.String",
"required": false,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": true,
"type": "string",
"description": "The Identity parameter specifies the content filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the content filter policy."
},
"AdminDisplayName": {
"__type_requested": "String",
"required": false,
"description": "The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks (\").",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "AdminDisplayName"
},
"MarkAsSpamNdrBackscatter": {
"__type_requested": "System.String",
"required": false,
"description": "The MarkAsSpamNdrBackscatter parameter classifies the message as spam when the message is a non-delivery report (NDR) to a forged sender. Valid values for this parameter are Off, On or Test. The default value is Off.",
"title": "MarkAsSpamNdrBackscatter",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MarkAsSpamNdrBackscatter"
},
"QuarantineRetentionPeriod": {
"__type_requested": "Int32",
"required": false,
"description": "The QuarantineRetentionPeriod parameter specifies the length of time in days that spam messages remain in the quarantine. Valid input for this parameter is an integer between 1 and 15. The default value is 15.",
"title": "QuarantineRetentionPeriod",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "QuarantineRetentionPeriod"
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Guid": {
"__type_requested": "System.Guid",
"required": false,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Id": {
"__type_requested": "System.String",
"required": false,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"TestModeBccToRecipients": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The TestModeBccToRecipients parameter specifies the blind carbon copy recipients to add to spam messages when the TestModeAction action parameter is set to the value BccMessage.\nValid input for this parameter is an email address. Separate multiple email addresses with commas.",
"title": "TestModeBccToRecipients",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "TestModeBccToRecipients"
}
},
"schema_version": "2017.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/exchangeonline/HostedContentFilterPolicy/add/ |
|
The GUI Add form of device/exchangeonline/HostedContentFilterPolicy as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/exchangeonline/HostedContentFilterPolicy | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangeonline/HostedContentFilterPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/HostedContentFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedContentFilterPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangeonline/HostedContentFilterPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangeonline/HostedContentFilterPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/HostedContentFilterPolicy/[pkid1]", "/api/v0/device/exchangeonline/HostedContentFilterPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/HostedContentFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/HostedContentFilterPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/HostedContentFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/HostedContentFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedContentFilterPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/HostedContentFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/HostedContentFilterPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/HostedContentFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedContentFilterPolicy/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangeonline/HostedContentFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/HostedContentFilterPolicy.
GET http://[host-proxy]/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/HostedContentFilterPolicy | POST | /api/device/exchangeonline/HostedContentFilterPolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/exchangeonline/HostedContentFilterPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangeonline/HostedContentFilterPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangeonline/HostedContentFilterPolicy/ |
|
The device/exchangeonline/HostedContentFilterPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/HostedContentFilterPolicy instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangeonline/HostedContentFilterPolicy/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2017.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/HostedContentFilterPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangeonline/HostedContentFilterPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangeonline/HostedContentFilterPolicy",
"model_specific_actions": [
"get",
"list",
"add",
"remove",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangeonline/HostedContentFilterPolicy. | GET | /api/device/exchangeonline/HostedContentFilterPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/HostedContentFilterPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/HostedContentFilterPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/HostedContentFilterPolicy | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangeonline/HostedContentFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangeonline/HostedContentFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/HostedContentFilterPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/HostedContentFilterPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/HostedContentFilterPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/HostedContentFilterPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |