Skip to main content
Version: Next

Public Share Notifications

A portal can notify Pimcore Studio users whenever someone creates a public share in it. The notification names the portal, the person who created the share, the share's name, the number of shared items, the expiry date and the public link.

Configure a portal​

Open the portal page document in edit mode and use the Public Share Notifications card:

  • Notify when someone shares data publicly from this portal: turns notifications on for this portal.
  • Recipients: the Studio users and roles to notify. A role notifies every active user that has it. Only users and roles with the Studio notifications permission are offered.

Everyone who can edit the portal page can change both settings.

Nothing is sent while the checkbox is off or no recipient is selected.

What recipients receive​

Notifications are delivered through Studio's notification framework, so each recipient decides how they get them. In Studio under Notifications → Settings, the row Data is shared publicly in a portal (group Portals) has the usual channels:

  • Notify me: an entry in the notification bell.
  • Pop-up: on by default.
  • Email: off by default. Each recipient has to turn it on to receive emails.

The text is translated into each recipient's Studio language.

info

A recipient who loses the Studio notifications permission after being selected is skipped. Emails additionally need an email address on the user, and a running Messenger worker for the pimcore_core transport, which sends Studio's notification emails.

Customization​

The notification is sent by a listener on Pimcore\Bundle\PortalEngineBundle\Event\PublicShare\PublicShareCreatedEvent. Listen to the same event to react to new public shares in your own code, see Events.