JSON Object Example
{
    "Timeout": 0,
    "Server": "pop.gmail.com",
    "ServerType": "POP3",
    "LoginOnServer": true,
    "UserName": "dotcom.monitor@gmail.com",
    "Password": "test",
    "UseSSL": true,
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "Device_Id": 63646,
    "Id": 159274,
    "Task_Type_Id": 3,
    "Name": "pop.gmail.com"
}

Fields Description

Field Type Required/Optional Description

Server

string

required

 This field is for POP3/IMAP server address and port number.

Example:
Server": "pop.gmail.com:995"

ServerType

string

required

 This field defines protocol type.

POSSIBLE VALUES:

  • POP3
  • IMAP
Example:
"ServerType": "POP3"

LoginOnServer

boolean

optional

 When enabled – login operation will be performed during monitoring session.

Example:
"LoginOnServer": true

UserName

string

optional

 This field contains a username for POP3/IMAP authentication.

Example:
"UserName": "username"

Password

string

optional

 This field contains a password for POP3/IMAP authentication.

Example:
"Password": "password"

UseSSL

boolean

optional

 When enabled – POP3/IMAP over SSL will be requested.

Example:
"UseSSL": true
DNSResolveMode string optional POSSIBLE VALUES:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation please see the “DNS Mode Option” article.
DNSserverIP string optional Field for a custom DNS server IP address. For detailed explanation please see the “DNS Mode Option” article.
Device_Id

int32

required

 READ ONLY Field. Unique device ID.

Example:
"Device_Id": 8550

Id

int32

required

*Only for edit operations

 READ ONLY Field. The unique task id. Do not use for create operations.

Example:
"Id": 17711

Task_Type_Id

int32

required

 The type id of the task.

Example:
"Task_Type_Id": 3

Name

string

optional

 Task name.

Example:
"Name": "Gmail POP3"

Timeout

int32

optional

 This field defines timeout value (in seconds) for task execution.

Example:
"Timeout": 0