Class: Studio::NewsletterMailer

Inherits:
ApplicationMailer show all
Defined in:
app/mailers/studio/newsletter_mailer.rb

Overview

The "you're on the list" email.

NAMESPACED, unlike the engine's UserMailer, and that is the whole point. A host that defines its own top-level UserMailer (McRitchie Studio does) SHADOWS the engine's outright — Zeitwerk resolves the constant to the host's file and the engine's actions simply do not exist there. Putting this under

Studio

means every app inherits a sendable newsletter email on day one,

and a host that wants different copy overrides the VIEW rather than losing the action.

Instance Method Summary collapse

Instance Method Details

#subscribed(email, name: nil, unsubscribe_url: nil, from: nil) ⇒ Object

email is a raw string: someone can join a mailing list without ever holding an account, so this must not require a User.

unsubscribe_url is OPTIONAL and the line renders only when it is given. A newsletter needs a way out, but a hard-coded dead link is worse than an honest omission — a host wires its real one and the line appears.

from is OPTIONAL on the same terms, and it exists for a reason worth stating: THIS EMAIL IS MARKETING, and the rest of what this engine sends is transactional. A host that keeps a separate marketing address does so to protect the reputation of the address its SIGN-IN LINKS go out on — complaints and unsubscribes against a newsletter must not follow the address someone needs to get back into their account. Without this parameter a host with that separation could not migrate onto this mailer without giving it up, which is a deliverability regression disguised as an adoption.

Omitted, nothing changes: ActionMailer falls back to the default_from the host already configured.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/mailers/studio/newsletter_mailer.rb', line 35

def subscribed(email, name: nil, unsubscribe_url: nil, from: nil)
  @app_name        = Studio.app_name
  @email           = email
  @name            = name.presence
  @unsubscribe_url = unsubscribe_url.presence

  # The mailer passes WHO, not WHAT THE BANNER SAYS. The wording — including
  # whether it greets by name at all — is the operator's, editable on
  # /admin/emails. Handing over a finished header here would make that field
  # accept edits and change nothing.
  @banner = Studio::Banner.for(:newsletter_subscribed, name: @name)
  @banner_alt = "#{@banner&.header} — #{@app_name}"
  # The floor, exactly as UserMailer does it: if no layered artwork is
  # registered the layout renders the flat <img> instead of nothing.
  @banner_url = Studio::EmailCatalog.resolved_url(:newsletter_subscribed)

  # No @cta_* here: this email's template renders no button, and setting
  # ivars a view never reads is how a dead control looks like a live one.
  @body = Studio::EmailCatalog.body(:newsletter_subscribed, name: @name)

  subject = Studio::EmailCatalog.subject_for(:newsletter_subscribed, name: @name) ||
            "You're subscribed to #{@app_name}"
  # Built conditionally rather than passing `from: nil`: ActionMailer treats
  # an explicit nil as a SET header and drops the host's default_from,
  # sending with no From at all.
  headers = { to: email, subject: subject }
  headers[:from] = from if from.present?
  mail(**headers)
end