Add a new Email payload configuration to an existing profile

To create Email policy

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

account_namestringOptional

Account Name

account_typestringOptional

Account Type. Default: IMAP

account_path_prefixstringOptional

Account Path Prefix

account_user_namestringOptional

Account User Name

mail_addressstringOptional

Mail Address

allow_movebooleanOptional

Allow Move. Default: true

prevent_movebooleanOptional

Prevent Move. Default: false

disable_mail_recents_syncingbooleanOptional

Disable Mail Recents Syncing. Default: false

incoming_server_hostnamestringMandatory

Incoming Server Hostname

incoming_server_portintegerOptional

Incoming Server Port. Default: 143

incoming_server_usernamestringMandatory

Incoming Server Username

incoming_server_authstringMandatory

Incoming Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

incoming_passwordstringOptional

Incoming Password (sensitive - write-only)

incoming_password_idlongOptional

Incoming Password Id

incoming_server_use_sslbooleanOptional

Incoming Server Use Ssl. Default: false

outgoing_server_hostnamestringMandatory

Outgoing Server Hostname

outgoing_server_portintegerOptional

Outgoing Server Port. Default: 587

outgoing_server_usernamestringMandatory

Outgoing Server Username

outgoing_server_authstringMandatory

Outgoing Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

outgoing_passwordstringOptional

Outgoing Password (sensitive - write-only)

outgoing_password_idlongOptional

Outgoing Password Id

outgoing_pwd_as_income_pwdbooleanOptional

Outgoing Pwd As Income Pwd. Default: false

use_only_mail_appbooleanOptional

Use Only Mail App. Default: false

outgoing_server_use_sslbooleanOptional

Outgoing Server Use Ssl. Default: false

use_mime_encryptbooleanOptional

Use Mime Encrypt. Default: false

signing_cert_idlongOptional

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlongOptional

