Ctct\Components\EmailMarketing\Campaign
Represents a single Campaign in Constant Contact
- Author: Constant Contact
Synopsis
class Campaign
extends Component
{
- // members
- public $id;
- public $name;
- public $subject;
- public $status;
- public $from_name;
- public $from_email;
- public $reply_to_email;
- public $template_type;
- public $created_date;
- public $modified_date;
- public $last_run_date;
- public $next_run_date;
- public $is_permission_reminder_enabled;
- public $permission_reminder_text;
- public $is_view_as_webpage_enabled;
- public $view_as_web_page_text;
- public $view_as_web_page_link_text;
- public $greeting_salutations;
- public $greeting_name;
- public $greeting_string;
- public MessageFooter $message_footer;
- public TrackingSummary $tracking_summary;
- public $email_content;
- public $email_content_format;
- public $style_sheet;
- public $text_content;
- public array $sent_to_contact_lists = ;
- public array $click_through_details = ;
- // methods
- public static Campaign create()
- public static Campaign createSummary()
- public void addList()
- public string toJson()
- // Inherited methods from Component
- protected static mixed getValue()
Hierarchy
Extends
Members
public
- $click_through_details
—
array
Tracking summary data for this email campaign - $created_date
—
string
Date the email campaign was last sent to contacts, in ISO-8601 format - $email_content
—
string
The full HTML or XHTML content of the email campaign - $email_content_format
—
string
Specifies the email campaign message format, valid values: HTML, XHTML - $from_email
—
string
The email address the email campaign originated from, this must be a verified email address for the account owner - $from_name
—
string
Name displayed in the From field to indicate whom the email is from - $greeting_name
—
string
This is the personalized content for each contact that will be used in the greeting - $greeting_salutations
—
string
The salutation used in the email message (e.g. Dear) - $greeting_string
—
string
Specifies the greeting text used if not using greeting_name and greeting_salutations - $id
—
string
Unique identifier for the email campaign - $is_permission_reminder_enabled
—
boolean
If true, displays permission_reminder_text at top of email message - $is_view_as_webpage_enabled
—
string
If true, displays the text and link specified in permission_reminder_text to view web page version of email message - $last_run_date
—
string
Date the email campaign was last run, in ISO-8601 format - $modified_date
—
string
Date the email campaign was last modified, in ISO-8601 format - $name
—
string
Name of the email campaign; each email campaign name must be unique within a user's account - $next_run_date
—
string
Date the email campaign is next scheduled to run and be sent to contacts, in ISO-8601 format - $permission_reminder_text
—
string
Text to be displayed at the top of the email if is_permission_reminder_enabled is true - $reply_to_email
—
string
The reply-to email address for the email campaign, this must be a verified email address for the account owner - $sent_to_contact_lists
—
array
Unique IDs of the contact lists the email campaign message is sent to - $status
—
string
Current status of the email campaign - $style_sheet
—
string
Style sheet used in the email - $subject
—
string
The Subject Line for the email campaign - $template_type
—
string
The template used to create the email campaign - $text_content
—
string
The content for the text-only version of the email campaign which is viewed by recipients whose email client does not accept HTML email - $tracking_summary
—
Ctct\Components\Tracking\TrackingSummary
Campaign Tracking summary data for this campaign - $view_as_web_page_link_text
—
string
Text that will be displayed as the link if is_view_as_webpage_enabled is true - $view_as_web_page_text
—
string
Text to be displayed if is_view_as_webpage_enabled is true
Methods
public
- addList() — Add a contact list to set of lists associated with this email
- create() — Factory method to create a Campaign object from an array
- createSummary() — Factory method to create a Campaign object from an array
- toJson() — Create json used for a POST/PUT request, also handles removing attributes that will cause errors if sent
Inherited from Ctct\Components\Component
protected
- getValue() — Get the requested value from an array, or return the default