go-webdav

https://pkg.go.dev/github.com/emersion/go-webdav
Admin
A Go library that provides client and server implementations for WebDAV, CalDAV, and CardDAV...
Tokens:18,008
Snippets:199
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### LocalFileSystem.Mkdir

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Creates a new directory at the specified name. It returns an error if the operation failed.

```APIDOC
## LocalFileSystem.Mkdir

### Description
Creates a new directory at the specified name. It returns an error if the operation failed.

### Method
Mkdir

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **name** (string) - Required - The name of the directory to create.

### Response
#### Success Response
- **err** (error) - An error if the operation failed.
```

--------------------------------

### Client.Options

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Performs an OPTIONS request to discover server capabilities.

```APIDOC
## Client.Options

### Description
Performs an OPTIONS request to discover server capabilities.

### Signature
```go
func (c *Client) Options(ctx context.Context, path string) (classes map[string]bool, methods map[string]bool, err error)
```
```

--------------------------------

### Create CalDAV Backend Supplied HomeSet

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Factory function to create a new CalDAV BackendSuppliedHomeSet with the given path.

```go
func NewCalendarHomeSet(path string) webdav.BackendSuppliedHomeSet
```

--------------------------------

### Client.Create

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Creates a new file and returns a writer for its contents.

```APIDOC
## func (*Client) Create

### Description
Creates a file's contents.

### Signature
```go
func (c *Client) Create(ctx context.Context, name string) (io.WriteCloser, error)
```
```

--------------------------------

### Client.Mkdir

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Creates a new directory at the specified path.

```APIDOC
## func (*Client) Mkdir

### Description
Creates a new directory.

### Signature
```go
func (c *Client) Mkdir(ctx context.Context, name string) error
```
```

--------------------------------

### Client.Open

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Fetches the contents of a file and returns a reader.

```APIDOC
## func (*Client) Open

### Description
Fetches a file's contents.

### Signature
```go
func (c *Client) Open(ctx context.Context, name string) (io.ReadCloser, error)
```
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Creates a new WebDAV client.

```APIDOC
## NewClient

### Description
Creates a new WebDAV client.

### Signature
```go
func NewClient(c HTTPClient, endpoint string) (*Client, error)
```
```

--------------------------------

### LocalFileSystem.Create

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Creates a new file at the specified name with the given content from the body. It returns file information, a boolean indicating if the file was created, and an error if the operation failed.

```APIDOC
## LocalFileSystem.Create

### Description
Creates a new file at the specified name with the given content from the body. It returns file information, a boolean indicating if the file was created, and an error if the operation failed.

### Method
Create

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **name** (string) - Required - The name of the file to create.
- **body** (io.ReadCloser) - Required - The content of the file.
- **opts** (*CreateOptions) - Optional - Options for the create operation.

### Response
#### Success Response
- **fi** (*FileInfo) - Information about the created file.
- **created** (bool) - Indicates if the file was created.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### LocalFileSystem.Open

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Opens a file at the specified name for reading. It returns a ReadCloser for the file content and an error if the operation failed.

```APIDOC
## LocalFileSystem.Open

### Description
Opens a file at the specified name for reading. It returns a ReadCloser for the file content and an error if the operation failed.

### Method
Open

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **name** (string) - Required - The name of the file to open.

### Response
#### Success Response
- **ReadCloser** (io.ReadCloser) - A ReadCloser for the file content.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### Client.Do

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Executes an HTTP request using the WebDAV client.

```APIDOC
## Client.Do

### Description
Executes an HTTP request using the WebDAV client.

### Signature
```go
func (c *Client) Do(req *http.Request) (*http.Response, error)
```
```

--------------------------------

### LocalFileSystem

Source: https://pkg.go.dev/github.com/emersion/go-webdav

LocalFileSystem implements the FileSystem interface for the local filesystem.

```APIDOC
## LocalFileSystem

### Description
LocalFileSystem implements the FileSystem interface for the local filesystem.

### Methods
* **Copy(ctx context.Context, src, dst string, options *CopyOptions) (created bool, err error)**: Copies a file or directory.
* **Create(ctx context.Context, name string, body io.ReadCloser, opts *CreateOptions) (fi *FileInfo, created bool, err error)**: Creates a new file.
* **Mkdir(ctx context.Context, name string) error**: Creates a new directory.
* **Move(ctx context.Context, src, dst string, options *MoveOptions) (created bool, err error)**: Moves a file or directory.
* **Open(ctx context.Context, name string) (io.ReadCloser, error)**: Opens a file for reading.
* **ReadDir(ctx context.Context, name string, recursive bool) ([]FileInfo, error)**: Reads the contents of a directory.
* **RemoveAll(ctx context.Context, name string, opts *RemoveAllOptions) error**: Removes a file or directory and its contents.
* **Stat(ctx context.Context, name string) (*FileInfo, error)**: Returns file information for a given path.
```

--------------------------------

### Client.PropFind

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Performs a PROPFIND request to retrieve properties of a resource.

```APIDOC
## Client.PropFind

