Class Campaign

Represents a single Campaign in Constant Contact

Ctct\Components\EmailMarketing\Campaign

Namespace: Ctct\Components\EmailMarketing
Package: Components\EmailMarketing
Author: Constant Contact
Located at Components/EmailMarketing/Campaign.php

Methods summary
`public static Ctct\Components\EmailMarketing\Campaign`	# `create( array $props )` Factory method to create a Campaign object from an array Factory method to create a Campaign object from an array Parameters `$props` associative array of initial properties to set Returns `Ctct\Components\EmailMarketing\Campaign`
`public static Ctct\Components\EmailMarketing\Campaign`	# `createSummary( array $props )` Factory method to create a Campaign object from an array Factory method to create a Campaign object from an array Parameters `$props` associative array of initial properties to set Returns `Ctct\Components\EmailMarketing\Campaign`
`public`	# `addList( mixed $contact_list )` Add a contact list to set of lists associated with this email Add a contact list to set of lists associated with this email Parameters `$contact_list` Contact list id, or ContactList object Throws `Ctct\Exceptions\IllegalArgumentException`
`public string`	# `toJson( )` Create json used for a POST/PUT request, also handles removing attributes that will cause errors if sent Create json used for a POST/PUT request, also handles removing attributes that will cause errors if sent Returns string

Methods inherited from Ctct\Components\Component
`getValue()`

Properties summary
`public string`	`$id` Unique identifier for the email campaign 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 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 The Subject Line for the email campaign	#
`public string`	`$status` Current status of the email campaign Current status of the email campaign	#
`public string`	`$from_name` Name displayed in the From field to indicate whom the email is from 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 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 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 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 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 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 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 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 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 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 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 Text to be displayed if is_view_as_webpage_enabled is true	#
`public string`	`$view_as_web_page_link_text` Text that will be displayed as the link if is_view_as_webpage_enabled is true Text that will be displayed 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) 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 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 Specifies the greeting text used if not using greeting_name and greeting_salutations	#
`public Ctct\Components\EmailMarketing\MessageFooter`	`$message_footer` Defines the content of the email campaign message footer Defines the content of the email campaign message footer	#
`public Ctct\Components\Tracking\TrackingSummary`	`$tracking_summary` Campaign Tracking summary data for this campaign Campaign Tracking summary data for this campaign	#
`public string`	`$email_content` The full HTML or XHTML content of the email campaign 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 Specifies the email campaign message format, valid values: HTML, XHTML	#
`public string`	`$style_sheet` Style sheet used in the email 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 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` Unique IDs of the contact lists the email campaign message is sent to Unique IDs of the contact lists the email campaign message is sent to	# `array()`
`public array`	`$click_through_details` Tracking summary data for this email campaign Tracking summary data for this email campaign	# `array()`
`public string`	`$permalink_url` URL of the permalink for this email campaign if it exists URL of the permalink for this email campaign if it exists	#

Namespaces

Classes

Class Campaign

Parameters

Returns

Parameters

Returns

Parameters

Throws

Returns