diff --git a/firestore-send-email/CHANGELOG.md b/firestore-send-email/CHANGELOG.md index 89e03e2bb..d5e08e657 100644 --- a/firestore-send-email/CHANGELOG.md +++ b/firestore-send-email/CHANGELOG.md @@ -2,6 +2,8 @@ feat - add SendGrid category support +docs - add instructions for setting up Firestore TTL policies for the `delivery.expireAt` field. + ## Version 0.1.34 fixed - SendGrid v3 issues (#2020) diff --git a/firestore-send-email/POSTINSTALL.md b/firestore-send-email/POSTINSTALL.md index 6382fdbf3..629ddf707 100644 --- a/firestore-send-email/POSTINSTALL.md +++ b/firestore-send-email/POSTINSTALL.md @@ -61,6 +61,14 @@ Add this document to the Firestore mail collection to send categorized emails. For more details, see the [SendGrid Categories documentation](https://docs.sendgrid.com/ui/sending-email/categories). +### Automatic Deletion of Email Documents + +To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters. + +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. + +Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl). + ### Monitoring diff --git a/firestore-send-email/PREINSTALL.md b/firestore-send-email/PREINSTALL.md index eccd5ca4d..b47d4ce0e 100644 --- a/firestore-send-email/PREINSTALL.md +++ b/firestore-send-email/PREINSTALL.md @@ -64,6 +64,14 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha 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. +#### Automatic Deletion of Email Documents + +To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters. + +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. + +Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl). + #### Billing To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing) diff --git a/firestore-send-email/README.md b/firestore-send-email/README.md index 4fae7938d..4db28c576 100644 --- a/firestore-send-email/README.md +++ b/firestore-send-email/README.md @@ -72,6 +72,14 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha 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. +#### Automatic Deletion of Email Documents + +To use Firestore's TTL feature for automatic deletion of expired email documents, the extension provides several configuration parameters. + +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. + +Detailed instructions for creating a TTL field can be found in the [Firestore TTL Policy documentation](https://firebase.google.com/docs/firestore/ttl). + #### Billing To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)