Amazon S3

storage.blob.s3 module stores messages bodies in a bucket on S3-compatible storage.

storage.blob.s3 {
    secure yes
    access_key "Q3AM3UQ867SPQQA43P2F"
    secret_key "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
    bucket maddy-test

    # optional
    region eu-central-1
    object_prefix maddy/
    creds access_key


storage.imapsql local_mailboxes {
    msg_store s3 {
        access_key "..."
        secret_key "..."
        bucket maddy-messages
        region us-west-2
        creds access_key

Configuration directives

Syntax: endpoint _address:port_


Root S3 endpoint. e.g.

Syntax: secure boolean
Default: yes

Whether TLS should be used.

Syntax: access_key string
Syntax: secret_key _string_


Static S3 credentials.

Syntax: bucket _name_


S3 bucket name. The bucket must exist and be read-writable.

Syntax: region string
Default: not set

S3 bucket location. May be called "endpoint" in some manuals.

Syntax: object_prefix string
Default: empty string

String to add to all keys stored by maddy.

Can be useful when S3 is used as a file system.

Syntax: creds string
Default: access_key

Credentials to use for accessing the S3 Bucket.

Credential Types: - access_key: use AWS access key and secret access key - file_minio: use credentials for Minio present at ~/.mc/config.json - file_aws: use credentials for AWS S3 present at ~/.aws/credentials - iam: use AWS IAM instance profile for credentials.

By default, access_key is used with the access key and secret access key present in the config.