Class: CampaignEmailsController

Inherits:
CrmController show all
Defined in:
app/controllers/campaign_emails_controller.rb

Overview

Controller for campaign emails.

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#attach_template ⇒ Object

Attach a template to a campaign email.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'app/controllers/campaign_emails_controller.rb', line 69

def attach_template
  unless @campaign
    redirect_to campaigns_path, alert: 'Please select a campaign first to link an email template.'
    return
  end

  @campaign_email = @campaign.campaign_emails.new(params[:campaign_email])

  if @campaign_email.email_template && @campaign_email.name.blank?
    @campaign_email.name = @campaign_email.email_template.description.presence ||
                           @campaign_email.email_template.subject
  end

  if @campaign_email.save
    redirect_to [@campaign, @campaign_email], notice: 'Campaign Email was created and linked to the existing template.'
  else
    render action: 'link_template', status: :unprocessable_content
  end
end

#cancel ⇒ void

This method returns an undefined value.

Cancel a paused email transmission (terminal).

Only reachable from transmission_paused. Flips every remaining
pending / queued CampaignDelivery row to cancelled so the
worker's state filter excludes them.

Route: POST /campaign_emails/:id/cancel

See Also:

  • CampaignEmail#cancel_transmission


200
201
202
203
204
205
206
207
 
# File 'app/controllers/campaign_emails_controller.rb', line 200

def cancel
  if @campaign_email.cancel_transmission
    flash[:info] = 'Transmission cancelled. Remaining recipients will not be sent.'
  else
    flash[:error] = 'Unable to cancel transmission. The email must be paused first.'
  end
  redirect_to [@campaign_email.campaign, @campaign_email].compact
end

#create ⇒ Object

Create a new campaign email.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'app/controllers/campaign_emails_controller.rb', line 90

def create
  unless @campaign
    redirect_to campaigns_path, alert: 'Please select a campaign first to create a campaign email.'
    return
  end

  @campaign_email = @campaign.campaign_emails.new(params[:campaign_email])

  # Ensure Redactor 4 is preserved on validation failure
  if @campaign_email.email_template
    @campaign_email.email_template.redactor_4_ready = true
    @campaign_email.email_template.category ||= @campaign.category
  end

  if @campaign_email.save
    redirect_to after_save_path_for(@campaign_email), notice: 'Campaign Email was successfully created.'
  else
    render action: 'new', status: :unprocessable_content
  end
end

#deliveries ⇒ Object

Display campaign email deliveries.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'app/controllers/campaign_emails_controller.rb', line 127

def deliveries
  @pagy_deliveries, @campaign_deliveries = pagy(@campaign_email.view_campaign_deliveries.joins(:audience_member).order(AudienceMember[:email_address]), limit: 50)
  email = params.dig(:q, :email).presence
  combined_state = params.dig(:q, :combined_state).presence
  combined_state_in = params.dig(:q, :combined_state_in).presence

  @campaign_deliveries = @campaign_deliveries.where(AudienceMember[:email_address].eq(email)) if email

  @campaign_deliveries = @campaign_deliveries.where(combined_state: combined_state) if combined_state

  return unless combined_state_in

  @campaign_deliveries = @campaign_deliveries.where(combined_state: combined_state_in)
end

#destroy ⇒ Object

Delete a campaign email.



121
122
123
124
 
# File 'app/controllers/campaign_emails_controller.rb', line 121

def destroy
  @campaign_email.destroy
  redirect_to @campaign_email.campaign || campaigns_path
end

#edit ⇒ Object

Display campaign email for editing.



56
 
# File 'app/controllers/campaign_emails_controller.rb', line 56

def edit; end

#index ⇒ Object

List campaign emails.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'app/controllers/campaign_emails_controller.rb', line 8

def index
  @show_stats = params[:show_stats].to_b
  base_scope = if @campaign
                 @campaign.campaign_emails
               else
                 CampaignEmail.all
               end
  @q = base_scope.ransack(params[:q])
  @q.sorts = 'created_at desc' if @q.sorts.empty?
  @pagy, @campaign_emails = pagy(@q.result, limit: 10)
  respond_to do |format|
    format.html { render layout: should_render_layout? }
    format.turbo_stream
  end
