2023-07-12 11:28:07 +03:00
<!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" >
2023-07-25 10:58:48 +03:00
< meta name = "generator" content = "ExDoc v0.30.3" >
2023-07-12 11:28:07 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
< title > PlausibleWeb.Email — Plausible v0.0.1< / title >
2023-07-25 10:58:48 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
2023-07-12 11:28:07 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2023-07-25 10:58:48 +03:00
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2023-12-21 15:56:47 +03:00
< script src = "dist/sidebar_items-10305333.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
2023-07-25 10:58:48 +03:00
< script async src = "dist/html-CGDDOCMI.js" > < / script >
2023-07-12 11:28:07 +03:00
< / 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 class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< section class = "sidebar" >
< form class = "sidebar-search" action = "search.html" >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-label = "Cancel Search" >
< i class = "ri-close-line ri-lg" aria-hidden = "true" title = "Cancel search" > < / i >
< / button >
< label class = "search-label" >
< p class = "sr-only" > Search< / p >
< input name = "q" type = "text" class = "search-input" placeholder = "Search..." aria-label = "Input your search terms" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< / form >
< div class = "autocomplete" >
< div class = "autocomplete-results" >
< / div >
< / div >
< div class = "sidebar-header" >
< a href = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< ul class = "sidebar-listNav" >
< li > < a id = "extras-list-link" href = "#full-list" > Pages< / a > < / li >
< li > < a id = "modules-list-link" href = "#full-list" > Modules< / a > < / li >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / a > < / li >
< / ul >
< / div >
< div class = "gradient" > < / div >
< ul id = "full-list" > < / ul >
< / section >
< section class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< h1 >
< button class = "icon-action display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< 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 >
2023-07-25 10:58:48 +03:00
Summary
2023-07-12 11:28:07 +03:00
< / a >
< / 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 = "#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" >
2023-12-06 15:02:59 +03:00
< a href = "#dashboard_locked/3" translate = "no" > dashboard_locked(user, usage, suggested_plan)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-06 15:02:59 +03:00
< a href = "#enterprise_over_limit_internal_email/4" translate = "no" > enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance)< / a >
2023-07-12 11:28:07 +03:00
< / 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 = "#import_failure/2" translate = "no" > import_failure(user, site)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#import_success/2" translate = "no" > import_success(user, site)< / 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" >
2023-12-06 15:02:59 +03:00
< a href = "#over_limit_email/3" translate = "no" > over_limit_email(user, usage, suggested_plan)< / a >
2023-07-12 11:28:07 +03:00
< / 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 >
2023-08-21 19:22:15 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
< 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" >
2023-12-21 15:56:47 +03:00
< a href = "#stats_report/2" translate = "no" > stats_report(email, assigns)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-21 15:56:47 +03:00
< a href = "#trial_one_week_reminder/1" translate = "no" > trial_one_week_reminder(user)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-21 15:56:47 +03:00
< a href = "#trial_over_email/1" translate = "no" > trial_over_email(user)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
2023-11-28 17:30:36 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-21 15:56:47 +03:00
< a href = "#trial_upgrade_email/3" translate = "no" > trial_upgrade_email(user, day, usage)< / a >
2023-11-28 17:30:36 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-21 15:56:47 +03:00
< a href = "#two_factor_disabled_email/1" translate = "no" > two_factor_disabled_email(user)< / a >
2023-11-28 17:30:36 +03:00
< / div >
< / div >
2023-07-12 11:28:07 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-21 15:56:47 +03:00
< a href = "#two_factor_enabled_email/1" translate = "no" > two_factor_enabled_email(user)< / a >
2023-07-12 11:28:07 +03:00
< / 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 >
Functions
2023-07-25 10:58:48 +03:00
< / a >
2023-07-12 11:28:07 +03:00
< / 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#L9" 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L358" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L360" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L205" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-08-21 19:22:15 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L55" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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#L25" 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 >
2023-12-06 15:02:59 +03:00
< section class = "detail" id = "dashboard_locked/3" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-12-06 15:02:59 +03:00
< a href = "#dashboard_locked/3" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-12-06 15:02:59 +03:00
< h1 class = "signature" translate = "no" > dashboard_locked(user, usage, suggested_plan)< / h1 >
2023-07-12 11:28:07 +03:00
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L165" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-06 15:02:59 +03:00
< section class = "detail" id = "enterprise_over_limit_internal_email/4" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-12-06 15:02:59 +03:00
< a href = "#enterprise_over_limit_internal_email/4" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-12-06 15:02:59 +03:00
< h1 class = "signature" translate = "no" > enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance)< / h1 >
2023-07-12 11:28:07 +03:00
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L152" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L332" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L223" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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(user, site)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L320" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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(user, site)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L307" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L244" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L257" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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#L5" 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L213" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-06 15:02:59 +03:00
< section class = "detail" id = "over_limit_email/3" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-12-06 15:02:59 +03:00
< a href = "#over_limit_email/3" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-12-06 15:02:59 +03:00
< h1 class = "signature" translate = "no" > over_limit_email(user, usage, suggested_plan)< / h1 >
2023-07-12 11:28:07 +03:00
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L140" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L270" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L283" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L233" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-08-21 19:22:15 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L63" 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L351" class = "icon-action" rel = "help" title = "View Source" >
2023-08-21 19:22:15 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L353" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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#L2" 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.
" welcome_email.text" or " welcome_email.html" . 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L296" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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#L33" 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 >
2023-08-21 19:22:15 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L44" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L127" 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#L119" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-11-28 17:30:36 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L87" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-11-28 17:30:36 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L111" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-11-30 15:30:44 +03:00
< h1 class = "signature" translate = "no" > trial_upgrade_email(user, day, usage)< / h1 >
2023-07-12 11:28:07 +03:00
2023-11-28 17:30:36 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L95" 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 >
2023-08-21 19:22:15 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L79" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-11-28 17:30:36 +03:00
< / 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#L71" 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" >
2023-07-12 11:28:07 +03:00
< / 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#L17" 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L192" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/email.ex#L177" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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
2023-07-25 10:58:48 +03:00
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.30.3) for the
2023-07-12 11:28:07 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
