Skip to content

Commit 32631be

Browse files
authored
docs(firestore-send-email): add docs for ttl setup (#2260)
1 parent 314efdf commit 32631be

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

firestore-send-email/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
feat - add SendGrid category support
44

5+
docs - add instructions for setting up Firestore TTL policies for the `delivery.expireAt` field.
6+
57
## Version 0.1.34
68

79
fixed - SendGrid v3 issues (#2020)

firestore-send-email/POSTINSTALL.md

+8
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@ Add this document to the Firestore mail collection to send categorized emails.
6161
6262
For more details, see the [SendGrid Categories documentation](https://docs.sendgrid.com/ui/sending-email/categories).
6363
64+
### Automatic Deletion of Email Documents
65+
66+
To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters.
67+
68+
The extension will set a TTL field in the email documents, but you will need to manually configure a TTL policy for the collection/collection group the extension targets, on the `delivery.expireAt` field.
69+
70+
Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl).
71+
6472

6573
### Monitoring
6674

firestore-send-email/PREINSTALL.md

+8
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha
6464

6565
Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
6666

67+
#### Automatic Deletion of Email Documents
68+
69+
To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters.
70+
71+
The extension will set a TTL field in the email documents, but you will need to manually configure a TTL policy for the collection/collection group the extension targets, on the `delivery.expireAt` field.
72+
73+
Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl).
74+
6775
#### Billing
6876
To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
6977

firestore-send-email/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,14 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha
7272

7373
Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
7474

75+
#### Automatic Deletion of Email Documents
76+
77+
To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters.
78+
79+
The extension will set a TTL field in the email documents, but you will need to manually configure a TTL policy for the collection/collection group the extension targets, on the `delivery.expireAt` field.
80+
81+
Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl).
82+
7583
#### Billing
7684
To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
7785

0 commit comments

Comments
 (0)