Recipients can be produced from entity fields with a service parameter mapping.

See Notifier configuration for more detail on using service parameters.

Service parameter

No entity fields are mapped by default, except the user email field via the User getEmail() method. See more at User email.

Email

Email fields are mapped with notifier.field_mapping.email.

Email fields must be a email field type, or a subclassed field type of \Drupal\Core\Field\Plugin\Field\FieldType\EmailItem.

The parameter takes is an array with zero or more items. Each item requires three keys:

  notifier.field_mapping.email:
    - entity_type: user
      bundle: user
      field_name: email_field

Phone number

Phone number fields are mapped with notifier.field_mapping.sms.

Phone number fields must be a telephone field type, or a subclassed field type of \Drupal\telephone\Plugin\Field\FieldType\TelephoneItem.

The parameter takes is an array with zero or more items. Each item requires three keys:

  notifier.field_mapping.sms:
    - entity_type: user
      bundle: user
      field_name: phone_number

Behavior

Empty values

Empty values will not be used, as determined by a field items' \Drupal\Core\TypedData\ComplexDataInterface::isEmpty() method.

Validation

Values will not be validated at runtime. It is the responsibility of your project to ensure emails field values are well-formed emails accepted by your email provider, and phone number values are accepted values of your SMS provider, etc. For phone numbers, you may opt to use the Telephone validation to validate and enforce field values.

Multi-cardinality values

When mapped fields are multi-cardinality, and multiple field values are present, all non-empty values will be used.

Narrowing values

All non-empty values will be used, per above. If recipients produced from field values need to be culled (removed) due to business logic, consider using a custom event subscriber instead. Then, producing recipients from field values and apply business logic.