123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464 |
- defmodule PlausibleWeb.Email do
- use Plausible
- use Bamboo.Phoenix, view: PlausibleWeb.EmailView
- import Bamboo.PostmarkHelper
- def mailer_email_from do
- Application.get_env(:plausible, :mailer_email)
- end
- def activation_email(user, code) do
- priority_email()
- |> to(user)
- |> tag("activation-email")
- |> subject("#{code} is your Plausible email verification code")
- |> render("activation_email.html", user: user, code: code)
- end
- def welcome_email(user) do
- base_email()
- |> to(user)
- |> tag("welcome-email")
- |> subject("Welcome to Plausible")
- |> render("welcome_email.html", user: user)
- end
- def create_site_email(user) do
- base_email()
- |> to(user)
- |> tag("create-site-email")
- |> subject("Your Plausible setup: Add your website details")
- |> render("create_site_email.html", user: user)
- end
- def site_setup_help(user, site) do
- base_email()
- |> to(user)
- |> tag("help-email")
- |> subject("Your Plausible setup: Waiting for the first page views")
- |> render("site_setup_help_email.html",
- user: user,
- site: site
- )
- end
- def site_setup_success(user, site) do
- base_email()
- |> to(user)
- |> tag("setup-success-email")
- |> subject("Plausible is now tracking your website stats")
- |> render("site_setup_success_email.html",
- user: user,
- site: site
- )
- end
- def check_stats_email(user) do
- base_email()
- |> to(user)
- |> tag("check-stats-email")
- |> subject("Check your Plausible website stats")
- |> render("check_stats_email.html", user: user)
- end
- def password_reset_email(email, reset_link) do
- priority_email(%{layout: nil})
- |> to(email)
- |> tag("password-reset-email")
- |> subject("Plausible password reset")
- |> render("password_reset_email.html", reset_link: reset_link)
- end
- def two_factor_enabled_email(user) do
- priority_email()
- |> to(user)
- |> tag("two-factor-enabled-email")
- |> subject("Plausible Two-Factor Authentication enabled")
- |> render("two_factor_enabled_email.html", user: user)
- end
- def two_factor_disabled_email(user) do
- priority_email()
- |> to(user)
- |> tag("two-factor-disabled-email")
- |> subject("Plausible Two-Factor Authentication disabled")
- |> render("two_factor_disabled_email.html", user: user)
- end
- def trial_one_week_reminder(user) do
- base_email()
- |> to(user)
- |> tag("trial-one-week-reminder")
- |> subject("Your Plausible trial expires next week")
- |> render("trial_one_week_reminder.html", user: user)
- end
- def trial_upgrade_email(user, day, usage) do
- suggested_plan = Plausible.Billing.Plans.suggest(user, usage.total)
- base_email()
- |> to(user)
- |> tag("trial-upgrade-email")
- |> subject("Your Plausible trial ends #{day}")
- |> render("trial_upgrade_email.html",
- user: user,
- day: day,
- custom_events: usage.custom_events,
- usage: usage.total,
- suggested_plan: suggested_plan
- )
- end
- def trial_over_email(user) do
- base_email()
- |> to(user)
- |> tag("trial-over-email")
- |> subject("Your Plausible trial has ended")
- |> render("trial_over_email.html",
- user: user,
- extra_offset: Plausible.Auth.User.trial_accept_traffic_until_offset_days()
- )
- end
- def stats_report(email, assigns) do
- base_email(%{layout: nil})
- |> to(email)
- |> tag("#{assigns.type}-report")
- |> subject("#{assigns.name} report for #{assigns.site.domain}")
- |> html_body(PlausibleWeb.MJML.StatsReport.render(assigns))
- end
- def spike_notification(email, site, current_visitors, sources, dashboard_link) do
- base_email()
- |> to(email)
- |> tag("spike-notification")
- |> subject("Traffic Spike on #{site.domain}")
- |> render("spike_notification.html", %{
- site: site,
- current_visitors: current_visitors,
- sources: sources,
- link: dashboard_link
- })
- end
- def over_limit_email(user, usage, suggested_plan) do
- priority_email()
- |> to(user)
- |> tag("over-limit")
- |> subject("[Action required] You have outgrown your Plausible subscription tier")
- |> render("over_limit.html", %{
- user: user,
- usage: usage,
- suggested_plan: suggested_plan
- })
- end
- def enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance) do
- base_email(%{layout: nil})
- |> to("enterprise@plausible.io")
- |> tag("enterprise-over-limit")
- |> subject("#{user.email} has outgrown their enterprise plan")
- |> render("enterprise_over_limit_internal.html", %{
- user: user,
- pageview_usage: pageview_usage,
- site_usage: site_usage,
- site_allowance: site_allowance
- })
- end
- def dashboard_locked(user, usage, suggested_plan) do
- priority_email()
- |> to(user)
- |> tag("dashboard-locked")
- |> subject("[Action required] Your Plausible dashboard is now locked")
- |> render("dashboard_locked.html", %{
- user: user,
- usage: usage,
- suggested_plan: suggested_plan
- })
- end
- def yearly_renewal_notification(user) do
- date = Timex.format!(user.subscription.next_bill_date, "{Mfull} {D}, {YYYY}")
- priority_email()
- |> to(user)
- |> tag("yearly-renewal")
- |> subject("Your Plausible subscription is up for renewal")
- |> render("yearly_renewal_notification.html", %{
- user: user,
- date: date,
- next_bill_amount: user.subscription.next_bill_amount,
- currency: user.subscription.currency_code
- })
- end
- def yearly_expiration_notification(user) do
- next_bill_date = Timex.format!(user.subscription.next_bill_date, "{Mfull} {D}, {YYYY}")
- accept_traffic_until =
- user
- |> Plausible.Users.accept_traffic_until()
- |> Timex.format!("{Mfull} {D}, {YYYY}")
- priority_email()
- |> to(user)
- |> tag("yearly-expiration")
- |> subject("Your Plausible subscription is about to expire")
- |> render("yearly_expiration_notification.html", %{
- user: user,
- next_bill_date: next_bill_date,
- accept_traffic_until: accept_traffic_until
- })
- end
- def cancellation_email(user) do
- base_email()
- |> to(user.email)
- |> tag("cancelled-email")
- |> subject("Mind sharing your thoughts on Plausible?")
- |> render("cancellation_email.html", user: user)
- end
- def new_user_invitation(invitation) do
- priority_email()
- |> to(invitation.email)
- |> tag("new-user-invitation")
- |> subject("[Plausible Analytics] You've been invited to #{invitation.site.domain}")
- |> render("new_user_invitation.html",
- invitation: invitation
- )
- end
- def existing_user_invitation(invitation) do
- priority_email()
- |> to(invitation.email)
- |> tag("existing-user-invitation")
- |> subject("[Plausible Analytics] You've been invited to #{invitation.site.domain}")
- |> render("existing_user_invitation.html",
- invitation: invitation
- )
- end
- def ownership_transfer_request(invitation, new_owner_account) do
- priority_email()
- |> to(invitation.email)
- |> tag("ownership-transfer-request")
- |> subject("[Plausible Analytics] Request to transfer ownership of #{invitation.site.domain}")
- |> render("ownership_transfer_request.html",
- invitation: invitation,
- new_owner_account: new_owner_account
- )
- end
- def invitation_accepted(invitation) do
- priority_email()
- |> to(invitation.inviter.email)
- |> tag("invitation-accepted")
- |> subject(
- "[Plausible Analytics] #{invitation.email} accepted your invitation to #{invitation.site.domain}"
- )
- |> render("invitation_accepted.html",
- user: invitation.inviter,
- invitation: invitation
- )
- end
- def invitation_rejected(invitation) do
- priority_email()
- |> to(invitation.inviter.email)
- |> tag("invitation-rejected")
- |> subject(
- "[Plausible Analytics] #{invitation.email} rejected your invitation to #{invitation.site.domain}"
- )
- |> render("invitation_rejected.html",
- user: invitation.inviter,
- invitation: invitation
- )
- end
- def ownership_transfer_accepted(invitation) do
- priority_email()
- |> to(invitation.inviter.email)
- |> tag("ownership-transfer-accepted")
- |> subject(
- "[Plausible Analytics] #{invitation.email} accepted the ownership transfer of #{invitation.site.domain}"
- )
- |> render("ownership_transfer_accepted.html",
- user: invitation.inviter,
- invitation: invitation
- )
- end
- def ownership_transfer_rejected(invitation) do
- priority_email()
- |> to(invitation.inviter.email)
- |> tag("ownership-transfer-rejected")
- |> subject(
- "[Plausible Analytics] #{invitation.email} rejected the ownership transfer of #{invitation.site.domain}"
- )
- |> render("ownership_transfer_rejected.html",
- user: invitation.inviter,
- invitation: invitation
- )
- end
- def site_member_removed(membership) do
- priority_email()
- |> to(membership.user.email)
- |> tag("site-member-removed")
- |> subject("[Plausible Analytics] Your access to #{membership.site.domain} has been revoked")
- |> render("site_member_removed.html",
- user: membership.user,
- membership: membership
- )
- end
- def import_success(site_import, user) do
- import_api = Plausible.Imported.ImportSources.by_name(site_import.source)
- label = import_api.label()
- priority_email()
- |> to(user)
- |> tag("import-success-email")
- |> subject("#{label} data imported for #{site_import.site.domain}")
- |> render(import_api.email_template(), %{
- site_import: site_import,
- label: label,
- link: PlausibleWeb.Endpoint.url() <> "/" <> URI.encode_www_form(site_import.site.domain),
- user: user,
- success: true
- })
- end
- def import_failure(site_import, user) do
- import_api = Plausible.Imported.ImportSources.by_name(site_import.source)
- label = import_api.label()
- priority_email()
- |> to(user)
- |> tag("import-failure-email")
- |> subject("#{label} import failed for #{site_import.site.domain}")
- |> render(import_api.email_template(), %{
- site_import: site_import,
- label: label,
- user: user,
- success: false
- })
- end
- def export_success(user, site, expires_at) do
- subject =
- on_ee do
- "Your Plausible Analytics export is now ready for download"
- else
- "Your export is now ready for download"
- end
- expires_in =
- if expires_at do
- Timex.Format.DateTime.Formatters.Relative.format!(
- expires_at,
- "{relative}"
- )
- end
- download_url =
- PlausibleWeb.Router.Helpers.site_url(
- PlausibleWeb.Endpoint,
- :download_export,
- site.domain
- )
- priority_email()
- |> to(user)
- |> tag("export-success")
- |> subject(subject)
- |> render("export_success.html",
- user: user,
- site: site,
- download_url: download_url,
- expires_in: expires_in
- )
- end
- def export_failure(user, site) do
- subject =
- on_ee do
- "Your Plausible Analytics export has failed"
- else
- "Your export has failed"
- end
- priority_email()
- |> to(user)
- |> subject(subject)
- |> render("export_failure.html", user: user, site: site)
- end
- def error_report(reported_by, trace_id, feedback) do
- Map.new()
- |> Map.put(:layout, nil)
- |> base_email()
- |> to("bugs@plausible.io")
- |> put_param("ReplyTo", reported_by)
- |> tag("sentry")
- |> subject("Feedback to Sentry Trace #{trace_id}")
- |> render("error_report_email.html", %{
- reported_by: reported_by,
- feedback: feedback,
- trace_id: trace_id
- })
- end
- def approaching_accept_traffic_until(notification) do
- base_email()
- |> to(notification.email)
- |> tag("drop-traffic-warning-first")
- |> subject("We'll stop counting your stats")
- |> render("approaching_accept_traffic_until.html",
- time: "next week",
- user: %{email: notification.email, name: notification.name}
- )
- end
- def approaching_accept_traffic_until_tomorrow(notification) do
- base_email()
- |> to(notification.email)
- |> tag("drop-traffic-warning-final")
- |> subject("A reminder that we'll stop counting your stats tomorrow")
- |> render("approaching_accept_traffic_until.html",
- time: "tomorrow",
- user: %{email: notification.email, name: notification.name}
- )
- end
- @doc """
- Unlike the default 'base' emails, priority emails cannot be unsubscribed from. This is achieved
- by sending them through a dedicated 'priority' message stream in Postmark.
- """
- def priority_email(), do: priority_email(%{layout: "priority_email.html"})
- def priority_email(%{layout: layout}) do
- base_email(%{layout: layout})
- |> put_param("MessageStream", "priority")
- end
- def base_email(), do: base_email(%{layout: "base_email.html"})
- def base_email(%{layout: layout}) do
- mailer_from = Application.get_env(:plausible, :mailer_email)
- new_email()
- |> put_param("TrackOpens", false)
- |> from(mailer_from)
- |> maybe_put_layout(layout)
- end
- defp maybe_put_layout(email, nil), do: email
- defp maybe_put_layout(email, layout) do
- put_html_layout(email, {PlausibleWeb.LayoutView, layout})
- end
- end
|