Overview Service Command

Service: zimbraMail

Command: ModifyDataSource
Namespace: urn:zimbraMail
Description: Changes attributes of the given data source. Only the attributes specified in the request are modified. If the username, host or leaveOnServer settings are modified, the server wipes out saved state for this data source. As a result, any previously downloaded messages that are still stored on the remote server will be downloaded again.
Properties:
Authorization token required true
Admin Authorization token required false

ModifyDataSourceRequest

    <ModifyDataSourceRequest> ## ModifyDataSourceRequest
        Choose one of: {
            <imap [test="{test-data-source} (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_if_available)"] [username="..."]
                      [password="{data-source-password}"] [pollingInterval="..."]
                      [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                      [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                      [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                      [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)"]> ## MailImapDataSource
                <lastError>{lastError} (String)</lastError>
                (<a>{attributes} (String)</a>)*
             </imap>
            <pop3 [leaveOnServer="{leave-on-server} (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_if_available)"] [username="..."]
                      [password="{data-source-password}"] [pollingInterval="..."]
                      [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                      [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                      [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                      [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)"]> ## MailPop3DataSource
                <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_if_available)"] [username="..."]
                        [password="{data-source-password}"] [pollingInterval="..."]
                        [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                        [smtpPort="{smtp-port} (Integer)"]
                        [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"] [smtpAuthRequired="(0|1)"]
                        [smtpUsername="..."] [smtpPassword="{smtp-password}"] [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)"]> ## MailCaldavDataSource
                <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_if_available)"] [username="..."]
                     [password="{data-source-password}"] [pollingInterval="..."]
                     [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                     [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                     [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                     [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)"]> ## MailYabDataSource
                <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_if_available)"] [username="..."]
                     [password="{data-source-password}"] [pollingInterval="..."]
                     [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                     [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                     [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                     [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)"]> ## MailRssDataSource
                <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_if_available)"] [username="..."]
                     [password="{data-source-password}"] [pollingInterval="..."]
                     [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                     [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                     [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                     [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)"]> ## MailGalDataSource
                <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_if_available)"] [username="..."]
                     [password="{data-source-password}"] [pollingInterval="..."]
                     [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                     [smtpPort="{smtp-port} (Integer)"] [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"]
                     [smtpAuthRequired="(0|1)"] [smtpUsername="..."] [smtpPassword="{smtp-password}"]
                     [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)"]> ## MailCalDataSource
                <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_if_available)"] [username="..."]
                         [password="{data-source-password}"] [pollingInterval="..."]
                         [emailAddress="{data-source-email-address}"] [smtpEnabled="(0|1)"] [smtpHost="{smtp-server}"]
                         [smtpPort="{smtp-port} (Integer)"]
                         [smtpConnectionType="(cleartext | ssl | tls | tls_if_available)"] [smtpAuthRequired="(0|1)"]
                         [smtpUsername="..."] [smtpPassword="{smtp-password}"] [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)"]> ## MailDataSource
                <lastError>{lastError} (String)</lastError>
                (<a>{attributes} (String)</a>)*
             </unknown>
        }
    </ModifyDataSourceRequest>

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

XPath Required / Optional Description
/imap Optional (0 or 1)
/imap@test Optional (0 or 1) Type: 0|1
boolean field for client to denote if it wants to test the data source before creating
/imap@id Optional (0 or 1) Type: String
Unique ID for data source
/imap@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/imap@l Optional (0 or 1) Type: String
Folder ID for data source
/imap@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/imap@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/imap@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/imap@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/imap@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/imap@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/imap@password Optional (0 or 1) Type: String
Login password for data source
/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).
/imap@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/imap@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/imap@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/imap@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/imap@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/imap@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/imap@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/imap@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/imap@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/imap@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/imap@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/imap@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/imap@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/imap@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/imap@failingSince Optional (0 or 1) Type: Long
Failing Since
/imap/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/imap/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/pop3 Optional (0 or 1)
/pop3@leaveOnServer Optional (0 or 1) Type: 0|1
Leave messages on the server
/pop3@id Optional (0 or 1) Type: String
Unique ID for data source
/pop3@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/pop3@l Optional (0 or 1) Type: String
Folder ID for data source
/pop3@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/pop3@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/pop3@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/pop3@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/pop3@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/pop3@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/pop3@password Optional (0 or 1) Type: String
Login password for data source
/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).
/pop3@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/pop3@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/pop3@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/pop3@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/pop3@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/pop3@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/pop3@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/pop3@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/pop3@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/pop3@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/pop3@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/pop3@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/pop3@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/pop3@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/pop3@failingSince Optional (0 or 1) Type: Long
Failing Since
/pop3/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/pop3/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/caldav Optional (0 or 1)
/caldav@id Optional (0 or 1) Type: String
Unique ID for data source
/caldav@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/caldav@l Optional (0 or 1) Type: String
Folder ID for data source
/caldav@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/caldav@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/caldav@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/caldav@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/caldav@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/caldav@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/caldav@password Optional (0 or 1) Type: String
Login password for data source
/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).
/caldav@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/caldav@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/caldav@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/caldav@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/caldav@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/caldav@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/caldav@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/caldav@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/caldav@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/caldav@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/caldav@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/caldav@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/caldav@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/caldav@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/caldav@failingSince Optional (0 or 1) Type: Long
Failing Since
/caldav/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/caldav/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/yab Optional (0 or 1)
/yab@id Optional (0 or 1) Type: String
Unique ID for data source
/yab@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/yab@l Optional (0 or 1) Type: String
Folder ID for data source
/yab@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/yab@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/yab@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/yab@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/yab@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/yab@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/yab@password Optional (0 or 1) Type: String
Login password for data source
/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).
/yab@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/yab@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/yab@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/yab@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/yab@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/yab@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/yab@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/yab@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/yab@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/yab@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/yab@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/yab@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/yab@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/yab@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/yab@failingSince Optional (0 or 1) Type: Long
Failing Since
/yab/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/yab/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/rss Optional (0 or 1)
/rss@id Optional (0 or 1) Type: String
Unique ID for data source
/rss@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/rss@l Optional (0 or 1) Type: String
Folder ID for data source
/rss@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/rss@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/rss@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/rss@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/rss@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/rss@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/rss@password Optional (0 or 1) Type: String
Login password for data source
/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).
/rss@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/rss@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/rss@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/rss@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/rss@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/rss@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/rss@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/rss@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/rss@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/rss@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/rss@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/rss@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/rss@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/rss@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/rss@failingSince Optional (0 or 1) Type: Long
Failing Since
/rss/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/rss/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/gal Optional (0 or 1)
/gal@id Optional (0 or 1) Type: String
Unique ID for data source
/gal@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/gal@l Optional (0 or 1) Type: String
Folder ID for data source
/gal@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/gal@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/gal@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/gal@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/gal@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/gal@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/gal@password Optional (0 or 1) Type: String
Login password for data source
/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).
/gal@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/gal@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/gal@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/gal@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/gal@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/gal@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/gal@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/gal@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/gal@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/gal@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/gal@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/gal@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/gal@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/gal@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/gal@failingSince Optional (0 or 1) Type: Long
Failing Since
/gal/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/gal/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/cal Optional (0 or 1)
/cal@id Optional (0 or 1) Type: String
Unique ID for data source
/cal@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/cal@l Optional (0 or 1) Type: String
Folder ID for data source
/cal@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/cal@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/cal@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/cal@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/cal@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/cal@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/cal@password Optional (0 or 1) Type: String
Login password for data source
/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).
/cal@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/cal@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/cal@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/cal@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/cal@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/cal@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/cal@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/cal@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/cal@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/cal@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/cal@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/cal@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/cal@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/cal@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/cal@failingSince Optional (0 or 1) Type: Long
Failing Since
/cal/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/cal/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source
/unknown Optional (0 or 1)
/unknown@id Optional (0 or 1) Type: String
Unique ID for data source
/unknown@name Optional (0 or 1) Type: String
Name for data source
e.g. "My IMAP Account"
/unknown@l Optional (0 or 1) Type: String
Folder ID for data source
/unknown@isEnabled Optional (0 or 1) Type: 0|1
Flag whether or not the data source is enabled
/unknown@importOnly Optional (0 or 1) Type: 0|1
indicates that this datasource is used for one way (incoming) import versus two-way sync
/unknown@host Optional (0 or 1) Type: String
Name of server
e.g. "imap.myisp.com"
/unknown@port Optional (0 or 1) Type: Integer
Port number of server
e.g. "143"
/unknown@connectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_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.
/unknown@username Optional (0 or 1) Type: String
Login string on {data-source-server}, for example a user name
/unknown@password Optional (0 or 1) Type: String
Login password for data source
/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).
/unknown@emailAddress Optional (0 or 1) Type: String
Email address for the data-source
/unknown@smtpEnabled Optional (0 or 1) Type: 0|1
Whether sending outbound mail using external SMTP server is enabled in this data source.
/unknown@smtpHost Optional (0 or 1) Type: String
Name of SMTP server
e.g. "smtp.myisp.com"
/unknown@smtpPort Optional (0 or 1) Type: Integer
Port number of SMTP server
e.g. "465"
/unknown@smtpConnectionType Optional (0 or 1) Type: cleartext | ssl | tls | tls_if_available
Which security layer to use for connecting to SMTP host associated with this data source.
/unknown@smtpAuthRequired Optional (0 or 1) Type: 0|1
Whether SMTP server associated with this data source requires authentication.
/unknown@smtpUsername Optional (0 or 1) Type: String
Login username for SMTP server
/unknown@smtpPassword Optional (0 or 1) Type: String
Login password for SMTP server
/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.
/unknown@defaultSignature Optional (0 or 1) Type: String
ID for default signature
/unknown@forwardReplySignature Optional (0 or 1) Type: String
Forward / Reply Signature ID for data source
/unknown@fromDisplay Optional (0 or 1) Type: String
Personal part of email address to put in the from header
/unknown@replyToAddress Optional (0 or 1) Type: String
Email address to put in the reply-to header
/unknown@replyToDisplay Optional (0 or 1) Type: String
Personal part of Email address to put in the reply-to header
/unknown@importClass Optional (0 or 1) Type: String
Data import class used bt this data source
/unknown@failingSince Optional (0 or 1) Type: Long
Failing Since
/unknown/lastError Optional (0 or 1) Type: {lastError} (String)
Last Error
/unknown/a Optional (0 or more) Type: {attributes} (String)
Properties for the data source

ModifyDataSourceResponse

    <ModifyDataSourceResponse /> ## ModifyDataSourceResponse

 
© Copyright 2025, The Zextras Team. All rights reserved.