You are here

Home » API reference » Courier 8 » EmailInterface.php

interface EmailInterface in Courier 8

Same name and namespace in other branches
  1. 2.x src/EmailInterface.php \Drupal\courier\EmailInterface

Provides an interface defining a courier_email entity.

Hierarchy

Expanded class hierarchy of EmailInterface

All classes that implement EmailInterface

2 files declare their use of EmailInterface
Email.php in src/Entity/Email.php
Contains \Drupal\courier\Entity\Email.
EmailForm.php in src/Form/EmailForm.php

File

src/EmailInterface.php, line 15
Contains \Drupal\courier\EmailInterface.

Namespace

Drupal\courier
View source 
interface EmailInterface extends ContentEntityInterface, ChannelInterface {

  /**
   * Get the email address.
   *
   * @return string
   *   The email address of the recipient.
   */
  public function getEmailAddress();

  /**
   * Sets email address.
   *
   * @param string $mail
   *   The recipient email address.
   *
   * @return \Drupal\courier\EmailInterface
   *   Returns email for chaining.
   */
  public function setEmailAddress($mail);

  /**
   * Get the name of the recipient.
   *
   * @return string
   *   The name of the recipient.
   */
  public function getRecipientName();

  /**
   * Sets recipient name.
   *
   * @param string $name
   *   The recipients name.
   *
   * @return \Drupal\courier\EmailInterface
   *   Returns email for chaining.
   */
  public function setRecipientName($name);

  /**
   * Get the subject for the email.
   *
   * @return string
   *   The subject.
   */
  public function getSubject();

  /**
   * Set subject of the email.
   *
   * @param string $subject
   *   Subject of the email.
   *
   * @return \Drupal\courier\EmailInterface
   *   Returns email for chaining.
   */
  public function setSubject($subject);

  /**
   * Returns the email body.
   *
   * @return string
   *   Body of the email.
   */
  public function getBody();

  /**
   * Sets the email body.
   *
   * @param string $body
   *   The email body.
   *
   * @return \Drupal\courier\EmailInterface
   *   Returns email for chaining.
   */
  public function setBody($body);

  /**
   * Returns the email body format.
   *
   * @return string
   *   Format of the email body.
   */
  public function getBodyFormat();

  /**
   * Sets the email body format.
   *
   * @param string $format
   *   The email body format.
   *
   * @return \Drupal\courier\EmailInterface
   *   Returns email for chaining.
   */
  public function setBodyFormat($format);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ChannelInterface::applyTokens public function Applies tokens to relevant fields. 2
ChannelInterface::exportTemplate public function Export the message values from this template to configuration values, as found in the 'courier.template.TYPE' config type. Where TYPE is the entity type ID of this entity. 2
ChannelInterface::importTemplate public function Import the message values from configuration values into this entity, as found in the 'courier.template.TYPE' config type. Where TYPE is the entity type ID of this entity. 2
ChannelInterface::isEmpty public function Determine if there is enough data to transmit a message. 2
ChannelInterface::sendMessage public function Sends this message. 1
ChannelInterface::sendMessages public static function Sends messages in bulk. 2
EmailInterface::getBody public function Returns the email body. 1
EmailInterface::getBodyFormat public function Returns the email body format. 1
EmailInterface::getEmailAddress public function Get the email address. 1
EmailInterface::getRecipientName public function Get the name of the recipient. 1
EmailInterface::getSubject public function Get the subject for the email. 1
EmailInterface::setBody public function Sets the email body. 1
EmailInterface::setBodyFormat public function Sets the email body format. 1
EmailInterface::setEmailAddress public function Sets email address. 1
EmailInterface::setRecipientName public function Sets recipient name. 1
EmailInterface::setSubject public function Set subject of the email. 1
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 1
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 1
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
TokenInterface::getTokenOptions function Gets token options as required by \Drupal::token()->replace().
TokenInterface::getTokenValues function Gets token values.
TokenInterface::setTokenOption function Sets a token option.
TokenInterface::setTokenValue function Sets a value to a token type.
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Checks there is a translation for the given language code. 1
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. 1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. 1
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. 1
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. 1