Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Interfaces

  • AttachmentCollectionInterface
  • AttachmentsHandlerInterface
  • ContactCollectionInterface
  • ContactNameInterface
  • ContactTypeInterface
  • EmailAddressInterface
  • EmailAttachmentInterface
  • EmailCollectionInterface
  • EmailContactInterface
  • EmailContentInterface
  • EmailDeleterInterface
  • EmailFactoryInterface
  • EmailInterface
  • EmailReaderInterface
  • EmailRepositoryInterface
  • EmailServiceInterface
  • EmailSubjectInterface
  • EmailWriterInterface
  • MailerAdapterInterface

Interface EmailInterface

Interface EmailInterface

Direct known implementers

Email

Package: Email\Interfaces
Category: System
Located at SystemServices/Email/Interfaces/Entities/EmailInterface.inc.php

Methods summary

public
# setId( IdType $id )

Sets the ID of an email.

Sets the ID of an email.

Parameters

$id
E-Mail ID.
public IdType
# getId( )

Returns the ID of an email.

Returns the ID of an email.

Returns

IdType
E-Mail ID.
public
# setSender( EmailContactInterface $sender )

Sets the sender of an email.

Sets the sender of an email.

Parameters

$sender
E-Mail sender.
public EmailContactInterface
# getSender( )

Returns the sender of an email

Returns the sender of an email

Returns

EmailContactInterface
E-Mail sender.
public
# setRecipient( EmailContactInterface $recipient )

Sets the recipient of an email.

Sets the recipient of an email.

Parameters

$recipient
E-Mail recipient.
public EmailContactInterface
# getRecipient( )

Returns the recipient of an email.

Returns the recipient of an email.

Returns

EmailContactInterface
E-Mail recipient.
public
# setReplyTo( EmailContactInterface $recipient )

Sets the 'reply to' option value of an email.

Sets the 'reply to' option value of an email.

Parameters

$recipient
E-Mail reply-to.
public EmailContactInterface
# getReplyTo( )

Returns the 'reply to' option value of an email.

Returns the 'reply to' option value of an email.

Returns

EmailContactInterface
E-Mail reply-to.
public
# setSubject( EmailSubjectInterface $subject )

Sets the subject of an email.

Sets the subject of an email.

Parameters

$subject
E-Mail subject.
public EmailSubjectInterface
# getSubject( )

Returns the subject of an email.

Returns the subject of an email.

Returns

EmailSubjectInterface
E-Mail subject.
public
# setContentPlain( EmailContentInterface $contentPlain )

Sets the plain content of an email.

Sets the plain content of an email.

Parameters

$contentPlain
E-Mail plain content.
public EmailContentInterface
# getContentPlain( )

Returns the plain content of an email.

Returns the plain content of an email.

Returns

EmailContentInterface
E-Mail plain content.
public
# setContentHtml( EmailContentInterface $contentHtml )

Sets the HTML content of an email.

Sets the HTML content of an email.

Parameters

$contentHtml
E-Mail HTML content.
public EmailContentInterface
# getContentHtml( )

Returns the HTML content of an email.

Returns the HTML content of an email.

Returns

EmailContentInterface
E-Mail HTML content.
public
# setAttachments( AttachmentCollectionInterface $attachments )

Sets the attachments of an email.

Sets the attachments of an email.

Parameters

$attachments
E-Mail attachments.
public AttachmentCollectionInterface
# getAttachments( )

Returns the attachments of an email.

Returns the attachments of an email.

Returns

AttachmentCollectionInterface
E-Mail attachments.
public
# setBcc( ContactCollectionInterface $bcc )

Sets the BCC of an email.

Sets the BCC of an email.

Parameters

$bcc
E-Mail BCC.
public ContactCollectionInterface
# getBcc( )

Returns the BCC of an email.

Returns the BCC of an email.

Returns

ContactCollectionInterface
E-Mail BCC.
public
# setCc( ContactCollectionInterface $cc )

Sets the CC of an email.

Sets the CC of an email.

Parameters

$cc
E-Mail CC.
public ContactCollectionInterface
# getCc( )

Returns the CC of an email.

Returns the CC of an email.

Returns

ContactCollectionInterface
E-Mail CC.
public
# setPending( boolean $p_isPending )

Sets an email status to pending if true is given, else sent.

Sets an email status to pending if true is given, else sent.

Parameters

$p_isPending
E-Mail pending status.
public boolean
# isPending( )

Returns if an email is pending or sent.

Returns if an email is pending or sent.

Returns

boolean
E-Mail pending status.
public
# setCreationDate( DateTime $creationDate )

Sets the creation date of an email.

Sets the creation date of an email.

Parameters

$creationDate
E-Mail creation date.
public DateTime
# getCreationDate( )

Returns the creation date of an email.

Returns the creation date of an email.

Returns

DateTime
E-Mail creation date.
public
# setSentDate( DateTime $sentDate )

Sets the sent date of an email.

Sets the sent date of an email.

Parameters

$sentDate
E-Mail sent date.
public DateTime
# getSentDate( )

Returns the sent date of an email.

Returns the sent date of an email.

Returns

DateTime
E-Mail sent date.
API documentation generated by ApiGen