Skip to content

Commit 9bb1bf5

Browse files
AmirhosseinOlyaeidevin-ai-integration[bot]
AmirhosseinOlyaei
and
devin-ai-integration[bot]
committed
Initial release: self-hosted mail + calendar on Cloudflare Workers
Inbound email via Email Routing + D1 storage, outbound via send_email, RFC 5546 calendar invites (REQUEST/REPLY/CANCEL), independent calendar, built-in dark UI, one-command install.sh, unified wrangler.jsonc config. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
0 parents  commit 9bb1bf5

26 files changed

Lines changed: 6799 additions & 0 deletions

‎.dev.vars.example‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Copy to .dev.vars for local dev (`npm run dev`).
2+
# For production set each with: wrangler secret put <NAME>
3+
# (or CLOUDFLARE_API_TOKEN-provisioned via scripts/setup.mjs --secrets)
4+
5+
# Password for the web UI login (required)
6+
UI_PASSWORD=change-me-strong-password
7+
8+
# HMAC key for signing session cookies (required; any long random string)
9+
SESSION_SECRET=change-me-long-random-string

‎.github/workflows/deploy.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Deploy devarts-mail
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-node@v4
14+
with:
15+
node-version: 22
16+
cache: npm
17+
- run: npm ci
18+
- run: npm test
19+
- run: npx wrangler d1 migrations apply devarts-mail --remote
20+
env:
21+
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
22+
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
23+
- run: npx wrangler deploy
24+
env:
25+
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
26+
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
node_modules/
2+
.wrangler/
3+
.dev.vars
4+
.env
5+
dist/
6+
*.tsbuildinfo
7+
.DS_Store
8+
worker-configuration.d.ts
9+
.playwright-mcp/

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<div align="center">
2+
3+
# 📮 devarts-mail
4+
5+
**Self-hosted email + calendar — entirely on Cloudflare.**
6+
No Google. No iCloud. No third-party mail service.
7+
8+
[![Deploy](https://github.com/DevArtsLab/devarts-mail/actions/workflows/deploy.yml/badge.svg)](https://github.com/DevArtsLab/devarts-mail/actions/workflows/deploy.yml)
9+
[![Cloudflare Workers](https://img.shields.io/badge/Cloudflare-Workers-F6821F?logo=cloudflare&logoColor=white)](https://workers.cloudflare.com/)
10+
[![D1](https://img.shields.io/badge/Storage-D1%20SQLite-blue)](https://developers.cloudflare.com/d1/)
11+
[![License](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
12+
13+
</div>
14+
15+
---
16+
17+
## ✨ What it does
18+
19+
| | |
20+
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
21+
| 📥 **Inbound email** | Email Routing → Worker `email()` handler → parsed & stored in D1 |
22+
| 📤 **Outbound email** | Send real mail as `you@yourdomain.com` via the `send_email` binding |
23+
| 📅 **Calendar invites** | Parses `text/calendar`, RSVP **Yes / Maybe / No** sends a real iCal `METHOD:REPLY` — organizers see `you@yourdomain.com: Accepted` |
24+
| 🗓️ **Independent calendar** | Create/edit/delete events in your own calendar, send `REQUEST`/`CANCEL` invites, import `.ics` anywhere |
25+
| ⏰ **Reminders** | Cron trigger emails you before events |
26+
| 🔐 **Auth** | Password login, HMAC-signed session cookie |
27+
| 🖥️ **UI** | Minimal dark interface — Inbox, Sent, Compose, Month-view Calendar |
28+
29+
![screenshot](docs/screenshot.png)
30+
31+
```mermaid
32+
flowchart LR
33+
A[📧 Someone emails<br/>you@yourdomain.com] -->|Email Routing| W[☁️ Worker]
34+
W -->|parse + store| DB[(D1)]
35+
UI[🖥️ Built-in UI] -->|REST API| W
36+
W -->|send_email| OUT[📤 Outbound]
37+
CRON[⏰ Cron */10m] --> W
38+
GCAL[📅 Google invite] -->|text/calendar| W
39+
W -->|METHOD:REPLY| GCAL2[Organizer sees<br/>✅ Accepted]
40+
```
41+
42+
## 🚀 One-command install
43+
44+
```bash
45+
git clone https://github.com/DevArtsLab/devarts-mail.git
46+
cd devarts-mail
47+
./install.sh
48+
```
49+
50+
That's it. The installer:
51+
52+
1. `npm install`
53+
2. generates `.dev.vars` with strong random secrets (and **prints your UI password**)
54+
3. runs `wrangler login` if needed (browser OAuth — that's the only interaction)
55+
4. provisions **D1**, runs **migrations**, uploads **secrets**, **deploys**, and creates the **Email Routing rule** `you@domain → worker`
56+
57+
## ⚙️ Unified config — one file
58+
59+
Everything lives in **`wrangler.jsonc`** — worker, assets, D1, `send_email`, cron, routes, and all app variables:
60+
61+
| Var | Default | Meaning |
62+
| ------------------------- | --------------------- | ---------------------------------------- |
63+
| `MAIL_DOMAIN` | `devartslab.com` | Your domain |
64+
| `PRIMARY_ADDRESS` | `amir@devartslab.com` | Send/receive identity |
65+
| `DISPLAY_NAME` | `Amir \| DevArts Lab` | From-name on outgoing mail |
66+
| `AUTO_ACCEPT_INVITES` | `"false"` | Auto-accept incoming invites |
67+
| `INVITE_REMINDER_MINUTES` | `"30"` | Reminder email before events (`0` = off) |
68+
| `SESSION_TTL_HOURS` | `"168"` | UI session length |
69+
70+
Secrets live in `.dev.vars` locally / `wrangler secret` in prod — never committed.
71+
72+
## 📁 Layout
73+
74+
```
75+
├── wrangler.jsonc # ← THE unified config
76+
├── install.sh # one-command setup
77+
├── migrations/ # D1 schema
78+
├── scripts/setup.mjs # provisioning engine (idempotent)
79+
├── src/
80+
│ ├── index.ts # entry: fetch + email + scheduled
81+
│ ├── inbound.ts # inbound parse → store → RSVP side-effects
82+
│ ├── mail.ts # postal-mime in / mimetext + send_email out
83+
│ ├── ical.ts # RFC 5545 iCal parser + generator
84+
│ ├── api.ts # REST API for the UI
85+
│ ├── auth.ts # cookie session auth
86+
│ └── db.ts # D1 access layer
87+
├── public/ # the UI (served via Workers Assets)
88+
└── test/ # vitest unit tests
89+
```
90+
91+
## 🧪 Commands
92+
93+
```bash
94+
npm run dev # local dev server
95+
npm test # unit tests
96+
npm run typecheck # TypeScript check
97+
npm run deploy # deploy
98+
npm run setup # full re-provisioning (idempotent)
99+
npm run migrate:remote # apply D1 migrations
100+
```
101+
102+
Push to `main` auto-deploys via GitHub Actions (set repo secrets
103+
`CLOUDFLARE_API_TOKEN` + `CLOUDFLARE_ACCOUNT_ID`).
104+
105+
## 🔁 Reuse on your own domain
106+
107+
1. Clone → `./install.sh` after editing `wrangler.jsonc` `vars`
108+
(`MAIL_DOMAIN`, `PRIMARY_ADDRESS`, `DISPLAY_NAME`, `D1_DATABASE_NAME`)
109+
2. Done — your mail + calendar runs on Cloudflare, data stays in your D1.
110+
111+
## 📬 Notes
112+
113+
- Replies to calendar invites are real RFC 5546 `METHOD:REPLY` emails with
114+
`In-Reply-To` threading — Gmail/Google Calendar records your status.
115+
- Email Sending requires the `cf-bounce` DNS records on your domain —
116+
don't delete them.
117+
- Full calendar export: `GET /api/calendar.ics`.
118+
119+
---
120+
121+
<div align="center">
122+
Built on Cloudflare Workers · D1 · Email Routing · Email Sending
123+
</div>

‎docs/screenshot.png‎

71.2 KB
Loading

0 commit comments

Comments
 (0)