SOAP API method User_createMailbox

Back to API references

Description
This will add a new mailbox to this user

Parameters
Parameter 'id' : int
Unique identifier (id) of the object User. The method only applies to the user with this id.
Parameter 'hostname' : string
The hostname
Parameter 'login' : string
The login
Parameter 'password' : string
The password
Parameter 'type' : string
Type of the mailbox, pop3 or imap
Parameter 'portnumber' : int
portnumber (should normally be 110 for pop3 and 143 for imap)
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'mailbox' : Structure of type 'mailbox'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'mailbox'
This structure mailbox was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the Pop3box.
Property 'type' : string
The type of mailbox, supported types are 'pop3' and 'imap'
Property 'login' : string
The login code of the user
Property 'password' : string
The password of the user
Property 'hostname' : string
The hostname of the email provider
Property 'portnumber' : int
The portnumber that is used to read mail
Property 'keepmessages' : boolean
Should we keep messages on the server, or should the messages that were downloaded also be removed from the server?