Functions for work with mail

getMailboxList

Description:

Method returns all mailboxes on given domain.

Additional parameters
  • domain - domain, whose mailboxes will be displayed (e.g. site.de);
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/getMailboxList?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"domain":"site.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/getMailboxList?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%7D
Response example:
[
   {
      "mailbox":"mailbox1",
      "domain":"site.de",
      "spam_filter_status":1,
      "forward_mail_status":"no_forward"
   },
   {
      "mailbox":"test.mail",
      "domain":"site.de",
      "spam_filter_status": 0,
      "forward_mail_status": "forward"
   },
   {
      "mailbox":"admin",
      "domain":"site.de",
      "spam_filter_status":1,
      "forward_mail_status":"forward_and_delete"
   }
]

changeMailboxPassword

Description:

Method changes password to given mailbox.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info);
  • mailbox_password - mailbox password.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/changeMailboxPassword?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"domain":"site.de","mailbox":"info",
"mailbox_password":"password"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/changeMailboxPassword?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox
%22%3A%22info%22%2C%22mailbox_password%22%3A%22password%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

createMailbox

Description:

Method creates mailbox on given domain.

Additional parameters
  • domain - domain, where thd mailbox shall be created (e.g. site.de);
  • mailbox - mailbox name (e.g. info);
  • mailbox_password - mailbox password.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/createMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"domain":"site.de","mailbox":"info",
"mailbox_password":"password"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/createMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox
%22%3A%22info%22%2C%22mailbox_password%22%3A%22password%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

dropMailbox

Description:

Method deletes mailbox on given domain.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info).
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/dropMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"domain":"site.de","mailbox":"info"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/dropMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

changeMailboxSettings

Description:

Method sets options for mailbox.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info);
  • spam_filter_status - spam filter operation status (0/1);
  • spam_filter - spam filtering level (0 - max. filtering, 100 - minimum);
  • forward_mail_status - forwarding operation mode for mailbox.
    • no_forward - messages will not be forwarded,
    • forward - messages will also be forwarded to indicated mailboxes,
    • forward_and_delete - messages will be forwarded and deleted from mailbox.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/changeMailboxSettings?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de","mailbox":"info","spam_filter_status":1,"spam_filter":50,
"forward_mail_status":"no_forward"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/changeMailboxSettings?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info
%22%2C%22spam_filter_status%22%3A1%2C%22spam_filter%22%3A50%2C%0A
%22forward_mail_status%22%3A%22
no_forward%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

forwardListAddMailbox

Description:

Method will add mailbox to list of mailboxes for forwarding.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info);
  • forward_mailbox - mailbox, where messages will be forwarded to.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/forwardListAddMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de","mailbox":"info","forward_mailbox":""mail@yandex.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/forwardListAddMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22
info%22%2C%22forward_mailbox%22%3A%22%22mail%40yandex.de%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

forwardListDeleteMailbox

Description:

Method deletes mailbox from list of mailboxes for forwarding.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info);
  • forward_mailbox - mailbox, which will be deleted from forwarding list.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/forwardListDeleteMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de","mailbox":"info","forward_mailbox":""mail@yandex.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/forwardListDeleteMailbox?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22
info%22%2C%22forward_mailbox%22%3A%22%22mail%40yandex.de%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

forwardListShow

Description:

Method returns forwarding list for indicated mailbox.

Additional parameters
  • domain - domain, where the mailbox is located (e.g. site.de);
  • mailbox - mailbox name (e.g. info).
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/forwardListShow?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de","mailbox":"info"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/forwardListShow?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info%22%7D
Response example:
[
   {
      "forward_mailbox":"admin@domain.de"
   },
   {
      "forward_mailbox":"webmaster@site.com"
   }
]

setDomainMail

Description:

Method sets up domain mail.

Additional parameters
  • domain - domain, which the domain mail shall be set up for (e.g. site.de);
  • domain_mailbox - mailbox, which shall be set up as domain mail (e.g. mail@site.de).
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/setDomainMail?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de","domain_mailbox":"mail@site.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/setDomainMail?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%2C%22domain_mailbox%22%3A
%22mail%40site.de%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

clearDomainMail

Description:

Method resets domain mail.

Additional parameters
  • domain - domain, which the domain mail will be reset for (e.g. site.de);
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/mail/clearDomainMail?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"domain":"site.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/mail/clearDomainMail?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22domain%22%3A%22site.de%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.