GET api/2.0/mail/accounts/setups This function requires authentication

Description

Returns the default settings for an account with the email address specified in the request.

Parameters

Name	Description	Type	Example
email sent in url	Account email address	string	some text
action sent in url	The default settings type: "get_imap_pop_settings" - get the IMAP or POP settings (IMAP settings are prior), "get_imap_server" \| "get_imap_server_full" - get the IMAP server settings, "get_pop_server" \| "get_pop_server_full" - get the POP server settings. The default IMAP settings are returned by default.	string	some text

Example

GET api/2.0/mail/accounts/setups?email=%22some+text%22&action=%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

Account with default settings

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "1",
    "email": "email.only.com",
    "name": "name",
    "account": "account",
    "password": "password",
    "server": "server",
    "smtp_server": "smtp_server",
    "smtp_port": "smtp_port",
    "smtp_account": "smtp_account",
    "smtp_password": "smtp_password",
    "smtp_auth": "smtp_auth",
    "port": "port",
    "incoming_encryption_type": 1,
    "outcoming_encryption_type": 2,
    "auth_type_in": 2,
    "auth_type_smtp": 2,
    "imap": true,
    "begin_date": "2020-10-01T17:04:32.0000000",
    "is_oauth": true,
    "restrict": true,
    "email_in_folder": "email_in_folder",
    "is_teamlab": "is_teamlab"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>1</id>
    <email>email.only.com</email>
    <name>name</name>
    <account>account</account>
    <password>password</password>
    <server>server</server>
    <smtp_server>smtp_server</smtp_server>
    <smtp_port>smtp_port</smtp_port>
    <smtp_account>smtp_account</smtp_account>
    <smtp_password>smtp_password</smtp_password>
    <smtp_auth>smtp_auth</smtp_auth>
    <port>port</port>
    <incoming_encryption_type>1</incoming_encryption_type>
    <outcoming_encryption_type>2</outcoming_encryption_type>
    <auth_type_in>2</auth_type_in>
    <auth_type_smtp>2</auth_type_smtp>
    <imap>True</imap>
    <begin_date>2020-10-01T17:04:32.0000000</begin_date>
    <is_oauth>True</is_oauth>
    <restrict>True</restrict>
    <email_in_folder>email_in_folder</email_in_folder>
    <is_teamlab>is_teamlab</is_teamlab>
  </response>
</result>