Skip to content

Fix URLs in documentation #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leonid-shevtsov merged 1 commit into from
Mar 9, 2026
+9 −7
Merged

Fix URLs in documentation #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ DEFAULT_FROM_EMAIL=noreply@your-verified-domain.com
DEFAULT_FROM_NAME=Test App
```

- **MAILTRAP_API_TOKEN** — your Mailtrap API token from the [API Tokens page](https://mailtrap.io/api-tokens).
- **MAILTRAP_API_TOKEN** — your Mailtrap API token from the [API Tokens page](https://docs.mailtrap.io/email-api-smtp/setup/api-tokens).
- **FUNCTION_LOCATION** — the [Cloud Functions region](https://firebase.google.com/docs/functions/locations) to deploy to.
- **DATABASE_LOCATION** — the region of your Firestore database. For multi-region US use `nam5`, for multi-region EU use `eur3`. See the [Firestore locations guide](https://firebase.google.com/docs/firestore/locations).
- **MAIL_COLLECTION** — the Firestore collection the extension watches for new documents (default: `mail`).
- **DEFAULT_FROM_EMAIL** — default sender email address. Must be from a [verified sending domain](https://mailtrap.io/sending/domains) in Mailtrap.
- **DEFAULT_FROM_EMAIL** — default sender email address. Must be from a [verified sending domain](https://docs.mailtrap.io/email-api-smtp/setup/sending-domain) in Mailtrap.
- **DEFAULT_FROM_NAME** — default sender display name (optional).

## 5. Deploy the extension
Expand Down
4 changes: 2 additions & 2 deletions PREINSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ await admin.firestore().collection('mail').add({
Before installing this extension, you need:

- A [Mailtrap account](https://mailtrap.io/signup)
- A [verified sending domain](https://mailtrap.io/sending/domains) in Mailtrap
- A Mailtrap API token from [API Tokens page](https://mailtrap.io/api-tokens)
- A [verified sending domain](https://docs.mailtrap.io/email-api-smtp/setup/sending-domain) in Mailtrap
- A Mailtrap API token from [API Tokens page](https://docs.mailtrap.io/email-api-smtp/setup/api-tokens)

#### Billing

Expand Down
8 changes: 5 additions & 3 deletions extension.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ author:
authorName: Mailtrap
url: https://mailtrap.io

sourceUrl: https://github.com/mailtrap/mailtrap-firebase-extension
releaseNotesUrl: https://github.com/mailtrap/mailtrap-firebase-extension/blob/main/CHANGELOG.md
sourceUrl: https://github.com/mailtrap/mailtrap-firebase
releaseNotesUrl: https://github.com/mailtrap/mailtrap-firebase/blob/main/CHANGELOG.md

billingRequired: true

Expand Down Expand Up @@ -76,7 +76,7 @@ params:
label: Mailtrap API Token
description: >-
Your Mailtrap API token for sending emails.
Get it from https://mailtrap.io/api-tokens
Get it from https://docs.mailtrap.io/email-api-smtp/setup/api-tokens
type: secret
required: true

Expand All @@ -94,6 +94,8 @@ params:
label: Default FROM email address
description: >-
Default sender email address used when not specified in the document.
Use an address from a verified sending domain.
See https://docs.mailtrap.io/email-api-smtp/setup/sending-domain
type: string
example: noreply@example.com
validationRegex: "^.+@.+\\..+$"
Expand Down