Encryption identity certificate ID obtained from the Certificates API.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"prevent_move":false,"account_type":"IMAP","disable_mail_recents_syncing":false,"incoming_server_username":"user@zylker.com","outgoing_server_username":"user@zylker.com","allow_move":true,"incoming_server_hostname":"https://zylker.com","outgoing_server_hostname":"smtp.zylker.com","account_user_name":"Zylker User","account_path_prefix":"value","account_name":"Zylker User","incoming_server_auth":"password","mail_address":"user@zylker.com","outgoing_server_auth":"password","incoming_server_port":143}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"prevent_move\":false,\"account_type\":\"IMAP\",\"disable_mail_recents_syncing\":false,\"incoming_server_username\":\"user@zylker.com\",\"outgoing_server_username\":\"user@zylker.com\",\"allow_move\":true,\"incoming_server_hostname\":\"https://zylker.com\",\"outgoing_server_hostname\":\"smtp.zylker.com\",\"account_user_name\":\"Zylker User\",\"account_path_prefix\":\"value\",\"account_name\":\"Zylker User\",\"incoming_server_auth\":\"password\",\"mail_address\":\"user@zylker.com\",\"outgoing_server_auth\":\"password\",\"incoming_server_port\":143}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"prevent_move\":false,\"account_type\":\"IMAP\",\"disable_mail_recents_syncing\":false,\"incoming_server_username\":\"user@zylker.com\",\"outgoing_server_username\":\"user@zylker.com\",\"allow_move\":true,\"incoming_server_hostname\":\"https://zylker.com\",\"outgoing_server_hostname\":\"smtp.zylker.com\",\"account_user_name\":\"Zylker User\",\"account_path_prefix\":\"value\",\"account_name\":\"Zylker User\",\"incoming_server_auth\":\"password\",\"mail_address\":\"user@zylker.com\",\"outgoing_server_auth\":\"password\",\"incoming_server_port\":143}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("account_name","value");
    data.put("account_type","value");
    data.put("account_path_prefix","value");
    data.put("account_user_name","value");
    data.put("mail_address","value");
    data.put("allow_move",true);
    data.put("prevent_move",true);
    data.put("disable_mail_recents_syncing",true);
    data.put("incoming_server_hostname","value");
    data.put("incoming_server_port","1");
    data.put("incoming_server_username","value");
    data.put("incoming_server_auth","value");
    data.put("incoming_password","value");
    data.put("incoming_password_id","1");
    data.put("incoming_server_use_ssl",true);
    data.put("outgoing_server_hostname","value");
    data.put("outgoing_server_port","1");
    data.put("outgoing_server_username","value");
    data.put("outgoing_server_auth","value");
    data.put("outgoing_password","value");
    data.put("outgoing_password_id","1");
    data.put("outgoing_pwd_as_income_pwd",true);
    data.put("use_only_mail_app",true);
    data.put("outgoing_server_use_ssl",true);
    data.put("use_mime_encrypt",true);
    data.put("signing_cert_id","1");
    data.put("encryption_cert_id","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"prevent_move":false,"account_type":"IMAP","disable_mail_recents_syncing":false,"incoming_server_username":"user@zylker.com","outgoing_server_username":"user@zylker.com","allow_move":true,"incoming_server_hostname":"https://zylker.com","outgoing_server_hostname":"smtp.zylker.com","account_user_name":"Zylker User","account_path_prefix":"value","account_name":"Zylker User","incoming_server_auth":"password","mail_address":"user@zylker.com","outgoing_server_auth":"password","incoming_server_port":143}'

Sample Request Body

Add Email payload to the profile

Copied!

  {
    "prevent_move": false,
    "account_type": "IMAP",
    "disable_mail_recents_syncing": false,
    "incoming_server_username": "user@zylker.com",
    "outgoing_server_username": "user@zylker.com",
    "allow_move": true,
    "incoming_server_hostname": "https://zylker.com",
    "outgoing_server_hostname": "smtp.zylker.com",
    "account_user_name": "Zylker User",
    "account_path_prefix": "value",
    "account_name": "Zylker User",
    "incoming_server_auth": "password",
    "mail_address": "user@zylker.com",
    "outgoing_server_auth": "password",
    "incoming_server_port": 143
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

account_namestring

Account Name

account_typestring

Account Type. Default: IMAP

account_path_prefixstring

Account Path Prefix

account_user_namestring

Account User Name

mail_addressstring

Mail Address

allow_moveboolean

Allow Move. Default: true

prevent_moveboolean

Prevent Move. Default: false

disable_mail_recents_syncingboolean

Disable Mail Recents Syncing. Default: false

incoming_server_hostnamestring

Incoming Server Hostname

incoming_server_portinteger

Incoming Server Port. Default: 143

incoming_server_usernamestring

Incoming Server Username

incoming_server_authstring

Incoming Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

incoming_passwordstring

Incoming Password (sensitive - write-only)

incoming_password_idlong

Incoming Password Id

incoming_server_use_sslboolean

Incoming Server Use Ssl. Default: false

outgoing_server_hostnamestring

Outgoing Server Hostname

outgoing_server_portinteger

Outgoing Server Port. Default: 587

outgoing_server_usernamestring

Outgoing Server Username

outgoing_server_authstring

Outgoing Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

outgoing_passwordstring

Outgoing Password (sensitive - write-only)

outgoing_password_idlong

Outgoing Password Id

outgoing_pwd_as_income_pwdboolean

Outgoing Pwd As Income Pwd. Default: false

use_only_mail_appboolean

Use Only Mail App. Default: false

outgoing_server_use_sslboolean

Outgoing Server Use Ssl. Default: false

use_mime_encryptboolean

Use Mime Encrypt. Default: false

signing_cert_idlong

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlong

Encryption identity certificate ID obtained from the Certificates API.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Email payload successfully added

Copied!

  {
    "prevent_move": false,
    "payload_id": 9007199254741000,
    "account_type": "IMAP",
    "disable_mail_recents_syncing": false,
    "incoming_server_username": "user@zylker.com",
    "outgoing_server_username": "user@zylker.com",
    "allow_move": true,
    "incoming_server_hostname": "https://zylker.com",
    "outgoing_server_hostname": "smtp.zylker.com",
    "account_user_name": "Zylker User",
    "account_path_prefix": "value",
    "account_name": "Zylker User",
    "incoming_server_auth": "password",
    "mail_address": "user@zylker.com",
    "outgoing_server_auth": "password",
    "incoming_server_port": 143
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.