Service: zimbraAccount

Command: GetInfo
Namespace: urn:zimbraAccount
Description: Get information about an account.
Properties:
Authorization token required true
Admin Authorization token required false

GetInfoRequest

By default, GetInfo returns all data; to limit the returned data, specify only the sections you want in the "sections" attr.

    <GetInfoRequest [rights="..."] [sections="..."] /> ## GetInfoRequest

elements and attributes you can define within a <GetInfoRequest> element:

XPath Required / Optional Description
@rights Optional (0 or 1) Type: String
Comma separated list of rights to return information about.
@sections Optional (0 or 1) Type: String
Comma separated list of sections to return information about.
Sections are: mbox,prefs,attrs,zimlets,props,idents,sigs,dsrcs,children

GetInfoResponse

The response to a request for account information

    <GetInfoResponse [attSizeLimit="{att-size-limit} (Long)"] [docSizeLimit="{doc-size-limit} (Long)"]> ## GetInfoResponse
        <version>{version} (String)</version>
        <id>{accountId} (String)</id>
        <profileImageId>{profileImageId} (int)</profileImageId>
        <name>{accountName} (String)</name>
        <crumb>{crumb} (String)</crumb>
        <lifetime>{lifetime} (long)</lifetime>
        <adminDelegated /> ## 0|1
        <rest>{restUrl} (String)</rest>
        <used>{quotaUsed} (Long)</used>
        <prevSession>{previousSessionTime} (Long)</prevSession>
        <accessed>{lastWriteAccessTime} (Long)</accessed>
        <recent>{recentMessageCount} (Integer)</recent>
        <cos [id="{cos-id}"] [name="{cos-name}"] /> ## Cos
        <prefs>
            (<pref name="{pref-name}" [modified="{pref-modified-time} (Long)"]>{value}</pref> ## Pref)*
        </prefs>
        <attrs>
            (<attr name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</attr> ## Attr)*
        </attrs>
        <zimlets>
            (<zimlet> ## AccountZimletInfo
                <zimletContext baseUrl="{zimlet-base-url}" [priority="{zimlet-priority} (Integer)"]
                                   presence="{zimlet-presence}" /> ## AccountZimletContext
                <zimlet [name="{zimlet-name}"] [version="{zimlet-version}"] [description="{zimlet-description}"]
                            [extension="{zimlet-extension}"] [target="{zimlet-target}"] [label="{zimlet-label}"]> ## AccountZimletDesc
                    List of any of: {
                        <serverExtension [hasKeyword="{keyword}"] [extensionClass="{extension-class}"] [regex="{regex}"] /> ## ZimletServerExtension
                        <include>{value}</include> ## AccountZimletInclude
                        <includeCSS>{value}</includeCSS> ## AccountZimletIncludeCSS
                        <target>{value}</target> ## AccountZimletTarget
                    }
                 </zimlet>
                <zimletConfig [name="{zimlet-name}"] [version="{zimlet-version}"] [description="{zimlet-description}"]
                                  [extension="{zimlet-extension}"] [target="{zimlet-target}"] [label="{zimlet-label}"]> ## AccountZimletConfigInfo
                    <global> ## AccountZimletGlobalConfigInfo
                        (<property [name="..."]>{value}</property> ## AccountZimletProperty)*
                     </global>
                    <host [name="{zimlet-host-name}"]> ## AccountZimletHostConfigInfo
                        (<property [name="..."]>{value}</property> ## See /zimlets/zimlet/zimletConfig/global/property [ ## AccountZimletProperty])*
                     </host>
                 </zimletConfig>
              </zimlet>)*
        </zimlets>
        <props>
            (<prop zimlet="{prop-zimlet-name}" name="{prop-name}">{value}</prop> ## Prop)*
        </props>
        <identities>
            (<identity [name="{identity-name}"] [id="{identity-id}"]> ## Identity
                (<a name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</a> ## See /attrs/attr [ ## Attr])*
              </identity>)*
        </identities>
        <signatures>
            (<signature [id="{signature-id}"] [name="{signature-name}"]> ## Signature
                (<content [type="{signature-content-type}"]>{content}</content> ## SignatureContent)*
                <cid>{cid} (String)</cid>
              </signature>)*
        </signatures>
        <dataSources>
            List of any of: {
                <imap [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                          [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                          [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                          [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                          [password="{data-source-password}"] [pollingInterval="..."]
                          [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                          [defaultSignature="{default-signature-id}"]
                          [forwardReplySignature="{forward-reply-signature-id}"] [fromDisplay="{data-source-from-display}"]
                          [replyToAddress="{data-source-replyto-address}"] [replyToDisplay="{data-source-replyto-display}"]
                          [importClass="{data-import-class}"] [failingSince="{data-source-failing-since} (Long)"]> ## AccountImapDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </imap>
                <pop3 [leaveOnServer="(0|1)"] [id="{data-source-id}"] [name="{data-source-name}"]
                          [l="{data-source-folder-id}"] [isEnabled="{data-source-is-enabled} (0|1)"]
                          [importOnly="{import-only} (0|1)"] [host="{data-source-server}"]
                          [port="{data-source-port} (Integer)"]
                          [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                          [password="{data-source-password}"] [pollingInterval="..."]
                          [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                          [defaultSignature="{default-signature-id}"]
                          [forwardReplySignature="{forward-reply-signature-id}"] [fromDisplay="{data-source-from-display}"]
                          [replyToAddress="{data-source-replyto-address}"] [replyToDisplay="{data-source-replyto-display}"]
                          [importClass="{data-import-class}"] [failingSince="{data-source-failing-since} (Long)"]> ## AccountPop3DataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </pop3>
                <caldav [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                            [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                            [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                            [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                            [password="{data-source-password}"] [pollingInterval="..."]
                            [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                            [defaultSignature="{default-signature-id}"]
                            [forwardReplySignature="{forward-reply-signature-id}"]
                            [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                            [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                            [failingSince="{data-source-failing-since} (Long)"]> ## AccountCaldavDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </caldav>
                <yab [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                         [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                         [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                         [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                         [password="{data-source-password}"] [pollingInterval="..."]
                         [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                         [defaultSignature="{default-signature-id}"] [forwardReplySignature="{forward-reply-signature-id}"]
                         [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                         [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                         [failingSince="{data-source-failing-since} (Long)"]> ## AccountYabDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </yab>
                <rss [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                         [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                         [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                         [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                         [password="{data-source-password}"] [pollingInterval="..."]
                         [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                         [defaultSignature="{default-signature-id}"] [forwardReplySignature="{forward-reply-signature-id}"]
                         [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                         [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                         [failingSince="{data-source-failing-since} (Long)"]> ## AccountRssDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </rss>
                <gal [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                         [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                         [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                         [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                         [password="{data-source-password}"] [pollingInterval="..."]
                         [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                         [defaultSignature="{default-signature-id}"] [forwardReplySignature="{forward-reply-signature-id}"]
                         [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                         [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                         [failingSince="{data-source-failing-since} (Long)"]> ## AccountGalDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </gal>
                <cal [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                         [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                         [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                         [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                         [password="{data-source-password}"] [pollingInterval="..."]
                         [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                         [defaultSignature="{default-signature-id}"] [forwardReplySignature="{forward-reply-signature-id}"]
                         [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                         [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                         [failingSince="{data-source-failing-since} (Long)"]> ## AccountCalDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </cal>
                <unknown [id="{data-source-id}"] [name="{data-source-name}"] [l="{data-source-folder-id}"]
                             [isEnabled="{data-source-is-enabled} (0|1)"] [importOnly="{import-only} (0|1)"]
                             [host="{data-source-server}"] [port="{data-source-port} (Integer)"]
                             [connectionType="(cleartext | ssl | tls | tls_is_available)"] [username="..."]
                             [password="{data-source-password}"] [pollingInterval="..."]
                             [emailAddress="{data-source-email-address}"] [useAddressForForwardReply="(0|1)"]
                             [defaultSignature="{default-signature-id}"]
                             [forwardReplySignature="{forward-reply-signature-id}"]
                             [fromDisplay="{data-source-from-display}"] [replyToAddress="{data-source-replyto-address}"]
                             [replyToDisplay="{data-source-replyto-display}"] [importClass="{data-import-class}"]
                             [failingSince="{data-source-failing-since} (Long)"]> ## AccountUnknownDataSource
                    <lastError>{lastError} (String)</lastError>
                    (<a>{attributes} (String)</a>)*
                 </unknown>
            }
        </dataSources>
        <childAccounts>
            (<childAccount id="{child-account-id}" name="{child-account-name}"
                               visible="{child-account-is-visible} (0|1)" active="{child-account-is-active} (0|1)"> ## ChildAccount
                <attrs>
                    (<attr name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</attr> ## See /attrs/attr [ ## Attr])*
                </attrs>
              </childAccount>)*
        </childAccounts>
        <rights>
            (<targets right="{targets-right}"> ## DiscoverRightsInfo
                (<target
                            type="{target-type} (account | calresource | cos | dl | group | domain | server | xmppcomponent | zimlet | config | global)"
                            [id="{target-id}"] [name="{target-name}"] [d="{target-display-name}"]> ## DiscoverRightsTarget
                    (<email addr="{email-address}" /> ## DiscoverRightsEmail)*
                 </target>)+
              </targets>)*
        </rights>
        <soapURL>{soapURL} (String)</soapURL>
        <publicURL>{publicURL} (String)</publicURL>
        <changePasswordURL>{changePasswordURL} (String)</changePasswordURL>
        <adminURL>{adminURL} (String)</adminURL>
        <boshURL>{boshURL} (String)</boshURL>
        <isTrackingIMAP /> ## See /adminDelegated [ ## 0|1]
    </GetInfoResponse>

elements and attributes you can define within a <GetInfoResponse> element:

XPath Required / Optional Description
@attSizeLimit Optional (0 or 1) Type: Long
The size limit for attachments - Use "-1" to mean unlimited
@docSizeLimit Optional (0 or 1) Type: Long
The size limit for documents
/version Required (only 1) Type: {version} (String)
Server version: <major>[.<minor>[.<maintenance>]][build] <release> <date>[<type>]
/id Required (only 1) Type: {accountId} (String)
Account ID
/profileImageId Optional (0 or 1) Type: {profileImageId} (int)
Profile image ID
/name Required (only 1) Type: {accountName} (String)
Email address (user@domain)
/crumb Optional (0 or 1) Type: {crumb} (String)
Crumb
/lifetime Required (only 1) Type: {lifetime} (long)
Number of milliseconds until auth token expires
/adminDelegated Optional (0 or 1) 1 (true) if the auth token is a delegated auth token issued to an admin account
/rest Optional (0 or 1) Type: {restUrl} (String)
Base REST URL for the requested account
/used Optional (0 or 1) Type: {quotaUsed} (Long)
Mailbox quota used in bytes.
Returned only if the command successfully executes on the target user's home mail server
/prevSession Optional (0 or 1) Type: {previousSessionTime} (Long)
Time (in millis) of last write op from this session, or from *any* SOAP session if we don't have one
Returned only if the command successfully executes on the target user's home mail server
/accessed Optional (0 or 1) Type: {lastWriteAccessTime} (Long)
Time (in millis) of last write op from any SOAP session before this session was initiated, or same as {previous-SOAP-session-time} if we don't have one.
Returned only if the command successfully executes on the target user's home mail server
/recent Optional (0 or 1) Type: {recentMessageCount} (Integer)
Number of messages received since the previous soap session, or since the last SOAP write op if we don't have a session.
Returned only if the command successfully executes on the target user's home mail server
/cos Optional (0 or 1) Class of service
/cos@id Optional (0 or 1) Type: String
Class of Service (COS) ID
/cos@name Optional (0 or 1) Type: String
Class of Service (COS) name
/prefs Required (only 1)
/prefs/pref Optional (0 or more) Type: {value}
Description for element text content:Preference value
/prefs/pref@name Required (only 1) Type: String
Preference name
/prefs/pref@modified Optional (0 or 1) Type: Long
Preference modified time (may not be present)
/attrs Required (only 1)
/attrs/attr Optional (0 or more) Type: {value}
Description for element text content:Value of attribute
/attrs/attr@name Required (only 1) Type: String
Name of attribute
/attrs/attr@pd Optional (0 or 1) Type: 0|1
Flags whether permission has been denied (optional).
If 1 (true), flags that the real value of this attribute has not been provided.
The value is set to ""
/zimlets Required (only 1)
/zimlets/zimlet Optional (0 or more)
/zimlets/zimlet/zimletContext Optional (0 or 1) Zimlet context
/zimlets/zimlet/zimletContext@baseUrl Required (only 1) Type: String
Zimlet Base URL
/zimlets/zimlet/zimletContext@priority Optional (0 or 1) Type: Integer
Zimlet Priority
/zimlets/zimlet/zimletContext@presence Required (only 1) Type: String
Zimlet presence
Valid values: mandatory | enabled | disabled
/zimlets/zimlet/zimlet Optional (0 or 1) Zimlet description
/zimlets/zimlet/zimlet@name Optional (0 or 1) Type: String
Zimlet Name
/zimlets/zimlet/zimlet@version Optional (0 or 1) Type: String
Zimlet Version
/zimlets/zimlet/zimlet@description Optional (0 or 1) Type: String
Zimlet description
/zimlets/zimlet/zimlet@extension Optional (0 or 1) Type: String
Zimlet extension
/zimlets/zimlet/zimlet@target Optional (0 or 1) Type: String
Zimlet target
/zimlets/zimlet/zimlet@label Optional (0 or 1) Type: String
Zimlet label
/zimlets/zimlet/zimlet/serverExtension Required (only 1)
/zimlets/zimlet/zimlet/serverExtension@hasKeyword Optional (0 or 1) Type: String
Keyword
/zimlets/zimlet/zimlet/serverExtension@extensionClass Optional (0 or 1) Type: String
Extension class
/zimlets/zimlet/zimlet/serverExtension@regex Optional (0 or 1) Type: String
Regex
/zimlets/zimlet/zimlet/include Required (only 1) Type: {value}
Description for element text content:Included script
/zimlets/zimlet/zimlet/includeCSS Required (only 1) Type: {value}
Description for element text content:Included Cascading Style Sheet (CSS)
/zimlets/zimlet/zimlet/target Required (only 1) Type: {value}
Description for element text content:Zimlet target
/zimlets/zimlet/zimletConfig Optional (0 or 1) Other elements
/zimlets/zimlet/zimletConfig@name Optional (0 or 1) Type: String
Zimlet Name
/zimlets/zimlet/zimletConfig@version Optional (0 or 1) Type: String
Zimlet Version
/zimlets/zimlet/zimletConfig@description Optional (0 or 1) Type: String
Zimlet description
/zimlets/zimlet/zimletConfig@extension Optional (0 or 1) Type: String
Zimlet extension
/zimlets/zimlet/zimletConfig@target Optional (0 or 1) Type: String
Zimlet target
/zimlets/zimlet/zimletConfig@label Optional (0 or 1) Type: String
Zimlet label
/zimlets/zimlet/zimletConfig/global Optional (0 or 1) Zimlet Global configuration information
/zimlets/zimlet/zimletConfig/global/property Optional (0 or more) Type: {value}
Global zimlet configuration property
Description for element text content:Property value
/zimlets/zimlet/zimletConfig/global/property@name Optional (0 or 1) Type: String
Property name
/zimlets/zimlet/zimletConfig/host Optional (0 or 1) Zimlet host specific configuration information
/zimlets/zimlet/zimletConfig/host@name Optional (0 or 1) Type: String
Designates the zimbra host name for the properties.
Must be a valid Zimbra host name
/zimlets/zimlet/zimletConfig/host/property Optional (0 or more) Type: {value}
Host specifice zimlet configuration properties
Description for element text content:Property value
See /zimlets/zimlet/zimletConfig/global/property for more details.
/props Required (only 1)
/props/prop Optional (0 or more) Type: {value}
Description for element text content:Property value
/props/prop@zimlet Required (only 1) Type: String
Zimlet name
/props/prop@name Required (only 1) Type: String
Property name
/identities Required (only 1)
/identities/identity Optional (0 or more)
/identities/identity@name Optional (0 or 1) Type: String
Identity name
/identities/identity@id Optional (0 or 1) Type: String
Identity ID
/identities/identity/a Optional (0 or more) Type: {value}
Attributes
Description for element text content:Value of attribute
See /attrs/attr for more details.
/signatures Required (only 1)
/signatures/signature Optional (0 or more)
/signatures/signature@id Optional (0 or 1) Type: String
ID for the signature
/signatures/signature@name Optional (0 or 1) Type: String
Name for the signature
/signatures/signature/content Optional (0 or more) Type: {content}
Content of the signature
Description for element text content:Signature value
/signatures/signature/content@type Optional (0 or 1) Type: String
Content Type - "text/plain" or "text/html"
/signatures/signature/cid Optional (0 or 1) Type: {cid} (String)
Contact ID
/dataSources Required (only 1)
/dataSources/imap Optional (0 or 1)
/dataSources/imap@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/imap@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/imap@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/imap@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/imap@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/imap@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/imap@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/imap@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/imap@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/imap@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/imap@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/imap@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/imap@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/imap@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/imap@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/imap@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/imap@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/imap@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/imap@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/imap@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/imap/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/imap/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/pop3 Optional (0 or 1)
/dataSources/pop3@leaveOnServer Optional (0 or 1) Type: 0|1
Specifies whether imported POP3 messages should be left on the server or deleted.
/dataSources/pop3@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/pop3@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/pop3@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/pop3@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/pop3@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/pop3@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/pop3@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/pop3@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/pop3@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/pop3@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/pop3@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/pop3@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/pop3@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/pop3@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/pop3@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/pop3@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/pop3@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/pop3@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/pop3@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/pop3@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/pop3/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/pop3/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/caldav Optional (0 or 1)
/dataSources/caldav@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/caldav@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/caldav@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/caldav@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/caldav@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/caldav@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/caldav@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/caldav@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/caldav@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/caldav@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/caldav@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/caldav@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/caldav@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/caldav@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/caldav@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/caldav@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/caldav@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/caldav@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/caldav@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/caldav@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/caldav/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/caldav/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/yab Optional (0 or 1)
/dataSources/yab@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/yab@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/yab@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/yab@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/yab@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/yab@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/yab@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/yab@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/yab@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/yab@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/yab@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/yab@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/yab@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/yab@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/yab@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/yab@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/yab@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/yab@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/yab@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/yab@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/yab/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/yab/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/rss Optional (0 or 1)
/dataSources/rss@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/rss@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/rss@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/rss@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/rss@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/rss@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/rss@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/rss@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/rss@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/rss@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/rss@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/rss@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/rss@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/rss@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/rss@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/rss@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/rss@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/rss@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/rss@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/rss@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/rss/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/rss/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/gal Optional (0 or 1)
/dataSources/gal@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/gal@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/gal@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/gal@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/gal@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/gal@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/gal@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/gal@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/gal@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/gal@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/gal@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/gal@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/gal@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/gal@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/gal@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/gal@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/gal@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/gal@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/gal@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/gal@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/gal/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/gal/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/cal Optional (0 or 1)
/dataSources/cal@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/cal@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/cal@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/cal@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/cal@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/cal@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/cal@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/cal@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/cal@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/cal@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/cal@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/cal@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/cal@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/cal@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/cal@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/cal@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/cal@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/cal@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/cal@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/cal@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/cal/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/cal/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/dataSources/unknown Optional (0 or 1)
/dataSources/unknown@id Optional (0 or 1) Type: String
Unique ID for data source
/dataSources/unknown@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/dataSources/unknown@l Optional (0 or 1) Type: String
Folder ID for data source
/dataSources/unknown@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/dataSources/unknown@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/dataSources/unknown@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/dataSources/unknown@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/dataSources/unknown@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_is_available
Which security layer to use for connection (cleartext, ssl, tls, or tls if available). If not set on data source, fallback to the value on global config.
/dataSources/unknown@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/dataSources/unknown@password Optional (0 or 1) Type: String
Login password for data source
/dataSources/unknown@pollingInterval Optional (0 or 1) Type: String
Polling interval. For instance "10m"
The time interval between automated data imports for a data source. If unset or 0, the data source will not be scheduled for automated polling. Must be in valid duration format:
{digits}{time-unit}. digits: 0-9, time-unit: [hmsd]|ms. h - hours, m - * minutes, s - seconds, d - days, ms - milliseconds.
If time unit is not specified, the default is s(seconds).
/dataSources/unknown@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/dataSources/unknown@useAddressForForwardReply Optional (0 or 1) Type: 0|1
When forwarding or replying to messages sent to this data source, this flags whether or not to use the email address of the data source for the from address and the designated signature/replyTo of the data source for the outgoing message.
/dataSources/unknown@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/dataSources/unknown@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/dataSources/unknown@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/dataSources/unknown@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/dataSources/unknown@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/dataSources/unknown@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/dataSources/unknown@failingSince Optional (0 or 1) Type: Long
Failing Since
/dataSources/unknown/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/dataSources/unknown/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/childAccounts Required (only 1)
/childAccounts/childAccount Optional (0 or more)
/childAccounts/childAccount@id Required (only 1) Type: String
Child account ID
/childAccounts/childAccount@name Required (only 1) Type: String
Child account name
/childAccounts/childAccount@visible Required (only 1) Type: 0|1
Flag whether child account is visible or not
/childAccounts/childAccount@active Required (only 1) Type: 0|1
Flag whether child account is active or not
/childAccounts/childAccount/attrs Required (only 1)
/childAccounts/childAccount/attrs/attr Optional (0 or more) Type: {value}
Description for element text content:Value of attribute
See /attrs/attr for more details.
/rights Required (only 1)
/rights/targets Optional (0 or more)
/rights/targets@right Required (only 1) Type: String
Right the targets relate to
/rights/targets/target Required (1 or more) Targets
/rights/targets/target@type Required (only 1) Type: account | calresource | cos | dl | group | domain | server | xmppcomponent | zimlet | config | global
Target type
/rights/targets/target@id Optional (0 or 1) Type: String
Target ID
/rights/targets/target@name Optional (0 or 1) Type: String
Target name
/rights/targets/target@d Optional (0 or 1) Type: String
If a discovered target is an account or a group and the entry has a display name set then this is set to that display name.
/rights/targets/target/email Optional (0 or more) Email addresses
/rights/targets/target/email@addr Required (only 1) Type: String
Email address
/soapURL Optional (0 or 1) Type: {soapURL} (String)
URL to talk to for soap service for this account. e.g.:
     http://server:7070/service/soap/
 

If both http and https (SSL) are enabled, the https URL will be returned.

/publicURL Optional (0 or 1) Type: {publicURL} (String)
Base public URL for the requested account
/changePasswordURL Optional (0 or 1) Type: {changePasswordURL} (String)
URL to talk to in order to change a password. Not returned if not configured via domain attribute zimbraChangePasswordURL
/adminURL Optional (0 or 1) Type: {adminURL} (String)
base URL for accessing the admin console
/boshURL Optional (0 or 1) Type: {boshURL} (String)
Proxy URL for accessing XMPP over BOSH. Should be returned only when zimbraFeatureChatEnabled is set to TRUE for Account/COS
/isTrackingIMAP Optional (0 or 1) Boolean value denoting if this account has logged in over IMAP.
See /adminDelegated for more details.