Update emailThreatSubmissionPolicy

Article
08/23/2023

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of an emailThreatSubmissionPolicy object.

This API is supported in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	ThreatSubmissionPolicies.ReadWrite.All
Delegated (personal Microsoft account)	Not supported
Application	ThreatSubmissionPolicy.ReadWrite.All

HTTP request

PATCH security/threatSubmission/emailThreatSubmissionPolicies/{emailThreatSubmissionPoliciesId}

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

These properties are related to the user reported message settings. For details, see User reported message settings.

Property	Type	Description
customizedNotificationSenderEmailAddress	String	Specifies the email address of the sender from which email notifications will be sent to end users to inform them whether an email is spam, phish or clean. The default value is `null`. Optional for creation.
customizedReportRecipientEmailAddress	String	Specifies the destination where the reported messages from end users will land whenever they report something as phish, junk or not junk. The default value is `null`. Optional for creation.
isAlwaysReportEnabledForUsers	Boolean	Indicates whether end users can report a message as spam, phish or junk directly without a confirmation(popup). The default value is `true`. Optional for creation.
isAskMeEnabledForUsers	Boolean	Indicates whether end users can confirm using a popup before reporting messages as spam, phish or not junk. The default value is `true`. Optional for creation.
isCustomizedMessageEnabled	Boolean	Indicates whether the email notifications sent to end users to inform them if an email is phish, spam or junk is customized or not. The default value is `false`. Optional for creation.
isCustomizedMessageEnabledForPhishing	Boolean	If enabled, customized message only shows when email is reported as phishing. The default value is `false`. Optional for creation.
isCustomizedNotificationSenderEnabled	Boolean	Indicates whether to use the sender email address set using customizedNotificationSenderEmailAddress for sending email notifications to end users. The default value is `false`. Optional for creation.
isNeverReportEnabledForUsers	Boolean	Indicates whether end users can simply move the message from one folder to another based on the action of spam, phish or not junk without actually reporting it. The default value is `true`. Optional for creation.
isOrganizationBrandingEnabled	Boolean	Indicates whether the branding logo should be used in the email notifications sent to end users. The default value is `false`. Optional for creation.
isReportFromQuarantineEnabled	Boolean	Indicates whether end users can submit from the quarantine page. The default value is `true`. Optional for creation.
isReportToCustomizedEmailAddressEnabled	Boolean	Indicates whether emails reported by end users should be send to the custom mailbox configured using customizedReportRecipientEmailAddress. The default value is `false`. Optional for creation.
isReportToMicrosoftEnabled	Boolean	If enabled, the email will be sent to Microsoft for analysis. The default value is `false`. Requried for creation.
isReviewEmailNotificationEnabled	Boolean	Indicates whether an email notification is sent to the end user who reported the email when it has been reviewed by the admin. The default value is `false`. Optional for creation.

Response

If successful, this method returns a 204 No Content response code. It does not return anything in the response body.

Examples

Request

The following is an example of a request.

PATCH https://graph.microsoft.com/beta/security/threatSubmission/emailthreatSubmissionPolicies/DefaultReportSubmissionPolicy
Content-type: application/json

{
  "isReportToMicrosoftEnabled": false
}


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Models.Security.EmailThreatSubmissionPolicy
{
	IsReportToMicrosoftEnabled = false,
};
var result = await graphClient.Security.ThreatSubmission.EmailThreatSubmissionPolicies["{emailThreatSubmissionPolicy-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta security threat-submission email-threat-submission-policies patch --email-threat-submission-policy-id {emailThreatSubmissionPolicy-id} --body '{\
  "isReportToMicrosoftEnabled": false\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelssecurity.NewEmailThreatSubmissionPolicy()
isReportToMicrosoftEnabled := false
requestBody.SetIsReportToMicrosoftEnabled(&isReportToMicrosoftEnabled) 

emailThreatSubmissionPolicies, err := graphClient.Security().ThreatSubmission().EmailThreatSubmissionPolicies().ByEmailThreatSubmissionPolicyId("emailThreatSubmissionPolicy-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EmailThreatSubmissionPolicy emailThreatSubmissionPolicy = new EmailThreatSubmissionPolicy();
emailThreatSubmissionPolicy.isReportToMicrosoftEnabled = false;

graphClient.security().threatSubmission().emailThreatSubmissionPolicies("DefaultReportSubmissionPolicy")
	.buildRequest()
	.patch(emailThreatSubmissionPolicy);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const emailThreatSubmissionPolicy = {
  isReportToMicrosoftEnabled: false
};

await client.api('/security/threatSubmission/emailthreatSubmissionPolicies/DefaultReportSubmissionPolicy')
	.version('beta')
	.update(emailThreatSubmissionPolicy);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EmailThreatSubmissionPolicy();
$requestBody->setIsReportToMicrosoftEnabled(false);

$result = $graphServiceClient->security()->threatSubmission()->emailThreatSubmissionPolicies()->byEmailThreatSubmissionPolicyId('emailThreatSubmissionPolicy-id')->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Security

$params = @{
	isReportToMicrosoftEnabled = $false
}

Update-MgBetaSecurityThreatSubmissionEmailThreatSubmissionPolicy -EmailThreatSubmissionPolicyId $emailThreatSubmissionPolicyId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)

request_body = EmailThreatSubmissionPolicy(
	is_report_to_microsoft_enabled = False,
)

result = await graph_client.security.threat_submission.email_threat_submission_policies.by_email_threat_submission_policie_id('emailThreatSubmissionPolicy-id').patch(body = request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

HTTP/1.1 204 No Content

Update emailThreatSubmissionPolicy

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources

Additional resources