Dropbox Connector 1.0 Reference

Configurations


Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Oauth2 Connection Provider
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Token Access Type

String

offline

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

* true

Allow the deployment to fail.

* false

Ignore the results of the connectivity test.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://www.dropbox.com/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint.

https://api.dropboxapi.com/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance.

account_info.write, account_info.read, files.metadata.write, files.metadata.read, files.content.write, files.content.read, sharing.write, sharing.read, file_requests.write, file_requests.read, contacts.write, files.permanent_delete

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that will catch the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

File Requests Create

<dropbox:file-requests-create>

Creates a file request for this user. This operation makes an HTTP POST request to the /file_requests/create endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

File Requests Delete

<dropbox:file-requests-delete>

Deletes a batch of closed file requests. This operation makes an HTTP POST request to the /file_requests/delete endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

File Requests Get

<dropbox:file-requests-get>

Returns the specified file request. This operation makes an HTTP POST request to the /file_requests/get endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

File Requests List

<dropbox:file-requests-list>

Returns a list of file requests owned by this user. For apps with the app folder permission, this operation returns only file requests with destinations in the app folder. This operation makes an HTTP POST request to the /file_requests/list endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

File Requests Update

<dropbox:file-requests-update>

Updates a file request. This operation makes an HTTP POST request to the /file_requests/update endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Copy Batch V2

<dropbox:files-copy-batch-v2>

Copies multiple files or folders to different locations simultaneously in the user’s Dropbox. This operation replaces the copy_batch:1 route. The Files Copy Batch V2 operation route returns the status for each entry, while the copy_batch:1 route raises failure if any entry fails. The Files Copy Batch V2 operation either finishes synchronously, or returns a job ID and finishes asynchronously. Use the copy_batch/check:2 route to check the job status. This operation makes an HTTP POST request to the /files/copy_batch_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Copy V2

<dropbox:files-copy-v2>

Copies a file or folder to a different location in the user’s Dropbox. If the source path is a folder, all of the contents are copied. This operation makes an HTTP POST request to the /files/copy_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Create Folder V2

<dropbox:files-create-folder-v2>

Creates a folder at a given path. This operation makes an HTTP POST request to the /files/create_folder_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Delete Batch

<dropbox:files-delete-batch>

Deletes multiple files or folders simultaneously. This route is asynchronous, as it returns a job ID immediately and runs the delete batch asynchronously. Use the delete_batch/check route to check the job status. This operation makes an HTTP POST request to the /files/delete_batch endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Delete V2

<dropbox:files-delete-v2>

Deletes a file or a folder from a given path. If the path is a folder, all of its contents are deleted too. The response is successful once the file or folder is deleted. The returned metadata for the item is the corresponding FileMetadata or FolderMetadata object at the time of deletion, instead of a DeletedMetadata object. This operation makes an HTTP POST request to the /files/delete_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Download

<dropbox:files-download>

Downloads a file from a user’s Dropbox. This operation makes an HTTP POST request to the /files/download endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Dropbox API Arg

String

Dropbox API Arg.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files List Folder

<dropbox:files-list-folder>

Starts returning the contents of a folder. If the result’s ListFolderResult.has_more field is true, call list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries. This operation makes an HTTP POST request to the /files/list_folder endpoint.

If you are using ListFolderArg.recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them to keep your local state in sync:

  • For each FileMetadata, store the new entry at the given path in your local state. Create the required parent folders if they don’t exist yet. If there is already something else at the given path, replace it and remove all its children.

  • For each FolderMetadata, store the new entry at the given path in your local state. Create the required parent folders if they don’t exist yet. If there is already something else at the given path, replace it but leave the children as they are. Check the new entry’s FolderSharingInfo.read_only and set all its children’s read-only statuses to match.

  • For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there is nothing at the given path, ignore this entry.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files List Revisions

<dropbox:files-list-revisions>