### Description
Performs a PROPFIND request to retrieve properties of a resource.

### Signature
```go
func (c *Client) PropFind(ctx context.Context, path string, depth Depth, propfind *PropFind) (*MultiStatus, error)
```
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Creates a new WebDAV client. If the provided HTTP client is nil, the default HTTP client is used. Basic authentication can be configured using HTTPClientWithBasicAuth.

```APIDOC
## func NewClient

### Description
Creates a new WebDAV client.
If the HTTPClient is nil, http.DefaultClient is used.
To use HTTP basic authentication, HTTPClientWithBasicAuth can be used.

### Signature
```go
func NewClient(c HTTPClient, endpoint string) (*Client, error)
```
```

--------------------------------

### Client.PropFindFlat

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Performs a PROPFIND request with zero depth.

```APIDOC
## Client.PropFindFlat

### Description
Performs a PROPFIND request with a zero depth.

### Signature
```go
func (c *Client) PropFindFlat(ctx context.Context, path string, propfind *PropFind) (*Response, error)
```
```

--------------------------------

### Client.DoMultiStatus

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Executes an HTTP request and expects a MultiStatus response.

```APIDOC
## Client.DoMultiStatus

### Description
Executes an HTTP request and expects a MultiStatus response.

### Signature
```go
func (c *Client) DoMultiStatus(req *http.Request) (*MultiStatus, error)
```
```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Provides methods for interacting with a WebDAV server, including creating requests, performing operations like PropFind and SyncCollection, and handling responses.

```APIDOC
## func NewClient(c HTTPClient, endpoint string) (*Client, error)

### Description
Creates a new WebDAV client.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{
  "example": "Not applicable for constructor"
}
```

### Response
#### Success Response (200)
- **Client** (*Client) - A pointer to the newly created Client.
- **error** (error) - An error if the client creation fails.

#### Response Example
```json
{
  "example": "Not applicable for constructor"
}
```
```

```APIDOC
## func (c *Client) Do(req *http.Request) (*http.Response, error)

### Description
Executes an HTTP request using the client.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **req** (*http.Request) - The HTTP request to execute.

### Request Example
```json
{
  "example": "Not applicable for direct method call, use http.NewRequest"
}
```

### Response
#### Success Response (200)
- **Response** (*http.Response) - The HTTP response from the server.
- **error** (error) - An error if the request fails.

#### Response Example
```json
{
  "example": "http.Response object"
}
```
```

```APIDOC
## func (c *Client) DoMultiStatus(req *http.Request) (*MultiStatus, error)

### Description
Executes an HTTP request and parses the response as a WebDAV Multi-Status.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **req** (*http.Request) - The HTTP request to execute.

### Request Example
```json
{
  "example": "Not applicable for direct method call, use http.NewRequest"
}
```

### Response
#### Success Response (200)
- **MultiStatus** (*MultiStatus) - The parsed Multi-Status response.
- **error** (error) - An error if the request or parsing fails.

#### Response Example
```json
{
  "example": "MultiStatus object"
}
```
```

```APIDOC
## func (c *Client) NewRequest(method string, path string, body io.Reader) (*http.Request, error)

### Description
Creates a new HTTP request for the WebDAV client.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **method** (string) - The HTTP method (e.g., "GET", "PROPFIND").
- **path** (string) - The path to the resource.
- **body** (io.Reader) - An optional request body.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **Request** (*http.Request) - The created HTTP request.
- **error** (error) - An error if the request creation fails.

#### Response Example
```json
{
  "example": "http.Request object"
}
```
```

```APIDOC
## func (c *Client) NewXMLRequest(method string, path string, v interface{}) (*http.Request, error)

### Description
Creates a new HTTP request with an XML request body, marshaling the provided value.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **method** (string) - The HTTP method (e.g., "PROPFIND").
- **path** (string) - The path to the resource.
- **v** (interface{}) - The value to marshal into the XML request body.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **Request** (*http.Request) - The created HTTP request.
- **error** (error) - An error if the request creation or marshaling fails.

#### Response Example
```json
{
  "example": "http.Request object"
}
```
```

```APIDOC
## func (c *Client) Options(ctx context.Context, path string) (classes map[string]bool, methods map[string]bool, err error)

