plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-23 20:13:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
7146dc1d9f
analytics/PlausibleWeb.Email.html
zoldar 81fd306e1f deploy: 1d3b068233
2024-06-03 10:29:48 +00:00

1448 lines
43 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.1">
<meta name="project" content="Plausible v0.0.1">
<title>PlausibleWeb.Email — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-04905ADA.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-L4O5OK2K.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="readme.html" class="sidebar-projectImage">
<img src="assets/logo.png" alt="Plausible" />
</a>
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
<li>
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
<span translate="no">Mix</span> Tasks
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
<ul id="tasks-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of Plausible</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">PlausibleWeb.Email</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#activation_email/2" translate="no">activation_email(user, code)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#approaching_accept_traffic_until/1" translate="no">approaching_accept_traffic_until(notification)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#approaching_accept_traffic_until_tomorrow/1" translate="no">approaching_accept_traffic_until_tomorrow(notification)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#base_email/0" translate="no">base_email()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#base_email/1" translate="no">base_email(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#cancellation_email/1" translate="no">cancellation_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#check_stats_email/1" translate="no">check_stats_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_site_email/1" translate="no">create_site_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#dashboard_locked/3" translate="no">dashboard_locked(user, usage, suggested_plan)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#enterprise_over_limit_internal_email/4" translate="no">enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#error_report/3" translate="no">error_report(reported_by, trace_id, feedback)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#existing_user_invitation/1" translate="no">existing_user_invitation(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#export_failure/2" translate="no">export_failure(user, site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#export_success/3" translate="no">export_success(user, site, expires_at)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#import_failure/2" translate="no">import_failure(site_import, user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#import_success/2" translate="no">import_success(site_import, user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#invitation_accepted/1" translate="no">invitation_accepted(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#invitation_rejected/1" translate="no">invitation_rejected(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#mailer_email_from/0" translate="no">mailer_email_from()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#new_user_invitation/1" translate="no">new_user_invitation(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#over_limit_email/3" translate="no">over_limit_email(user, usage, suggested_plan)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ownership_transfer_accepted/1" translate="no">ownership_transfer_accepted(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ownership_transfer_rejected/1" translate="no">ownership_transfer_rejected(invitation)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ownership_transfer_request/2" translate="no">ownership_transfer_request(invitation, new_owner_account)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#password_reset_email/2" translate="no">password_reset_email(email, reset_link)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#priority_email/0" translate="no">priority_email()</a>
</div>
<div class="summary-synopsis"><p> 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.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#priority_email/1" translate="no">priority_email(map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#render/3" translate="no">render(email, template, assigns \\ [])</a>
</div>
<div class="summary-synopsis"><p>Render an Phoenix template and set the body on the email.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_member_removed/1" translate="no">site_member_removed(membership)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_setup_help/2" translate="no">site_setup_help(user, site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_setup_success/2" translate="no">site_setup_success(user, site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#spike_notification/5" translate="no">spike_notification(email, site, current_visitors, sources, dashboard_link)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#stats_report/2" translate="no">stats_report(email, assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trial_one_week_reminder/1" translate="no">trial_one_week_reminder(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trial_over_email/1" translate="no">trial_over_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trial_upgrade_email/3" translate="no">trial_upgrade_email(user, day, usage)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#two_factor_disabled_email/1" translate="no">two_factor_disabled_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#two_factor_enabled_email/1" translate="no">two_factor_enabled_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#welcome_email/1" translate="no">welcome_email(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#yearly_expiration_notification/1" translate="no">yearly_expiration_notification(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#yearly_renewal_notification/1" translate="no">yearly_renewal_notification(user)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="activation_email/2">
<div class="detail-header">
<a href="#activation_email/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">activation_email(user, code)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L10" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="approaching_accept_traffic_until/1">
<div class="detail-header">
<a href="#approaching_accept_traffic_until/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">approaching_accept_traffic_until(notification)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L404" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="approaching_accept_traffic_until_tomorrow/1">
<div class="detail-header">
<a href="#approaching_accept_traffic_until_tomorrow/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">approaching_accept_traffic_until_tomorrow(notification)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L415" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="base_email/0">
<div class="detail-header">
<a href="#base_email/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">base_email()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L437" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="base_email/1">
<div class="detail-header">
<a href="#base_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">base_email(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L439" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="cancellation_email/1">
<div class="detail-header">
<a href="#cancellation_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">cancellation_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L215" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="check_stats_email/1">
<div class="detail-header">
<a href="#check_stats_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">check_stats_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L56" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="create_site_email/1">
<div class="detail-header">
<a href="#create_site_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_site_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L26" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="dashboard_locked/3">
<div class="detail-header">
<a href="#dashboard_locked/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">dashboard_locked(user, usage, suggested_plan)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L169" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="enterprise_over_limit_internal_email/4">
<div class="detail-header">
<a href="#enterprise_over_limit_internal_email/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L156" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="error_report/3">
<div class="detail-header">
<a href="#error_report/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">error_report(reported_by, trace_id, feedback)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L389" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="existing_user_invitation/1">
<div class="detail-header">
<a href="#existing_user_invitation/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">existing_user_invitation(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L233" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="export_failure/2">
<div class="detail-header">
<a href="#export_failure/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">export_failure(user, site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L382" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="export_success/3">
<div class="detail-header">
<a href="#export_success/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">export_success(user, site, expires_at)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L354" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="import_failure/2">
<div class="detail-header">
<a href="#import_failure/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">import_failure(site_import, user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L338" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="import_success/2">
<div class="detail-header">
<a href="#import_success/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">import_success(site_import, user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L321" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="invitation_accepted/1">
<div class="detail-header">
<a href="#invitation_accepted/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">invitation_accepted(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L256" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="invitation_rejected/1">
<div class="detail-header">
<a href="#invitation_rejected/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">invitation_rejected(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L269" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="mailer_email_from/0">
<div class="detail-header">
<a href="#mailer_email_from/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">mailer_email_from()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L6" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="new_user_invitation/1">
<div class="detail-header">
<a href="#new_user_invitation/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">new_user_invitation(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L223" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="over_limit_email/3">
<div class="detail-header">
<a href="#over_limit_email/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">over_limit_email(user, usage, suggested_plan)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L144" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="ownership_transfer_accepted/1">
<div class="detail-header">
<a href="#ownership_transfer_accepted/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">ownership_transfer_accepted(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L282" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="ownership_transfer_rejected/1">
<div class="detail-header">
<a href="#ownership_transfer_rejected/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">ownership_transfer_rejected(invitation)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L295" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="ownership_transfer_request/2">
<div class="detail-header">
<a href="#ownership_transfer_request/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">ownership_transfer_request(invitation, new_owner_account)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L243" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="password_reset_email/2">
<div class="detail-header">
<a href="#password_reset_email/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">password_reset_email(email, reset_link)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L64" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="priority_email/0">
<div class="detail-header">
<a href="#priority_email/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">priority_email()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L430" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p> 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.</p>
</section>
</section>
<section class="detail" id="priority_email/1">
<div class="detail-header">
<a href="#priority_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">priority_email(map)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L432" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="render/3">
<span id="render/2"></span>
<div class="detail-header">
<a href="#render/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">render(email, template, assigns \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L3" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Render an Phoenix template and set the body on the email.</p><p>Pass an atom as the template name (:welcome_email) to render HTML <em>and</em> plain
text emails. Use a string if you only want to render one type, e.g.
&quot;welcome_email.text&quot; or &quot;welcome_email.html&quot;. Scroll to the top for more examples.</p>
</section>
</section>
<section class="detail" id="site_member_removed/1">
<div class="detail-header">
<a href="#site_member_removed/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">site_member_removed(membership)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L308" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="site_setup_help/2">
<div class="detail-header">
<a href="#site_setup_help/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">site_setup_help(user, site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L34" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="site_setup_success/2">
<div class="detail-header">
<a href="#site_setup_success/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">site_setup_success(user, site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L45" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="spike_notification/5">
<div class="detail-header">
<a href="#spike_notification/5" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">spike_notification(email, site, current_visitors, sources, dashboard_link)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L131" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="stats_report/2">
<div class="detail-header">
<a href="#stats_report/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">stats_report(email, assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L123" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="trial_one_week_reminder/1">
<div class="detail-header">
<a href="#trial_one_week_reminder/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">trial_one_week_reminder(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L88" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="trial_over_email/1">
<div class="detail-header">
<a href="#trial_over_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">trial_over_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L112" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="trial_upgrade_email/3">
<div class="detail-header">
<a href="#trial_upgrade_email/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">trial_upgrade_email(user, day, usage)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L96" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="two_factor_disabled_email/1">
<div class="detail-header">
<a href="#two_factor_disabled_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">two_factor_disabled_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L80" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="two_factor_enabled_email/1">
<div class="detail-header">
<a href="#two_factor_enabled_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">two_factor_enabled_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L72" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="welcome_email/1">
<div class="detail-header">
<a href="#welcome_email/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">welcome_email(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L18" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="yearly_expiration_notification/1">
<div class="detail-header">
<a href="#yearly_expiration_notification/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">yearly_expiration_notification(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L196" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="yearly_renewal_notification/1">
<div class="detail-header">
<a href="#yearly_renewal_notification/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">yearly_renewal_notification(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L181" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink