https://github.com/mewa/s3abird

Webmail client for emails stored on S3
https://github.com/mewa/s3abird

Last synced: about 5 hours ago
JSON representation

Webmail client for emails stored on S3

• Host: GitHub
• URL: https://github.com/mewa/s3abird
• Owner: mewa
• License: mit
• Created: 2019-01-11T17:14:36.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-28T15:30:45.000Z (11 months ago)
• Last Synced: 2024-08-13T07:18:28.548Z (3 months ago)
• Language: Vue
• Homepage: https://marcinchmiel.com/s3abird/
• Size: 1.44 MB
• Stars: 59
• Watchers: 3
• Forks: 20
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mewa/s3abird - Webmail client for emails stored on S3 (Vue)

README

        
[![Build Status](https://travis-ci.org/mewa/s3abird.svg?branch=master)](https://travis-ci.org/mewa/s3abird)

# What is s3abird?

It's a webmail client for viewing emails stored on AWS S3 buckets.

The purpose of this project is to give an easy interface to browse

through emails received via AWS SES and stored on S3 buckets, although

it will work on any buckets containing raw emails.

# Setup

There are several steps required to make _s3abird_ work.

* creating an S3 bucket

* creating credentials that have read access to this bucket

* setting proper CORS policy

IAM policy granting read access:

```json

{

    "Version": "2012-10-17",

    "Statement": [

        {

            "Sid": "AllowBucketRead",

            "Effect": "Allow",

            "Action": [

                "s3:listBucket",

                "s3:getObject"

            ],

            "Resource": [

                "arn:aws:s3:::",

                "arn:aws:s3:::/*"

            ]

        }

    ]

}

```

A sufficient CORS policy can look like this:

```xml

    *

    GET

    *

```

Besides configuring an S3 bucket for reads you will probably want to

[configure

SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-getting-started.html)

so that it can store incoming messages in this bucket.

# Roadmap

The following features are likely to be integrated soon into s3abird.

* integrate SES so that it's possible to reply to emails or write new

  ones

* modularise email storage and sending so that it's possible to use

  other providers

# Contributing

Feel free to submit pull requests - doesn't have to be limited to just the features on

the roadmap.

If there are particular features you would like to see you can also

[submit a ticket](https://github.com/mewa/s3abird/issues/new).