### Description
Performs an HTTP OPTIONS request to discover server capabilities.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **ctx** (context.Context) - The request context.
- **path** (string) - The path to the resource.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **classes** (map[string]bool) - A map of supported classes.
- **methods** (map[string]bool) - A map of supported HTTP methods.
- **err** (error) - An error if the request fails.

#### Response Example
```json
{
  "example": "map[string]bool{"get": true}, map[string]bool{"OPTIONS": true}, nil"
}
```
```

```APIDOC
## func (c *Client) PropFind(ctx context.Context, path string, depth Depth, propfind *PropFind) (*MultiStatus, error)

### Description
Performs a PROPFIND request to retrieve properties of a resource.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **ctx** (context.Context) - The request context.
- **path** (string) - The path to the resource.
- **depth** (Depth) - The depth of the PROPFIND request.
- **propfind** (*PropFind) - The properties to retrieve.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **MultiStatus** (*MultiStatus) - The Multi-Status response containing properties.
- **error** (error) - An error if the request fails.

#### Response Example
```json
{
  "example": "MultiStatus object"
}
```
```

```APIDOC
## func (c *Client) PropFindFlat(ctx context.Context, path string, propfind *PropFind) (*Response, error)

### Description
Performs a PROPFIND request and returns a single response, suitable for non-collection resources.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **ctx** (context.Context) - The request context.
- **path** (string) - The path to the resource.
- **propfind** (*PropFind) - The properties to retrieve.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **Response** (*Response) - The response containing properties.
- **error** (error) - An error if the request fails.

#### Response Example
```json
{
  "example": "Response object"
}
```
```

```APIDOC
## func (c *Client) ResolveHref(p string) *url.URL

### Description
Resolves a given Href string into a URL.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **p** (string) - The Href string to resolve.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **URL** (*url.URL) - The resolved URL.

#### Response Example
```json
{
  "example": "url.URL object"
}
```
```

```APIDOC
## func (c *Client) SyncCollection(ctx context.Context, path, syncToken string, level Depth, limit *Limit, ...) (*MultiStatus, error)

### Description
Performs a SYNC-COLLECTION request to synchronize changes in a collection.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **ctx** (context.Context) - The request context.
- **path** (string) - The path to the collection.
- **syncToken** (string) - The synchronization token.
- **level** (Depth) - The depth of the synchronization.
- **limit** (*Limit) - An optional limit for the synchronization.

### Request Example
```json
{
  "example": "Not applicable for direct method call"
}
```

### Response
#### Success Response (200)
- **MultiStatus** (*MultiStatus) - The Multi-Status response containing synchronization information.
- **error** (error) - An error if the request fails.

#### Response Example
```json
{
  "example": "MultiStatus object"
}
```
```

--------------------------------

### Handler.ServeHTTP

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Serves CalDAV requests using the provided http.ResponseWriter and http.Request. This is the main entry point for a CalDAV server.

```APIDOC
## func (h *Handler) ServeHTTP

### Description
Serves CalDAV requests using the provided http.ResponseWriter and http.Request. This is the main entry point for a CalDAV server.

### Signature
```go
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
None

#### Response Example
None
```

--------------------------------

### PropFind Struct Definition

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Represents a WebDAV PROPFIND request body. Used to specify which properties to retrieve.

```go
type PropFind struct {
  XMLName  xml.Name  `xml:"DAV: propfind"`
  Prop     *Prop     `xml:"prop,omitempty"`
  AllProp  *struct{} `xml:"allprop,omitempty"`
  Include  *Include  `xml:"include,omitempty"`
  PropName *struct{} `xml:"propname,omitempty"`
}
```

--------------------------------

### ServeMultiStatus

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Sends a WebDAV Multi-Status response.

```APIDOC
## ServeMultiStatus

### Description
Sends a WebDAV Multi-Status response.

### Signature
```go
func ServeMultiStatus(w http.ResponseWriter, ms *MultiStatus) error
```
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Creates a new CalDAV client instance. It requires an HTTP client and the server endpoint.

```APIDOC
## NewClient

### Description
Creates a new CalDAV client instance. It requires an HTTP client and the server endpoint.

### Signature
```go
func NewClient(c webdav.HTTPClient, endpoint string) (*Client, error)
```
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Creates a new CalDAV client. It requires an HTTP client and the CalDAV server endpoint URL.

```APIDOC
## func NewClient

### Description
Creates a new CalDAV client. It requires an HTTP client and the CalDAV server endpoint URL.

### Signature
```go
func NewClient(c webdav.HTTPClient, endpoint string) (*Client, error)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **Client** (*Client) - A pointer to the newly created CalDAV client.
- **error** (error) - An error if the client creation fails.

