Giter VIP home page Giter VIP logo

s3abird's Introduction

Build Status

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:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowBucketRead",
            "Effect": "Allow",
            "Action": [
                "s3:listBucket",
                "s3:getObject"
            ],
            "Resource": [
                "arn:aws:s3:::<your_bucket_name>",
                "arn:aws:s3:::<your_bucket_name>/*"
            ]
        }
    ]
}

A sufficient CORS policy can look like this:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
    <AllowedOrigin>*</AllowedOrigin>
    <AllowedMethod>GET</AllowedMethod>
    <AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>

Besides configuring an S3 bucket for reads you will probably want to configure SES 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.

.

s3abird's People

Contributors

mewa avatar tt-hars avatar

Watchers

James Cloos avatar

Forkers

brentcetinich

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.