Mailing Model

This document describes the data model of the Mailer::Mailing.

Overview

• A Mailing may refer to a MailingTemplate which is used for rendering the mailing content.
• A Mailing may make use of MailingComponents. Components are referred to using the component merge tag.
• A Mailing may contain MailingLinks.
• For each sent email a MailingLog entry is created.
• MailingVariations may be defined using MailingTests and and MailingTestCasess.

Mailing Variations

• For defining MailingVariations a mailing may contain MailingTests.
• A MailingTest is referred to by a test merge tag.
• For each MailingTest one or more MailingTestCases may be defined. Each MailingTestCase defines a possible value for the test merge tag.
• A MailingVariation is a combination of MailingTestCases and has exactly one MailingTestCase for each MailingTest defined in the mailing.

At the moment, a MailingVariation is defined for each possible combination of MailingTestCases. The Vision Doc contains ideas about the possibility to allow more user defined MailingVariations in order to define testing themes.

Mailing Attributes

Identifiers

• id bigint NOT NULL
• external_id integer

Mailing Metadata

• name text
• subject text
• from text
• from_name text
• from_email text

Technical Metadata

• created_at timestamp without time zone,
• updated_at timestamp without time zone,

Mailing Content

• body_html text
• body_plain text
• body_markdown text
• parsed_html text

Recurring Mailings

• recurring_schedule text
• recurring_at time without time zone
• recurring_day integer
• recurring_last_run_started timestamp without time zone
• recurring boolean DEFAULT false
• recurring_max_recipients_per_send integer

Statistics

• sent_count integer
• member_count integer
• total_opens integer
• total_clicks integer
• total_spam_reports integer
• total_bounces integer
• total_unsubscribes integer
• send_time double precision
• started_send_at timestamp without time zone
• finished_sending_at timestamp without time zone

References

• mailing_template_id integer
• campaign_id integer
• list_id integer
• search_id integer
• parent_mailing_id integer

Other Fields

• scheduled_for timestamp without time zone
• recipients_synced boolean
• priority boolean
• paused boolean
• aborted boolean