#### Response Example
None
```

--------------------------------

### LocalFileSystem.Stat

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Returns information about a file or directory at the specified name. It returns a FileInfo pointer and an error if the operation failed.

```APIDOC
## LocalFileSystem.Stat

### Description
Returns information about a file or directory at the specified name. It returns a FileInfo pointer and an error if the operation failed.

### Method
Stat

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **name** (string) - Required - The name of the file or directory to stat.

### Response
#### Success Response
- **fi** (*FileInfo) - A FileInfo pointer with information about the file or directory.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### Depth Constants

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Defines constants for Depth: DepthZero (resource only), DepthOne (resource and immediate members), and DepthInfinity (resource and all members).

```go
const (
	// DepthZero indicates that the request applies only to the resource.
	DepthZero Depth = 0
	// DepthOne indicates that the request applies to the resource and its
	// internal members only.
	DepthOne Depth = 1
	// DepthInfinity indicates that the request applies to the resource and all
	// of its members.
	DepthInfinity Depth = -1
)
```

--------------------------------

### Client.Move

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Moves a file or directory from one location to another.

```APIDOC
## func (*Client) Move

### Description
Moves a file.

### Signature
```go
func (c *Client) Move(ctx context.Context, name, dest string, options *MoveOptions) error
```
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/github.com/emersion/go-webdav/carddav

Creates a new CardDAV client instance. It requires an HTTP client and the endpoint URL of the CardDAV server.

```APIDOC
## NewClient

### Description
Creates a new CardDAV client instance. It requires an HTTP client and the endpoint URL of the CardDAV server.

### Signature
```go
func NewClient(c webdav.HTTPClient, endpoint string) (*Client, error)
```
```

--------------------------------

### DiscoverContextURL

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Performs DNS-based CalDAV service discovery as described in RFC 6352 section 11. Returns the URL to the CalDAV server.

```APIDOC
## func DiscoverContextURL

### Description
Performs DNS-based CalDAV service discovery as described in RFC 6352 section 11. Returns the URL to the CalDAV server.

### Signature
```go
func DiscoverContextURL(ctx context.Context, domain string) (string, error)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **string** (string) - The discovered CalDAV server URL.
- **error** (error) - An error if the discovery fails.

#### Response Example
None
```

--------------------------------

### ServeXML

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Creates an XML encoder for writing WebDAV XML responses.

```APIDOC
## ServeXML

### Description
Creates an XML encoder for writing WebDAV XML responses.

### Signature
```go
func ServeXML(w http.ResponseWriter) *xml.Encoder
```
```

--------------------------------

### ServeHTTP

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Implements the http.Handler interface for the CalDAV handler, allowing it to serve CalDAV HTTP requests.

```APIDOC
## ServeHTTP

### Description
Implements the http.Handler interface for the CalDAV handler, allowing it to serve CalDAV HTTP requests.

### Signature
```go
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
```
```

--------------------------------

### Client.MultiGetAddressBook

Source: https://pkg.go.dev/github.com/emersion/go-webdav/carddav

Retrieves multiple address objects from a specified path using a multi-get request. This is an efficient way to fetch several address objects at once.

```APIDOC
## MultiGetAddressBook

### Description
Retrieves multiple address objects from a specified path using a multi-get request. This is an efficient way to fetch several address objects at once.

### Signature
```go
func (c *Client) MultiGetAddressBook(ctx context.Context, path string, multiGet *AddressBookMultiGet) ([]AddressObject, error)
```
```

--------------------------------

### Client.Stat

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Fetches FileInfo for a single file, providing details like size, modification time, and type.

```APIDOC
## func (*Client) Stat

### Description
Fetches a FileInfo for a single file.

### Signature
```go
func (c *Client) Stat(ctx context.Context, name string) (*FileInfo, error)
```
```

--------------------------------

### Include Struct Definition

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Represents the DAV: include element, used in PROPFIND requests.

```go
type Include struct {
	XMLName xml.Name      `xml:"DAV: include"`
	Raw     []RawXMLValue `xml:",any"`
}
```

--------------------------------

### Client

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Client provides access to a remote WebDAV filesystem. It allows for various operations on the remote filesystem.

```APIDOC
## Client

### Description
Client provides access to a remote WebDAV filesystem.

### Methods
* **NewClient(c HTTPClient, endpoint string) (*Client, error)**: Creates a new client for a remote WebDAV filesystem.
* **Copy(ctx context.Context, name, dest string, options *CopyOptions) error**: Copies a file or directory.
* **Create(ctx context.Context, name string) (io.WriteCloser, error)**: Creates a new file.
* **FindCurrentUserPrincipal(ctx context.Context) (string, error)**: Finds the current user's principal.
* **Mkdir(ctx context.Context, name string) error**: Creates a new directory.
* **Move(ctx context.Context, name, dest string, options *MoveOptions) error**: Moves a file or directory.
* **Open(ctx context.Context, name string) (io.ReadCloser, error)**: Opens a file for reading.
* **ReadDir(ctx context.Context, name string, recursive bool) ([]FileInfo, error)**: Reads the contents of a directory.
* **RemoveAll(ctx context.Context, name string) error**: Removes a file or directory and its contents.
* **Stat(ctx context.Context, name string) (*FileInfo, error)**: Returns file information for a given path.
```

