Class Campaign
Represents a single Campaign in Constant Contact
- Ctct\Components\Component
-
Ctct\Components\EmailMarketing\Campaign
Package: Components\EmailMarketing
Author: Constant Contact
Located at Ctct/Components/EmailMarketing/Campaign.php
public static
|
|
public static
|
|
public
|
|
public
string
|
getValue()
|
public
string
|
$id | |
#
Unique identifier for the email campaign |
public
string
|
$name | |
#
Name of the email campaign; each email campaign name must be unique within a user's account |
public
string
|
$subject | |
#
The Subject Line for the email campaign |
public
string
|
$status | |
#
Current status of the email campaign |
public
string
|
$from_name | |
#
Name displayed in the From field to indicate whom the email is from |
public
string
|
$from_email | |
#
The email address the email campaign originated from, this must be a verified email address for the account owner |
public
string
|
$reply_to_email | |
#
The reply-to email address for the email campaign, this must be a verified email address for the account owner |
public
string
|
$template_type | |
#
The template used to create the email campaign |
public
string
|
$created_date | |
#
Date the email campaign was last sent to contacts, in ISO-8601 format |
public
string
|
$modified_date | |
#
Date the email campaign was last modified, in ISO-8601 format |
public
string
|
$last_run_date | |
#
Date the email campaign was last run, in ISO-8601 format |
public
string
|
$next_run_date | |
#
Date the email campaign is next scheduled to run and be sent to contacts, in ISO-8601 format |
public
boolean
|
$is_permission_reminder_enabled | |
#
If true, displays permission_reminder_text at top of email message |
public
string
|
$permission_reminder_text | |
#
Text to be displayed at the top of the email if is_permission_reminder_enabled is true |
public
string
|
$is_view_as_webpage_enabled | |
#
If true, displays the text and link specified in permission_reminder_text to view web page version of email message |
public
string
|
$view_as_web_page_text | |
#
Text to be displayed if is_view_as_webpage_enabled is true |
public
string
|
$view_as_web_page_link_text | |
#
Text that will be dispalyed as the link if is_view_as_webpage_enabled is true |
public
string
|
$greeting_salutations | |
#
The salutation used in the email message (e.g. Dear) |
public
string
|
$greeting_name | |
#
This is the personalized content for each contact that will be used in the greeting |
public
string
|
$greeting_string | |
#
Specifies the greeting text used if not using greeting_name and greeting_salutations |
public
|
$message_footer | |
#
Defines the content of the email campaign message footer |
public
|
$tracking_summary | |
#
Campaign Tracking summary data for this campaign |
public
string
|
$email_content | |
#
The full HTML or XHTML content of the email campaign |
public
string
|
$email_content_format | |
#
Specifies the email campaign message format, valid values: HTML, XHTML |
public
string
|
$style_sheet | |
#
Style sheet used in the email |
public
string
|
$text_content | |
#
The content for the text-only version of the email campaign which is viewed by recipients whose email client does not accept HTML email |
public
array
|
$sent_to_contact_lists | array() |
#
Unique IDs of the contact lists the email campaign message is sent to |
public
array
|
$click_through_details | array() |
#
Tracking summary data for this email campaign |