Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • Email
  • EmailAttachment
  • EmailContact

Class EmailContact

Class EmailContact

Represents a contact (sender/recipient) that participates in an email entity.

EmailContact implements EmailContactInterface
Package: Email\Entities
Category: System
Located at Services/System/Email/Entities/EmailContact.inc.php

Methods summary

public
# __construct( EmailAddressInterface $emailAddress = null, ContactTypeInterface $contactType = null, ContactNameInterface $contactName = null )

Constructor

Constructor

Parameters

$emailAddress
(optional) E-Mail address.
$contactType
$contactName (optional) E-Mail contact type.
$contactName
$contactType (optional) E-Mail contact name.
public string
# __toString( )

Return contact information as a string.

Return contact information as a string.

Example Output: 'John Doe email@address.com'

Returns

string
Converted string.
public string
# getEmailAddress( )

Returns an email address.

Returns an email address.

Returns

string
E-Mail address.

Implementation of

EmailContactInterface::getEmailAddress()
public
# setEmailAddress( EmailAddressInterface $emailAddress )

Sets an email address.

Sets an email address.

Parameters

$emailAddress
E-Mail address.

Implementation of

EmailContactInterface::setEmailAddress()
public string
# getContactName( )

Returns the contact name of an email.

Returns the contact name of an email.

Returns

string
E-Mail contact name.

Implementation of

EmailContactInterface::getContactName()
public
# setContactName( ContactNameInterface $contactName )

Sets the contact name of an email.

Sets the contact name of an email.

Parameters

$contactName
E-Mail contact name.

Implementation of

EmailContactInterface::setContactName()
public ContactTypeInterface
# getContactType( )

Returns the contact type of an email.

Returns the contact type of an email.

Returns

ContactTypeInterface
E-Mail contact type.

Implementation of

EmailContactInterface::getContactType()
public
# setContactType( ContactTypeInterface $contactType )

Sets the contact type of an email.

Sets the contact type of an email.

Parameters

$contactType
E-Mail contact type.

Implementation of

EmailContactInterface::setContactType()

Properties summary

protected EmailAddressInterface $emailAddress

E-Mail address.

E-Mail address.

#
protected ContactTypeInterface $contactType

E-Mail contact type.

E-Mail contact type.

#
protected ContactNameInterface $contactName

E-Mail contact name.

E-Mail contact name.

#
API documentation generated by ApiGen