Repository navigation
Expand file tree
/
Copy pathenv.d.ts
More file actions
87 lines (87 loc) · 3.78 KB
/
Copy pathenv.d.ts
File metadata and controls
87 lines (87 loc) · 3.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
interface CloudflareEnv {
DB: D1Database;
/** Connection string for an external database (PostgreSQL, MySQL, libSQL, ...); unset keeps D1. See docs/databases.md. */
DATABASE_URL?: string;
/** Driver override when it cannot be inferred from DATABASE_URL (neon, postgres-js, pglite, planetscale, ...). */
DATABASE_DRIVER?: string;
/** Auth token for libSQL / Turso. */
DATABASE_AUTH_TOKEN?: string;
/** Hyperdrive binding, used as the connection string when DATABASE_URL is unset. */
HYPERDRIVE?: { connectionString: string };
EMAIL: SendEmail;
BUCKET: R2Bucket;
INBOUND_QUEUE: Queue<import("./src/lib/email/inbound").InboundQueueMessage>;
AGENT_QUEUE?: Queue<{ kind: "agent.draft"; jobId: string }>;
AI?: Ai;
AI_MODEL?: string;
AI_BASE_URL?: string;
AI_API_KEY?: string;
// The outbound queue also carries webhook retries and import job chunks so that scheduled redelivery needs no extra binding.
OUTBOUND_QUEUE: Queue<
| import("./src/lib/email/send").OutboundQueueMessage
| import("./src/lib/email/webhooks").WebhookRetryMessage
| import("./src/lib/import/jobs-types").ImportJobMessage
>;
ASSETS: Fetcher;
IMAGES: ImagesBinding;
WORKER_SELF_REFERENCE: Fetcher;
REALTIME: DurableObjectNamespace<
import("./src/lib/realtime/hub").RealtimeHub
>;
LOGIN_RATE_LIMIT?: RateLimit;
/** Mobile device sign-in (`/api/auth/device`), stricter than the web login. */
DEVICE_LOGIN_RATE_LIMIT?: RateLimit;
/** APNs auth key for the mobile push relay (src/lib/push/native.ts). */
APNS_KEY_ID?: string;
APNS_TEAM_ID?: string;
/** The .p8 file contents (PKCS#8 PEM). */
APNS_PRIVATE_KEY?: string;
/** Origin of a Mailflare push relay (mailflare-relay); lets this server push without APNS_* keys. */
APNS_RELAY_URL?: string;
/** Spamhaus Data Query Service key; enables ZEN (sending IP) and DBL (domain) checks in spam analysis. */
SPAMHAUS_DQS_KEY?: string;
/** abuse.ch Auth-Key; enables URLhaus malware-host checks for links in incoming mail. */
ABUSECH_AUTH_KEY?: string;
/** "off" disables the RDAP domain-age check in spam analysis. */
SPAM_DOMAIN_AGE_CHECK?: string;
AGENT_RATE_LIMIT?: RateLimit;
/**
* Backblaze B2 storage. When all four are set, B2 replaces the R2 binding for raw mail, attachments, Drive,
* avatars, branding and backups. B2_ENDPOINT is the S3-compatible host, e.g. s3.us-west-004.backblazeb2.com.
*/
B2_KEY_ID?: string;
B2_APPLICATION_KEY?: string;
B2_BUCKET?: string;
B2_ENDPOINT?: string;
/**
* AWS S3 storage, used when B2 is not configured. Credentials fall back to AWS_ACCESS_KEY_ID /
* AWS_SECRET_ACCESS_KEY (read from the environment), so an existing SES key can serve both.
*/
S3_BUCKET?: string;
S3_REGION?: string;
S3_ACCESS_KEY_ID?: string;
S3_SECRET_ACCESS_KEY?: string;
CF_TOKEN?: string;
CF_API_KEY?: string;
CF_EMAIL?: string;
TURNSTILE_SECRET_KEY?: string;
GITHUB_UPDATE_TOKEN?: string;
GITHUB_UPDATE_REF?: string;
GITHUB_UPDATE_REPO?: string;
/** "node" when served by the self-hosted runtime in server/; unset on Workers. */
MAILFLARE_RUNTIME?: "node";
/** Shared secret the Cloudflare email relay signs inbound webhooks with (self-hosted only). */
INBOUND_WEBHOOK_SECRET?: string;
/** "1" refuses relays that do not sign the header map with a timestamp (relay Worker v2). */
INBOUND_REQUIRE_SIGNED_HEADERS?: string;
/** Cloudflare account id, needed for the Email Sending REST API off Workers. */
CF_ACCOUNT_ID?: string;
/** Public origin of this install (https://mail.example.com) when it sits behind a proxy. */
APP_URL?: string;
/** VAPID public key (uncompressed P-256 point, URL-safe base64) for Web Push. */
VAPID_PUBLIC_KEY?: string;
/** VAPID private scalar (URL-safe base64). Keep this secret. */
VAPID_PRIVATE_KEY?: string;
/** Contact URI for VAPID, e.g. mailto:admin@example.com or https://mail.example.com. */
VAPID_SUBJECT?: string;
}