SOAP API method User_createMailbox
Description
This will add a new mailbox to this user
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object User. The method only applies to the user with this id. |
| hostname * | string | The hostname |
| login * | string | The login |
| password * | string | The password |
| type * | string | Type of the mailbox, pop3 or imap |
| portnumber | int | portnumber (should normally be 110 for pop3 and 143 for imap) |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| mailbox | Structure of type 'mailbox' |
Structure 'login'
| Name | Type | Description |
|---|---|---|
| username | string | The username of the login attempt |
| account | string | The account name of the login attempt |
| password | string | The password for the login attempt |
Structure 'mailbox'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the Pop3box. |
| type | string | The type of mailbox, supported types are 'pop3' and 'imap' |
| login | string | The login code of the user |
| password | string | The password of the user |
| hostname | string | The hostname of the email provider |
| portnumber | int | The portnumber that is used to read mail |
| keepmessages | boolean | Should we keep messages on the server, or should the messages that were downloaded also be removed from the server? |