class Email in Courier 8
Same name and namespace in other branches
- 2.x src/Entity/Email.php \Drupal\courier\Entity\Email
Defines storage for a composed email.
Plugin annotation
@ContentEntityType(
id = "courier_email",
label = @Translation("Email"),
handlers = {
"form" = {
"default" = "Drupal\courier\Form\EmailForm",
"add" = "Drupal\courier\Form\EmailForm",
"edit" = "Drupal\courier\Form\EmailForm",
"delete" = "Drupal\courier\Form\EmailDeleteForm",
},
},
admin_permission = "administer courier_email",
base_table = "courier_email",
data_table = "courier_email_field_data",
entity_keys = {
"id" = "id",
"label" = "subject",
},
links = {
"canonical" = "/courier/email/{courier_email}/edit",
"edit-form" = "/courier/email/{courier_email}/edit",
"delete-form" = "/courier/email/{courier_email}/delete",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
- class \Drupal\courier\ChannelBase implements ChannelInterface uses TokenTrait
- class \Drupal\courier\Entity\Email implements EmailInterface
- class \Drupal\courier\ChannelBase implements ChannelInterface uses TokenTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Email
1 file declares its use of Email
- CourierTest.php in src/
Tests/ CourierTest.php - Contains \Drupal\courier\Tests\CourierTest.
1 string reference to 'Email'
File
- src/
Entity/ Email.php, line 44 - Contains \Drupal\courier\Entity\Email.
Namespace
Drupal\courier\EntityView source
class Email extends ChannelBase implements EmailInterface {
/**
* {@inheritdoc}
*/
public function getEmailAddress() {
return $this
->get('mail')->value;
}
/**
* {@inheritdoc}
*/
public function setEmailAddress($mail) {
$this
->set('mail', [
'value' => $mail,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function getRecipientName() {
return $this
->get('name')->value;
}
/**
* {@inheritdoc}
*/
public function setRecipientName($name) {
$this
->set('name', [
'value' => $name,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function getSubject() {
return $this
->get('subject')->value;
}
/**
* {@inheritdoc}
*/
public function setSubject($subject) {
$this
->set('subject', [
'value' => $subject,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function getBody() {
return $this
->get('body')->value;
}
/**
* {@inheritdoc}
*/
public function setBody($body) {
$this
->get('body')->value = $body;
return $this;
}
/**
* {@inheritdoc}
*/
public function getBodyFormat() {
return $this
->get('body')->format;
}
/**
* {@inheritdoc}
*/
public function setBodyFormat($format) {
$this
->get('body')->format = $format;
return $this;
}
/**
* {@inheritdoc}
*/
public function applyTokens() {
$tokens = $this
->getTokenValues();
$options = $this
->getTokenOptions();
$this
->setSubject(\Drupal::token()
->replace($this
->getSubject(), $tokens, $options));
$this
->setBody(\Drupal::token()
->replace($this
->getBody(), $tokens, $options));
return $this;
}
/**
* {@inheritdoc}
*/
function isEmpty() {
return empty($this
->getBody()) || empty($this
->getSubject());
}
/**
* {@inheritdoc}
*
* @param array $options
* Miscellaneous options.
* - reply_to: reply-to email address, or leave unset to use site default.
*/
public static function sendMessages(array $messages, $options = []) {
/* @var \Drupal\courier\EmailInterface[] $messages */
foreach ($messages as $message) {
if (!($email = $message
->getEmailAddress())) {
throw new ChannelFailure('Missing email address for email.');
}
$name = $message
->getRecipientName();
$email_to = !empty($name) ? "{$name} <{$email}>" : $email;
$params = [
'context' => [
'subject' => $message
->getSubject(),
'message' => $message
->getBody(),
],
];
/** @var \Drupal\Core\Mail\MailManagerInterface $mailman */
$mailman = \Drupal::service('plugin.manager.mail');
$mailman
->mail('system', 'courier_email', $email_to, $message
->language()
->getId(), $params, array_key_exists('reply_to', $options) ? $options['reply_to'] : NULL);
}
}
/**
* {@inheritdoc}
*/
public function sendMessage(array $options = []) {
$this
->sendMessages([
$this,
], $options);
}
/**
* {@inheritdoc}
*/
public function importTemplate($content) {
$this
->setSubject($content['subject']);
$this
->setBody($content['body']);
}
/**
* {@inheritdoc}
*/
public function exportTemplate() {
return [
'subject' => $this
->getSubject(),
'body' => $this
->getBody(),
];
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields['id'] = BaseFieldDefinition::create('integer')
->setLabel(t('Email ID'))
->setDescription(t('The email ID.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields['mail'] = BaseFieldDefinition::create('email')
->setLabel(t('Email'))
->setDescription(t('The email address to send this mail.'))
->setDefaultValue('')
->setDisplayOptions('form', [
'type' => 'hidden',
]);
$fields['name'] = BaseFieldDefinition::create('string')
->setLabel(t('Recipient name'))
->setDescription(t('Nickname for the recipient.'));
$fields['subject'] = BaseFieldDefinition::create('string')
->setLabel(t('Subject'))
->setDescription(t('The email subject.'))
->setDefaultValue('')
->setDisplayOptions('form', [
'type' => 'text_textfield',
'weight' => 0,
]);
$fields['body'] = BaseFieldDefinition::create('text_long')
->setLabel(t('Body'))
->setDescription(t('The main content of the email.'))
->setDefaultValue('')
->setDisplayOptions('form', [
'type' => 'text_textarea',
'weight' => 50,
]);
$fields['langcode'] = BaseFieldDefinition::create('language')
->setLabel(t('Language code'))
->setDescription(t('The email language code.'));
return $fields;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ContentEntityBase:: |
protected | property | Language code identifying the entity active language. | |
ContentEntityBase:: |
protected | property | Local cache for the default language code. | |
ContentEntityBase:: |
protected | property | The default langcode entity key. | |
ContentEntityBase:: |
protected | property | Whether the revision translation affected flag has been enforced. | |
ContentEntityBase:: |
protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |
ContentEntityBase:: |
protected | property | Local cache for field definitions. | |
ContentEntityBase:: |
protected | property | The array of fields, each being an instance of FieldItemListInterface. | |
ContentEntityBase:: |
protected static | property | Local cache for fields to skip from the checking for translation changes. | |
ContentEntityBase:: |
protected | property | Indicates whether this is the default revision. | |
ContentEntityBase:: |
protected | property | The language entity key. | |
ContentEntityBase:: |
protected | property | Local cache for the available language objects. | |
ContentEntityBase:: |
protected | property | The loaded revision ID before the new revision was set. | |
ContentEntityBase:: |
protected | property | Boolean indicating whether a new revision should be created on save. | |
ContentEntityBase:: |
protected | property | The revision translation affected entity key. | |
ContentEntityBase:: |
protected | property | Holds translatable entity keys such as the label. | |
ContentEntityBase:: |
protected | property | A flag indicating whether a translation object is being initialized. | |
ContentEntityBase:: |
protected | property | An array of entity translation metadata. | |
ContentEntityBase:: |
protected | property | Whether entity validation was performed. | |
ContentEntityBase:: |
protected | property | Whether entity validation is required before saving the entity. | |
ContentEntityBase:: |
protected | property | The plain data values of the contained fields. | |
ContentEntityBase:: |
public | function |
Checks data value access. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Adds a new translation to the translatable object. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public static | function |
Provides field definitions for a specific bundle. Overrides FieldableEntityInterface:: |
4 |
ContentEntityBase:: |
protected | function | Clear entity translation object cache to remove stale references. | |
ContentEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Gets a field item list. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets the value of the given entity key, if defined. | 1 |
ContentEntityBase:: |
public | function |
Gets the definition of a contained field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all field item lists. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 |
ContentEntityBase:: |
public | function | ||
ContentEntityBase:: |
protected | function | ||
ContentEntityBase:: |
public | function |
Gets the loaded Revision ID of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the revision identifier of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets a translated field. | |
ContentEntityBase:: |
public | function |
Gets a translation of the data. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the languages the data is translated to. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation status. Overrides TranslationStatusInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translatable object referring to the original language. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks there is a translation for the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Instantiates a translation object for an existing translation. | |
ContentEntityBase:: |
public | function |
Checks if this entity is the default revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is the default one. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if this entity is the latest revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether a new revision should be created on save. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is new. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation support status. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityBase:: |
2 |
ContentEntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Reacts to changes to a field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on a revision before it gets saved. Overrides RevisionableInterface:: |
2 |
ContentEntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Removes the translation identified by the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets a field value. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Populates the local cache for the default language code. | |
ContentEntityBase:: |
public | function |
Enforces an entity to be saved as a new revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Updates language for already instantiated fields. | |
ContentEntityBase:: |
public | function |
Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Updates the original values with the interim changes. | |
ContentEntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Validates the currently set values. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Magic method: Implements a deep clone. | |
ContentEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for getting object properties. | |
ContentEntityBase:: |
public | function | Implements the magic method for isset(). | |
ContentEntityBase:: |
public | function | Implements the magic method for setting object properties. | |
ContentEntityBase:: |
public | function |
Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for unset(). | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
Email:: |
public | function |
Applies tokens to relevant fields. Overrides ChannelInterface:: |
|
Email:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Email:: |
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. Overrides ChannelInterface:: |
|
Email:: |
public | function |
Returns the email body. Overrides EmailInterface:: |
|
Email:: |
public | function |
Returns the email body format. Overrides EmailInterface:: |
|
Email:: |
public | function |
Get the email address. Overrides EmailInterface:: |
|
Email:: |
public | function |
Get the name of the recipient. Overrides EmailInterface:: |
|
Email:: |
public | function |
Get the subject for the email. Overrides EmailInterface:: |
|
Email:: |
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. Overrides ChannelInterface:: |
|
Email:: |
function |
Determine if there is enough data to transmit a message. Overrides ChannelInterface:: |
||
Email:: |
public | function |
Sends this message. Overrides ChannelBase:: |
|
Email:: |
public static | function |
Overrides ChannelInterface:: |
|
Email:: |
public | function |
Sets the email body. Overrides EmailInterface:: |
|
Email:: |
public | function |
Sets the email body format. Overrides EmailInterface:: |
|
Email:: |
public | function |
Sets email address. Overrides EmailInterface:: |
|
Email:: |
public | function |
Sets recipient name. Overrides EmailInterface:: |
|
Email:: |
public | function |
Set subject of the email. Overrides EmailInterface:: |
|
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
protected static | function | Invalidates an entity's cache tags upon delete. | 1 |
EntityBase:: |
protected | function | Invalidates an entity's cache tags upon save. | 1 |
EntityBase:: |
public | function |
Determines whether the entity is new. Overrides EntityInterface:: |
2 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityInterface:: |
3 |
EntityBase:: |
public | function |
Sets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityChangesDetectionTrait:: |
protected | function | Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
TokenTrait:: |
protected | property | Token values keyed by token type. | |
TokenTrait:: |
protected | property | Token options to pass to replace calls. | |
TokenTrait:: |
function | Implements \Drupal\courier\TokenInterface::getTokenOptions(). | ||
TokenTrait:: |
function | Implements \Drupal\courier\TokenInterface::getTokenValues(). | ||
TokenTrait:: |
function | Implements \Drupal\courier\TokenInterface::setTokenOption(). | ||
TokenTrait:: |
function | Implements \Drupal\courier\TokenInterface::setTokenValue(). | ||
TranslationStatusInterface:: |
constant | Status code identifying a newly created translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying an existing translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying a removed translation. |