Returns revisions for files based on a file path or a file ID. The file path or file ID is identified from the latest file entry at the given file path or ID. This end point enables your app to query either by file path or by file ID by setting the mode parameter appropriately. In the ListRevisionsMode.path (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file ID are desired, set the mode to ListRevisionsMode.id. Use the ListRevisionsMode.id mode to retrieve revisions for a given file across moves or renames. This operation makes an HTTP POST request to the /files/list_revisions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Move Batch V2

<dropbox:files-move-batch-v2>

Moves multiple files or folders to different locations simultaneously in the user’s Dropbox. This route is "all or nothing", which means if one entry fails, the whole transaction will abort. This route returns a job ID immediately and performs the asynchronous moving job in the background. Use move_batch/check to check the job status. This operation makes an HTTP POST request to the /files/move_batch_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

* Any * Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Move V2

<dropbox:files-move-v2>

Moves a file or folder to a different location in the user’s Dropbox. If the source path is a folder, all of its contents are moved. This operation makes an HTTP POST request to the /files/move_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Restore

<dropbox:files-restore>

Restores a file to a specific revision. This operation makes an HTTP POST request to the /files/restore endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Search V2

<dropbox:files-search-v2>

Searches for files and folders. Recent changes may not immediately be reflected in the search results due to a short delay in indexing. This operation makes an HTTP POST request to the /files/search_v2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Files Upload

<dropbox:files-upload>

Creates a new file with the contents provided in the request. Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start. This operation makes an HTTP POST request to the /files/upload endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Dropbox API Arg

String

Dropbox API Arg.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing Add File Member

<dropbox:sharing-add-file-member>

Adds specified members to a file. This operation makes an HTTP POST request to the /sharing/add_file_member endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing Add Folder Member

<dropbox:sharing-add-folder-member>

Enables an owner or editor (if the ACL update policy permits) of a shared folder to add another member. For the new member to get access to all of the functionality for this folder, call mount_folder on their behalf. Apps must have full Dropbox access to use this endpoint. This operation makes an HTTP POST request to the /sharing/add_folder_member endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing List File Members

<dropbox:sharing-list-file-members>

Obtains inherited and uninherited members who have been invited to a file. This operation makes an HTTP POST request to the /sharing/list_file_members endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing List Folder Members

<dropbox:sharing-list-folder-members>

Returns the shared folder membership by its folder ID. Apps must have full Dropbox access to use this endpoint. This operation makes an HTTP POST request to the /sharing/list_folder_members endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing Remove File Member2

<dropbox:sharing-remove-file-member2>

Removes a specified member from the file. This operation makes an HTTP POST request to the /sharing/remove_file_member_2 endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing Remove Folder Member

<dropbox:sharing-remove-folder-member>

Enables an owner or editor (if the ACL update policy permits) of a shared folder to remove another member. Apps must have full Dropbox access to use this endpoint. This operation makes an HTTP POST request to the /sharing/remove_folder_member endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sharing Share Folder

<dropbox:sharing-share-folder>

Shares a folder with collaborators. Most sharing is completed synchronously. Sharing large folders is completed asynchronously. To make testing the asynchronous case repeatable, set ShareFolderArg.force_async. If a ShareFolderLaunch.async_job_id is returned, call check_share_job_status until the action completes to get the metadata for the folder. Apps must have full Dropbox access to use this endpoint. This operation makes an HTTP POST request to the /sharing/share_folder endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<dropbox:unauthorize>

Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

For Configurations

Users Get Current Account

<dropbox:users-get-current-account>

Gets information about the current user’s account. This operation makes an HTTP POST request to the /users/get_current_account endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Users Get Space Usage

<dropbox:users-get-space-usage>

Gets the space usage information for the current user’s account. This operation makes an HTTP POST request to the /users/get_space_usage endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DROPBOX:BAD_REQUEST

  • DROPBOX:CLIENT_ERROR

  • DROPBOX:CONNECTIVITY

  • DROPBOX:INTERNAL_SERVER_ERROR

  • DROPBOX:NOT_ACCEPTABLE

  • DROPBOX:NOT_FOUND

  • DROPBOX:RETRY_EXHAUSTED

  • DROPBOX:SERVER_ERROR

  • DROPBOX:SERVICE_UNAVAILABLE

  • DROPBOX:TIMEOUT

  • DROPBOX:TOO_MANY_REQUESTS

  • DROPBOX:UNAUTHORIZED

  • DROPBOX:UNSUPPORTED_MEDIA_TYPE

Sources

On create or update file in folder

<dropbox:on-new-or-updated-file-in-folder-listener>

Initiates a flow when a file is created or updated in a folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Path

String

Unique ID for the file.

x

Recursive

Boolean

If true, the list folder operation is applied recursively to all subfolders and the response contains contents of all subfolders.

false

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Types

Default Header

Headers automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Default Query Param

Query parameters automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Proxy

Configures a proxy for outbound connections.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

Comma-separated list of hosts that the proxy must not be used against.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

Allow the deployment to fail.

  • false

Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

HTTP Response Attributes

Configures HTTP response attributes for the configuration.

Field Type Description Default Value Required

Status Code

Number

HTTP status code of the response.

x

Headers

Object

Map of HTTP headers in the message.

x

Reason Phrase

String

HTTP reason phrase of the response.

x

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.