Author: MailerSend

Description: MailerSend is a transactional messaging service that enables developers to work faster and smarter.

An intuitively designed interface enables anyone to contribute to transactional email and SMS, while advanced sending infrastructure and flexible payment plans let you scale your sendings.

Built by deliverability experts, your messages always get delivered, along with dedicated IP, email verification and inbound routing for a comprehensive solution.

Get started right now for free!

Details: Use this extension to send emails that contain the information from documents added to a specified Cloud Firestore collection. Adding a document triggers this extension to send an email built from the document's fields.

Note that MailerSend allows you to:

• schedule emails
• send bulk emails
• add attachments up to 25MB
• organize your sendings with tags
• track opens, clicks, and spam reports.

We welcome bug reports and feature requests as well as pull requests in this GitHub repository.

• 🧩 Install this extension
  • Console
  • Firebase CLI
• 💪 Use the extension
  • Send an email
  • Additional setup
  • Collection fields
  • Email results
• 💳 Billing
• ⚙️ Configuration
  • Configuration parameters
  • Cloud Functions

firebase ext:install mailersend/mailersend-email --project=[your-project-id]

Learn more about installing extensions in the Firebase Extensions documentation: console, CLI

After its installation, this extension monitors all document writes to the EMAIL_COLLECTION collection. Email is sent based on the contents of the document's fields. The document's fields specify an email data.

admin.firestore().collection('emails').add({
  to: [
    {
      email: '[email protected]',
      name: 'Recipient name'
    }
  ],
  from: {
    email: '[email protected]',
    name: 'From name'
  },
  cc: [
    {
      email: '[email protected]',
      name: 'CC recipient name'
    }
  ],
  bcc: [
    {
      email: '[email protected]',
      name: 'Bcc recipient name'
    }
  ],
  subject: 'Hello from Firebase!',
  html: 'This is an <code>HTML</code> email body.',
  text: 'This is an TEXT email body.',
  template_id: 'abc123ced',
    variables: [
      {
        email: '[email protected]',
        substitutions: [
          {
            var: 'variable_name',
            value: 'variable value'
          }
        ]
      }
    ],
    personalization: [
      {
        email: '[email protected]',
        data: {
          personalization_name: 'personalization value'
        }
      }
    ],
    tags: ['tag1', 'tag2'],
    reply_to: {
      email: '[email protected]',
        name: 'Reply to name'
    },
    send_at: '123465789'
})

Before installing this extension, set up the following Firebase service in your Firebase project:

• Cloud Firestore collection in your Firebase project.

Then, in the MailerSend dashboard:

• Add a domain and verify it editing your DNS records.
• Create a new API token with full access.

After email sending is triggered this extension fills results into the delivery field.

This extension uses other Firebase or Google Cloud Platform services which may have associated charges:

• Cloud Functions

When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. Learn more about Firebase billing.

This extension also uses the following third-party services:

• MailerSend (pricing information)

You are responsible for any costs associated with your use of these services.

• Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the location selection guide.

• Emails documents collection: What is the path to the collection that contains the documents used to build and send the email?

• MailerSend API key: API tokens are used for authentication when sending emails. You can find more details how to create an API token here.

• Email parameters:

  • Default FROM email address: The email address to use as the sender's address (if it's not specified in the added email document or template).

  • Default FROM name: The name to use as the sender's name.

  • Default reply to email address: The email address to use as the reply to address (if it's not specified in the added email document or template).(not required)

  • Default reply to name: The name to use as the reply to name. (not required)

  • Default template ID: The default template id to use for emails (it will be used if not specified in the added email document).

• processDocumentCreated: Processes created document in Cloud Firestore collection, sends an email and updates status information.