Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Library
      • Tracking
    • Exceptions
    • Services
    • Util
    • WebHooks

Classes

  • Address
  • Contact
  • ContactList
  • CustomField
  • EmailAddress
  • Note
  • Overview
  • Namespace
  • Class

Class EmailAddress

Represents a single EmailAddress of a Contact

Ctct\Components\Component
Extended by Ctct\Components\Contacts\EmailAddress
Namespace: Ctct\Components\Contacts
Package: Components\Contacts
Author: Constant Contact
Located at Components/Contacts/EmailAddress.php
Methods summary
public
# __construct( $email_address = null )
public static Ctct\Components\Contacts\EmailAddress
# create( array $props )

Factory method to create an EmailAddress object from an array

Factory method to create an EmailAddress object from an array

Parameters

$props
  • Associative array of initial properties to set

Returns

Ctct\Components\Contacts\EmailAddress
Methods inherited from Ctct\Components\Component
getValue()
Properties summary
public string $id

Id of the email address

Id of the email address

#
public string $status

Status of the email address, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"

Status of the email address, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"

#
public string $confirm_status

Contact's confirmation status, must be one of "CONFIRMED", "NO_CONFIRMATION_REQUIRED", "UNCONFIRMED"

Contact's confirmation status, must be one of "CONFIRMED", "NO_CONFIRMATION_REQUIRED", "UNCONFIRMED"

#
public string $opt_in_source

Contact's opt in source, must be one of "ACTION_BY_VISITOR", "ACTION_BY_OWNER"

Contact's opt in source, must be one of "ACTION_BY_VISITOR", "ACTION_BY_OWNER"

#
public string $opt_in_date

Contact's opt in date in ISO 8601 format

Contact's opt in date in ISO 8601 format

#
public string $opt_out_date

Contact's opt out date in ISO 8601 format

Contact's opt out date in ISO 8601 format

#
public string $email_address

Email address associated with the contact

Email address associated with the contact

#
API documentation generated by ApiGen