--------------------------------

### HTTPClientWithBasicAuth

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Returns an HTTP client that automatically adds basic authentication credentials to all outgoing requests. If the provided client is nil, http.DefaultClient is used.

```APIDOC
## func HTTPClientWithBasicAuth

### Description
Returns an HTTP client that adds basic authentication to all outgoing requests. If c is nil, http.DefaultClient is used.

### Signature
```go
func HTTPClientWithBasicAuth(c HTTPClient, username, password string) HTTPClient
```
```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/emersion/go-webdav/carddav

The Client provides methods to interact with a remote CardDAV server. These include finding address book home sets, retrieving address books and objects, and performing synchronization.

```APIDOC
## Client Methods

### Description
The `Client` struct provides methods for interacting with a remote CardDAV server. It allows for discovering server capabilities, finding address books, and retrieving/modifying address objects.

### Methods
- `NewClient(c webdav.HTTPClient, endpoint string) (*Client, error)`: Constructs a new CardDAV client.
- `FindAddressBookHomeSet(ctx context.Context, principal string) (string, error)`: Finds the address book home set for a given principal.
- `FindAddressBooks(ctx context.Context, addressBookHomeSet string) ([]AddressBook, error)`: Finds all address books within a specified home set.
- `GetAddressObject(ctx context.Context, path string) (*AddressObject, error)`: Retrieves a specific address object by its path.
- `HasSupport(ctx context.Context) error`: Checks if the server supports required CardDAV features.
- `MultiGetAddressBook(ctx context.Context, path string, multiGet *AddressBookMultiGet) ([]AddressObject, error)`: Retrieves multiple address objects from a specified path using a multi-get request.
- `PutAddressObject(ctx context.Context, path string, card vcard.Card) (*AddressObject, error)`: Puts (creates or updates) an address object at the specified path with the given vCard data.
- `QueryAddressBook(ctx context.Context, addressBook string, query *AddressBookQuery) ([]AddressObject, error)`: Queries address objects within a specific address book based on a query.
- `SyncCollection(ctx context.Context, path string, query *SyncQuery) (*SyncResponse, error)`: Performs a collection synchronization operation on the specified resource.
```

--------------------------------

### DiscoverContextURL

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Performs DNS-based CardDAV/CalDAV service discovery to find the server's URL.

```APIDOC
## DiscoverContextURL

### Description
Performs a DNS-based CardDAV/CalDAV service discovery as described in RFC 6764. It returns the URL to the CardDAV/CalDAV server. Specifically, it implements points 2 and 3 from the bootstrapping procedure defined in RFC 6764 section 6.

### Signature
```go
func DiscoverContextURL(ctx context.Context, service, domain string) (string, error)
```
```

--------------------------------

### LocalFileSystem.Copy

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Copies a file or directory from a source path to a destination path. It returns a boolean indicating if the destination was created and an error if the operation failed.

```APIDOC
## LocalFileSystem.Copy

### Description
Copies a file or directory from a source path to a destination path. It returns a boolean indicating if the destination was created and an error if the operation failed.

### Method
Copy

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **src** (string) - Required - The source path.
- **dst** (string) - Required - The destination path.
- **options** (*CopyOptions) - Optional - Options for the copy operation.

### Response
#### Success Response
- **created** (bool) - Indicates if the destination was created.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### LocalFileSystem.Move

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Moves a file or directory from a source path to a destination path. It returns a boolean indicating if the destination was created and an error if the operation failed.

```APIDOC
## LocalFileSystem.Move

### Description
Moves a file or directory from a source path to a destination path. It returns a boolean indicating if the destination was created and an error if the operation failed.

### Method
Move

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **src** (string) - Required - The source path.
- **dst** (string) - Required - The destination path.
- **options** (*MoveOptions) - Optional - Options for the move operation.

### Response
#### Success Response
- **created** (bool) - Indicates if the destination was created.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### Client.Copy

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Copies a file or directory. By default, if the source is a directory, all its descendants are recursively copied.

```APIDOC
## func (*Client) Copy

### Description
Copies a file.
By default, if the file is a directory, all descendants are recursively copied as well.

### Signature
```go
func (c *Client) Copy(ctx context.Context, name, dest string, options *CopyOptions) error
```
```

