newsletter — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| |
|---|
| Module id | newsletter |
| Name | Newsletter |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-newsletter |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting newsletter.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|
audit_logs | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
cms | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
credentials | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
customers | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
email | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
sales_channels | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
Permissions
| Code | Label | Also needs |
|---|
newsletter:read | View newsletter | — |
newsletter:write | Manage newsletter subscribers, campaigns, automations, and provider | — |
Command palette
| Action | Opens | Permission |
|---|
new-newsletter-campaign | /newsletter/campaigns/new | newsletter:write |
open-newsletter | /newsletter/subscribers | newsletter:read |
open-newsletter-automations | /newsletter/automations | newsletter:read |
open-newsletter-campaigns | /newsletter/campaigns | newsletter:read |
Settings
| Code | Name | Type |
|---|
newsletter.confirm_ttl_hours | Confirmation link TTL (hours) | number |
newsletter.email_credentials | Email credentials | credential_ref |
newsletter.enabled | Newsletter enabled | boolean |
newsletter.opt_in_mode | Opt-in mode | string |
newsletter.rate_limit_per_second | Send rate limit (per second) | number |
newsletter.sender.from_email | Sender email | string |
newsletter.sender.from_name | Sender name | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.