Back to API references

SOAP API method Mailbox_retrieve


Name Type Description
id * string The identifier (id) of the object that is retrieved
* required parameters

Return values

Name Type Description
mailbox Structure of type 'mailbox' All properties of the retrieved mailbox

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?