Get Mailbox Entity
Gets a MailboxEntity object.
NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
The identifier of the MailboxEntity object
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Response
OK
This entity represent a mailbox used for importing emails in Service Carrier object for MailboxEntity. Services for the MailboxEntity Carrier is available from the CustomerService Agent.
The primary key (auto-incremented)
Enum indicating the protocol to use (POP/IMAP).
Unknown, Pop, Imap, Mapi, Facebook, Pops, Imaps, SmsPlugin, Mailgun, ImapOAuth The address associated with this mailbox (used as FROM: address when sending emails).
The username used to log onto the mail account
The password used to log into the mail account. This is hidden when reading
The email server to connect to
The port used to connect to the server
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
NSCustomerServiceAgentNSMailboxEntityGet MailboxesSave Mailbox EntityCreate Default Mailbox EntityNSMailbox