--------------------------------

### DiscoverContextURL

Source: https://pkg.go.dev/github.com/emersion/go-webdav/carddav

Performs DNS-based CardDAV service discovery as described in RFC 6352 section 11. It returns the URL to the CardDAV server.

```APIDOC
## DiscoverContextURL

### Description
Performs DNS-based CardDAV service discovery as described in RFC 6352 section 11. It returns the URL to the CardDAV server.

### Signature
```go
func DiscoverContextURL(ctx context.Context, domain string) (string, error)
```
```

--------------------------------

### CalDAV Capability Constant

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Defines the capability string for CalDAV access, used to indicate server support for calendar-related operations.

```go
var CapabilityCalendar = webdav.Capability("calendar-access")
```

--------------------------------

### Client.ReadDir

Source: https://pkg.go.dev/github.com/emersion/go-webdav

Lists files and directories within a specified directory. The recursive flag determines whether to list contents of subdirectories.

```APIDOC
## func (*Client) ReadDir

### Description
Lists files in a directory.

### Signature
```go
func (c *Client) ReadDir(ctx context.Context, name string, recursive bool) ([]FileInfo, error)
```
```

--------------------------------

### Backend.CalendarHomeSetPath

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Returns the path to the Calendar Home Set for the backend.

```APIDOC
## func (b *Backend) CalendarHomeSetPath

### Description
Returns the path to the Calendar Home Set for the backend.

### Signature
```go
func (b *Backend) CalendarHomeSetPath(ctx context.Context) (string, error)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **string** (string) - The path to the Calendar Home Set.
- **error** (error) - An error if the path cannot be retrieved.

#### Response Example
None
```

--------------------------------

### NewCalendarHomeSet

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Creates a new webdav.BackendSuppliedHomeSet for a CalDAV backend, typically used to represent the root path for calendars.

```APIDOC
## func NewCalendarHomeSet

### Description
Creates a new webdav.BackendSuppliedHomeSet for a CalDAV backend, typically used to represent the root path for calendars.

### Signature
```go
func NewCalendarHomeSet(path string) webdav.BackendSuppliedHomeSet
```

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to be used for the HomeSet.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **webdav.BackendSuppliedHomeSet** (webdav.BackendSuppliedHomeSet) - The created BackendSuppliedHomeSet.

#### Response Example
None
```

--------------------------------

### Client.NewRequest

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Creates a new HTTP request for the WebDAV client.

```APIDOC
## Client.NewRequest

### Description
Creates a new HTTP request for the WebDAV client.

### Signature
```go
func (c *Client) NewRequest(method string, path string, body io.Reader) (*http.Request, error)
```
```

--------------------------------

### Depth String Method

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Formats the Depth type into its string representation for use in headers.

```go
func (d Depth) String() string
```

--------------------------------

### Match Calendar Object with Query

Source: https://pkg.go.dev/github.com/emersion/go-webdav/caldav

Checks if a given CalendarObject satisfies the specified CompFilter query. Returns a boolean indicating a match and any potential error.

```go
func Match(query CompFilter, co *CalendarObject) (matched bool, err error)
```

--------------------------------

### Type Definitions

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Defines the core types used in the WebDAV client, including Backend, Client, Depth, ETag, and MultiStatus.

```APIDOC
## type Backend

### Description
Represents the backend interface for a WebDAV server. This is an interface that users would implement to provide custom WebDAV storage.

### Methods
- None directly callable by the client user, but methods on `Client` interact with a `Backend`.

### Example
```go
// Example of implementing the Backend interface (not directly callable via client API)
// type MyBackend struct {}
// func (b MyBackend) ...
```
```

```APIDOC
## type Client

### Description
Represents a WebDAV client. Use `NewClient` to create an instance.

### Methods
- `Do(req *http.Request) (*http.Response, error)`
- `DoMultiStatus(req *http.Request) (*MultiStatus, error)`
- `NewRequest(method string, path string, body io.Reader) (*http.Request, error)`
- `NewXMLRequest(method string, path string, v interface{}) (*http.Request, error)`
- `Options(ctx context.Context, path string) (classes map[string]bool, methods map[string]bool, err error)`
- `PropFind(ctx context.Context, path string, depth Depth, propfind *PropFind) (*MultiStatus, error)`
- `PropFindFlat(ctx context.Context, path string, propfind *PropFind) (*Response, error)`
- `ResolveHref(p string) *url.URL`
- `SyncCollection(ctx context.Context, path, syncToken string, level Depth, limit *Limit, ...) (*MultiStatus, error)`
```

```APIDOC
## type Depth

### Description
Represents the depth of a WebDAV request (0, 1, or Infinity).

