PHPFUI/InstaDoc

Cloneable Instantiable

Extends

PHPFUI\ConstantContact\Base

Public
Protected

Methods

public __construct ( PHPFUI\ConstantContact\Client $client )

public get ( ? string $confirm_status = NULL , ? string $role_code = NULL , ? string $email_address = NULL ) : array

GET a Collection of Account Email Addresses

Use this method to return a collection of email addresses for the account
associated with your access token. When you Create an Email Campaign, you must use an account
email address with a CONFIRMED status in the email campaign from_email
and reply_to_email headers.

Use the query parameters to filter results. You can filter using confirm_status,
role_code, or email_address. For example, searching with confirm_status=CONFIRMED
returns all confirmed email addresses in the account. This method only
supports one query parameter at a time.

param string $confirm_status Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.
param string $role_code Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.
param string $email_address Use the `email_address` query parameter to search for a specific account email address.

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\AccountEmailInput $body ) : array

POST Add an Account Email Address

Use this method to add a new email address to a Constant Contact account.
If the email address you are adding already exists in the account the
API will return a 409 conflict error.

When you add a new email address to an account, Constant Contact automatically
sends an email to that address with a link to confirm it. After a user
clicks that link, the account email status changes from UNCONFIRMED
to CONFIRMED. You can use confirmed account email addresses in the
email campaign from_email and reply_to_email headers. For more use
case information, see Add an Account Email Address
in the API guide.

param PHPFUI\ConstantContact\Definition\AccountEmailInput $body A JSON request payload containing the new email address you want to add to the Constant Contact account.

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

Properties

Methods

Configuration Code Formating Style Tab Stop Spaces Numbers (0-9.) only