Skip to main content

Email Editor Filters

Required add-on: Email Editor

Filters from the Email Editor add-on. These fire only while it is installed and active. Every other area is listed on the Filter Hooks Reference. Each name links to its own page, with its parameters, notes and an example.

Change the Email Editor’s designs and wrapper, saved versions, exports, link parameters, the player card image, episode-notification recipients and open and click tracking.

Filter Description
benecaster_player_card_image_args Filters how an episode’s player card is drawn: the image {{player_image}} shows in an episode notification, the episode’s artwork with a darkening layer and a round play button.
benecaster_email_utm_params Filters the UTM tags added to one kind of link in a broadcast or an episode notification.
benecaster_email_editor_template_html Filters the body HTML a design rendered to, before it is sanitized and stored.
benecaster_email_editor_wrapper_html Filters the wrapper HTML a show’s branding rendered to, before it is sanitized and stored.
benecaster_email_editor_default_design Filters what an email opens on in the Email Editor when nothing is stored for it.
benecaster_email_editor_template_versions_kept Filters how many earlier versions of an email design are kept.
benecaster_email_editor_export_file Filters a design file before download.
benecaster_email_editor_episode_notification_recipients Filters who is told about an episode, once, as its notification starts sending from cron.
benecaster_email_editor_episode_notification_is_new Filters whether an episode is new enough to announce, asked before its notification is recorded.
benecaster_email_editor_engagement Filters what benecaster_email_editor_get_engagement() answers for a show: each episode notification and broadcast, newest first, with how many it reached, opened…
benecaster_email_editor_engagement_retention_days Filters how many days a send’s open and click records are kept after the send.

See Also

Need this built rather than just documented? See our services →