Skip to content

S3 store

Configuration

Region

The S3 region where the bucket resides.

Settings of their own: see S3 store region. Name in the API: region.

Name

The S3 bucket where blobs (e-mail messages, Sieve scripts, etc.) will be stored.

Text. Name in the API: bucket.

Key Prefix

A prefix that will be added to the keys of all objects stored in the blob store.

Text. Name in the API: keyPrefix.

Reliability

Retries

The maximum number of times to retry failed requests. Set to 0 to disable retries.

A number. Default: 3. Name in the API: maxRetries.

Timeout

Connection timeout to the S3 service.

A length of time. Default: 30s. Name in the API: timeout.

Verify After Write

After each successful write, verify the object is readable on the backend. Defends against the rare case where an S3-compatible backend returns success but does not actually persist the data. Adds one extra request per write.

On or off. Default: On. Name in the API: verifyAfterWrite.

Authentication

Access Key

Identifies the S3 account.

Settings of their own: see Public string optional. Name in the API: accessKey.

Secret Key

The secret key for the S3 account.

Settings of their own: see Secret key optional. Name in the API: secretKey.

Security Token

Security token for temporary credentials.

Settings of their own: see Secret key optional. Name in the API: securityToken.

Session Token

Temporary session token for the S3 account.

Settings of their own: see Secret key optional. Name in the API: sessionToken.

Profile

Used when retrieving credentials from a shared credentials file. If specified, the server will use the access key ID, secret access key, and session token (if available) associated with the given profile.

Text. Name in the API: profile.

TLS

Allow Invalid Certs

Allow invalid TLS certificates when connecting to the S3 service.

On or off. Name in the API: allowInvalidCerts.