### Methods
- `ParseDepth(s string) (Depth, error)`: Parses a string into a Depth value.
- `String() string`: Returns the string representation of the Depth.

### Example
```go
// depth, err := ParseDepth("1")
// if err == nil {
//     fmt.Println(depth.String()) // Output: "1"
// }
```
```

```APIDOC
## type ETag

### Description
Represents an ETag value, used for conditional requests.

### Methods
- `MarshalText() ([]byte, error)`: Marshals the ETag to text.
- `String() string`: Returns the string representation of the ETag.
- `UnmarshalText(b []byte) error`: Unmarshals text into an ETag.

### Example
```go
// var etag ETag
// err := etag.UnmarshalText([]byte("\"abcdef\""))
// if err == nil {
//     fmt.Println(etag.String()) // Output: "\"abcdef\""
// }
```
```

```APIDOC
## type HTTPClient

### Description
An interface representing an HTTP client. The `Client` type uses this interface.

### Methods
- Typically matches `http.Client`'s `Do` method signature: `Do(req *http.Request) (*http.Response, error)`.

### Example
```go
// var httpClient http.Client // Satisfies the HTTPClient interface
```
```

```APIDOC
## type HTTPError

### Description
Represents an HTTP error encountered during a WebDAV request.

### Methods
- `HTTPErrorFromError(err error) *HTTPError`: Creates an `HTTPError` from a given error.
- `HTTPErrorf(code int, format string, a ...interface{}) *HTTPError`: Creates an `HTTPError` with a specific status code and message.
- `Error() string`: Returns the error message.
- `Unwrap() error`: Returns the underlying error.

### Example
```go
// err := HTTPErrorf(404, "Resource not found")
// if httpErr, ok := err.(*HTTPError); ok {
//     fmt.Println(httpErr.Error()) // Output: "404 Resource not found"
// }
```
```

```APIDOC
## type Handler

### Description
Represents a WebDAV handler. Used for serving WebDAV requests.

### Methods
- `ServeHTTP(w http.ResponseWriter, r *http.Request)`: Handles an incoming HTTP request.

### Example
```go
// var handler Handler
// http.Handle("/dav/", handler)
```
```

```APIDOC
## type Href

### Description
Represents an Href value in WebDAV, typically a URL.

### Methods
- `MarshalText() ([]byte, error)`: Marshals the Href to text.
- `String() string`: Returns the string representation of the Href.
- `UnmarshalText(b []byte) error`: Unmarshals text into an Href.

### Example
```go
// var href Href
// err := href.UnmarshalText([]byte("/files/doc.txt"))
// if err == nil {
//     fmt.Println(href.String()) // Output: "/files/doc.txt"
// }
```
```

```APIDOC
## type MultiStatus

### Description
Represents a WebDAV Multi-Status response, containing multiple responses for different resources.

### Methods
- `NewMultiStatus(resps ...Response) *MultiStatus`: Creates a new Multi-Status object.

### Example
```go
// ms := NewMultiStatus(Response{...})
```
```

```APIDOC
## type Prop

### Description
Represents a WebDAV PROPPATCH property.

### Methods
- `EncodeProp(values ...interface{}) (*Prop, error)`: Encodes values into a Prop object.
- `Decode(v interface{}) error`: Decodes the property into a given interface.
- `Get(name xml.Name) *RawXMLValue`: Retrieves a raw XML value by its name.

### Example
```go
// prop, err := EncodeProp(DisplayName{"My File"})
// if err == nil {
//     var dn DisplayName
//     err := prop.Decode(&dn)
// }
```
```

```APIDOC
## type PropFind

### Description
Represents a WebDAV PROPFIND request body.

### Methods
- `NewPropNamePropFind(names ...xml.Name) *PropFind`: Creates a PropFind request for specific property names.

### Example
```go
// propFind := NewPropNamePropFind(xml.Name{Space: "DAV:", Local: "getlastmodified"})
```
```

```APIDOC
## type PropFindFunc

### Description
A function type used in `PropFindValue` to dynamically provide property values.

### Methods
- `PropFindValue(value interface{}) PropFindFunc`: Creates a PropFindFunc from a value.

### Example
```go
// propFindFunc := PropFindValue("some value")
```
```

```APIDOC
## type PropStat

### Description
Represents a WebDAV property status, combining a property with its status code.

### Example
```go
// propStat := PropStat{...
```
```

```APIDOC
## type PropertyUpdate

### Description
Represents a WebDAV property update operation (SET or REMOVE).

### Example
```go
// propUpdate := PropertyUpdate{...
```
```

```APIDOC
## type RawXMLValue

### Description
Represents a raw XML element, allowing for unmarshaling and marshaling of arbitrary XML content.

