Get Started
Portal api methods
Help

POST api/2.0/mail/accounts This function requires authentication

Description

Creates account using full information about mail servers.

Parameters
Name Description Type Example
name
sent in body
Account name in Teamlab string some text
email
sent in body
Account email in string format like: name@domain. string some text
account
sent in body
Login for imap or pop server. string some text
password
sent in body
Password for imap or pop server string some text
port
sent in body
Port for imap or pop server number 1234
server
sent in body
Imap or pop server address or IP. string some text
smtp_account
sent in body
Login for smtp server string some text
smtp_password
sent in body
Password for smtp server string some text
smtp_port
sent in body
Smtp server port number 1234
smtp_server
sent in body
Smtp server adress or IP. string some text
smtp_auth
sent in body
Flag is smtp server authentication needed. Value: true or false. Bool value true
imap
sent in body
Flag is imap server using for incoming mails. Value: true or false. Bool value true
restrict
sent in body
Flag is all mails needed for download. Value: true or false. If vslue true, it will be downloaded messages from last 30 days only. Bool value true
incoming_encryption_type
sent in body
Specify encription type for imap or pop server. 0- None, 1 - SSL, 2- StartTLS None, SSL, StartTLS
outcoming_encryption_type
sent in body
Specify encription type for smtp server. 0- None, 1 - SSL, 2- StartTLS None, SSL, StartTLS
auth_type_in
sent in body
Specify authentication type for imap or pop server. 1 - Login, 4 - CremdMd5, 5 - OAuth2 None, Login, CramMd5, OAuth2
auth_type_smtp
sent in body
Specify authentication type for imap or pop server. 0- None, 1 - Login, 4 - CremdMd5, 5 - OAuth2 None, Login, CramMd5, OAuth2
Example
POST api/2.0/mail/accounts
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "email": "some text",
  "account": "some text",
  "password": "some text",
  "port": 1234,
  "server": "some text",
  "smtp_account": "some text",
  "smtp_password": "some text",
  "smtp_port": 1234,
  "smtp_server": "some text",
  "smtp_auth": true,
  "imap": true,
  "restrict": true,
  "incoming_encryption_type": "None",
  "outcoming_encryption_type": "None",
  "auth_type_in": "None",
  "auth_type_smtp": "None"
}
Returns

Created account