PHPFUI/InstaDoc

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public get(?int $limit = NULL, ?string $before_date = NULL, ?string $after_date = NULL) : array

GET a Collection of Email Campaigns

Use this method to list and get details about your email campaigns. By default, this method returns all email campaigns for the user account including deleted email campaigns. To get email campaigns within a date-range, use the after_date and before_date query parameters.

This endpoint does not return campaign activity details for each email campaign in the collection. To get email campaign activity details for a single email campaign, use the GET /emails/{campaign_id} endpoint."

param int $limit Specifies the number of campaigns to display on each page of output that is returned (from return 1 - 500). The default returns 50 campaigns per page.
param string $before_date Use to return email campaigns with updated_at timestamps that are before a specific date and time (in ISO-8601 format). Use with the after_date query parameter to get email campaigns sent within a specific date range.
param string $after_date Use to return email campaigns with last updated_at timestamps that are after a specific date and time (in ISO-8601 format). Use with the before_date query parameter to get email campaigns sent within a specific date range.

public PHPFUI\ConstantContact\Base::getLastError() : string

public PHPFUI\ConstantContact\Base::getResponseText() : string

public PHPFUI\ConstantContact\Base::getStatusCode() : int

public PHPFUI\ConstantContact\Base::next() : array

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

return array filled with next part of the response from the endpoint, or empty if no next.

public post(PHPFUI\ConstantContact\Definition\EmailCampaignComplete $body) : array

POST (Create) a New Email Campaign

Use this method to create a new email campaign. This method also creates new primary_email and permalink email campaign activities and associates them with the new email campaign.

The request body must contain the name property and the email_campaign_activities array. The name must be unique. The email_campaign_activities array contains the main content of your email campaign and must include format_type, from_name, from_email, reply_to_email, subject, and html_content properties. The from_email address you use must use a verified email address for your account. NOTE: If you create an email campaign using a legacy (V7) format, Constant Contact automatically converts it to the newer custom code format.

param \PHPFUI\ConstantContact\Definition\EmailCampaignComplete $body A JSON request body that contains the email content.

public PHPFUI\ConstantContact\Base::success() : bool