Service: zimbraAdmin

Command: CreateDataSource
Namespace: urn:zimbraAdmin
Description: Creates a data source that imports mail items into the specified folder.
Notes: Example:
     <CreateDataSourceRequest/>
         <id>{existing-account-id}</id>
         <dataSource type="pop3" name="{data-source-name}">
             <a n="zimbraDataSourceName">My POP3 Account</a>
             <a n="zimbraDataSourceIsEnabled">TRUE</a>
             <a n="zimbraDataSourceHost">pop.myisp.com</a>
             <a n="zimbraDataSourcePort">110</a>
             <a n="zimbraDataSourceUsername">mylogin</a>
             <a n="zimbraDataSourcePassword">mypassword</a>
             <a n="zimbraDataSourceFolderId">{folder-id}</a>
        </dataSource>
     </CreateDataSourceRequest>
 
Properties:
Authorization token required true
Admin Authorization token required true

CreateDataSourceRequest

    <CreateDataSourceRequest id="{existing-account-id}"> ## CreateDataSourceRequest
        <dataSource
                       type="{data-source-type} (pop3 | imap | caldav | contacts | yab | rss | cal | gal | xsync | tagmap | unknown)"
                       name="{data-source-name}"> ## DataSourceSpecifier
            (<a n="{key}" /> ## Attr)*
        </dataSource>
    </CreateDataSourceRequest>

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

XPath Required / Optional Description
@id Required (only 1) Type: String
Id for an existing Account
/dataSource Required (only 1) Details of data source
/dataSource@type Required (only 1) Type: pop3 | imap | caldav | contacts | yab | rss | cal | gal | xsync | tagmap | unknown
Data source type
/dataSource@name Required (only 1) Type: String
Data source name
/dataSource/a Optional (0 or more) Attributes
/dataSource/a@n Required (only 1) Type: String
Key

CreateDataSourceResponse

    <CreateDataSourceResponse> ## CreateDataSourceResponse
        <dataSource name="{data-source-name}" id="{data-source-id}"
                       type="{data-source-type} (pop3 | imap | caldav | contacts | yab | rss | cal | gal | xsync | tagmap | unknown)"> ## DataSourceInfo
            (<a n="{key}" /> ## Attr)*
        </dataSource>
    </CreateDataSourceResponse>

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

XPath Required / Optional Description
/dataSource Required (only 1) Details of created data source
/dataSource@name Required (only 1) Type: String
Data source name
/dataSource@id Required (only 1) Type: String
Data source id
/dataSource@type Required (only 1) Type: pop3 | imap | caldav | contacts | yab | rss | cal | gal | xsync | tagmap | unknown
Data source type
/dataSource/a Optional (0 or more) Attributes
/dataSource/a@n Required (only 1) Type: String
Key