### Methods
- `EncodeRawXMLElement(v interface{}) (*RawXMLValue, error)`: Encodes an interface into a RawXMLValue.
- `NewRawXMLElement(name xml.Name, attr []xml.Attr, children []RawXMLValue) *RawXMLValue`: Creates a new RawXMLValue.
- `Decode(v interface{}) error`: Decodes the raw XML into a given interface.
- `MarshalXML(e *xml.Encoder, start xml.StartElement) error`: Marshals the RawXMLValue to XML.
- `TokenReader() xml.TokenReader`: Returns an XML token reader.
- `UnmarshalXML(d *xml.Decoder, start xml.StartElement) error`: Unmarshals XML into the RawXMLValue.
- `XMLName() (name xml.Name, ok bool)`: Returns the XML name of the element.

### Example
```go
// var rawXML RawXMLValue
// err := rawXML.Decode(&someStruct)
```
```

```APIDOC
## type Remove

### Description
Represents the REMOVE operation within a WebDAV PROPPATCH request.

### Example
```go
// remove := Remove{...
```
```

```APIDOC
## type ResourceType

### Description
Represents the DAV:resourcetype property, indicating the type of resource (e.g., collection).

### Methods
- `NewResourceType(names ...xml.Name) *ResourceType`: Creates a new ResourceType.
- `Is(name xml.Name) bool`: Checks if the resource type matches a given XML name.

### Example
```go
// rt := NewResourceType(xml.Name{Space: "DAV:", Local: "collection"})
// if rt.Is(xml.Name{Space: "DAV:", Local: "collection"}) {
//     fmt.Println("It's a collection")
// }
```
```

```APIDOC
## type Response

### Description
Represents a single response within a WebDAV Multi-Status or PROPFIND result.

### Methods
- `NewErrorResponse(path string, err error) *Response`: Creates an error response.
- `NewOKResponse(path string) *Response`: Creates a successful OK response.
- `NewPropFindResponse(path string, propfind *PropFind, props map[xml.Name]PropFindFunc) (*Response, error)`: Creates a PROPFIND response.
- `DecodeProp(values ...interface{}) error`: Decodes properties from the response.
- `EncodeProp(code int, v interface{}) error`: Encodes properties into the response.
- `Err() error`: Returns any error associated with the response.
- `Path() (string, error)`: Returns the path of the resource for this response.

### Example
```go
// resp := NewOKResponse("/file.txt")
// path, _ := resp.Path()
```
```

```APIDOC
## type Set

### Description
Represents the SET operation within a WebDAV PROPPATCH request.

### Example
```go
// set := Set{...
```
```

```APIDOC
## type Status

### Description
Represents a WebDAV status code.

### Methods
- `Err() error`: Returns an error representation of the status.
- `MarshalText() ([]byte, error)`: Marshals the status to text.
- `UnmarshalText(b []byte) error`: Unmarshals text into a status.

### Example
```go
// var status Status
// err := status.UnmarshalText([]byte("200 OK"))
```
```

```APIDOC
## type SyncCollectionQuery

### Description
Represents the parameters for a SYNC-COLLECTION request.

### Example
```go
// syncQuery := SyncCollectionQuery{...
```
```

```APIDOC
## type Time

### Description
Represents a WebDAV time value.

### Methods
- `MarshalText() ([]byte, error)`: Marshals the time to text.
- `UnmarshalText(b []byte) error`: Unmarshals text into a time value.

### Example
```go
// var t Time
// err := t.UnmarshalText([]byte("2023-10-27T10:00:00Z"))
```
```

--------------------------------

### NewAddressBookHomeSet

Source: https://pkg.go.dev/github.com/emersion/go-webdav/carddav

Creates a new instance of a backend-supplied home set for an address book. This is typically used in server-side implementations.

```APIDOC
## NewAddressBookHomeSet

### Description
Creates a new instance of a backend-supplied home set for an address book. This is typically used in server-side implementations.

### Signature
```go
func NewAddressBookHomeSet(path string) webdav.BackendSuppliedHomeSet
```
```

--------------------------------

### ServeError

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Sends a WebDAV error response.

```APIDOC
## ServeError

### Description
Sends a WebDAV error response.

### Signature
```go
func ServeError(w http.ResponseWriter, err error)
```
```

--------------------------------

### Prop Struct Definition

Source: https://pkg.go.dev/github.com/emersion/go-webdav/internal

Represents the DAV: prop element, used for requesting or returning properties of a resource.

```go
type Prop struct {
	XMLName xml.Name      `xml:"DAV: prop"`
	Raw     []RawXMLValue `xml:",any"`
}
```
Tokens:
Raw