end

#link_template ⇒ Object

Link an existing template to a campaign email.



59
60
61
62
63
64
65
66
 
# File 'app/controllers/campaign_emails_controller.rb', line 59

def link_template
  unless @campaign
    redirect_to campaigns_path, alert: 'Please select a campaign first to link an email template.'
    return
  end

  @campaign_email = CampaignEmail.new(campaign: @campaign)
end

#new ⇒ Object

Initialize a new campaign email.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'app/controllers/campaign_emails_controller.rb', line 38

def new
  unless @campaign
    redirect_to campaigns_path, alert: 'Please select a campaign first to create a campaign email.'
    return
  end

  @campaign_email = CampaignEmail.new(campaign: @campaign)
  @campaign_email.email_template = EmailTemplate.new(
    stylesheet: EmailTemplate::DEFAULT_STYLESHEET,
    template: EmailTemplate::DEFAULT_TEMPLATE,
    category: @campaign.category,
    redactor_4_ready: true,
    # Placeholder body for validation - will be replaced when copying from template or editing
    body: '<p>Edit this email content using the editor below.</p>'
  )
end

#pause ⇒ void

This method returns an undefined value.

Halt an in-flight email transmission.

Remaining pending / queued deliveries are held in place until the
user resumes or cancels. A small number of in-flight emails may still
send (deliveries already inside generate_communication will complete).

Route: POST /campaign_emails/:id/pause

See Also:

  • CampaignEmail#pause_transmission


162
163
164
165
166
167
168
169
 
# File 'app/controllers/campaign_emails_controller.rb', line 162

def pause
  if @campaign_email.pause_transmission
    flash[:info] = 'Transmission paused. Remaining recipients will not be sent until you resume. A small number of in-flight emails may still send.'
  else
    flash[:error] = 'Unable to pause transmission.'
  end
  redirect_to [@campaign_email.campaign, @campaign_email].compact
end

#resume ⇒ void

This method returns an undefined value.

Restart a paused email transmission.

Re-enqueues CampaignDeliveryWorker so the held pending / queued
deliveries are processed. Picks up any template edits made while
paused — templates are rendered at delivery time, not snapshotted.

Route: POST /campaign_emails/:id/resume

See Also:

  • CampaignEmail#resume_transmission


181
182
183
184
185
186
187
188
 
# File 'app/controllers/campaign_emails_controller.rb', line 181

def resume
  if @campaign_email.resume_transmission
    flash[:info] = 'Transmission resumed. Remaining recipients will be processed.'
  else
    flash[:error] = 'Unable to resume transmission.'
  end
  redirect_to [@campaign_email.campaign, @campaign_email].compact
end

#show ⇒ Object

Display campaign email details.



25
26
27
28
29
30
31
32
33
34
35
 
# File 'app/controllers/campaign_emails_controller.rb', line 25

def show
  @remaining_count = @campaign_email.campaign_deliveries.where(state: %w[pending queued]).count if @campaign_email.transmission_paused?

  return if params[:recipient].blank?

  @recipient = params[:recipient].strip
  return unless @recipient.include?('@')

  cp = ContactPoint.where(detail: @recipient).where.not(party_id: nil).first
  @recipient_party_id = cp.party.id if cp
end

#transmit_now ⇒ Object

Transmit campaign email now.



143
144
145
146
147
148
149
150
 
# File 'app/controllers/campaign_emails_controller.rb', line 143

def transmit_now
  if @campaign_email.transmit_now
    flash[:info] = 'Campaign Email is now being transmitted.'
  else
    flash[:error] = 'Unable to transmit Campaign Email.'
  end
  redirect_to [@campaign_email.campaign, @campaign_email].compact
end

#update ⇒ Object

Update a campaign email.



112
113
114
115
116
117
118
 
# File 'app/controllers/campaign_emails_controller.rb', line 112

def update
  if @campaign_email.update(params[:campaign_email])
    redirect_to after_save_path_for(@campaign_email), notice: 'Campaign Email was successfully updated.'
  else
    render action: 'edit', status: :unprocessable_content
  end
end