Wraps a platform EmailDeliveryEvent as a FunnelEvent so an email being delivered, failing, opened or converted can drive a marketing funnel. Created by FunnelManager when an EmailDeliveryEvent is raised for an organisation with an active funnels app, then passed to onFunnelEvent so funnel goals such as EmailInteractionGoal and EmailResultGoal can match against it and advance a lead through the funnel.
Group: Journeys
Implements: FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| action | EmailDeliveryAction | The delivery action this event reports, such as delivered, failed, opened or converted. |
| emailItem | EmailItem | The email item whose delivery status this event reports. |
| leadProfile | Profile | The profile the email item was sent to, when its recipient is a profile rather than an organisation. |
| relatedLead | Lead | Not used by this event; an email delivery event has no directly related lead. |
| trigger | BaseEmailJob | The email job that originally queued the email whose delivery status this event reports. |
| triggeredGoal | Class<? extends Goal> | Not used by this event; it declares multiple triggered goals via getTriggeredGoals instead. |
| triggeredGoals | List<Class<? extends Goal>> | The goal types that can be triggered by this event, used to limit which funnels are scanned to those using EmailInteractionGoal or EmailResultGoal. |
Methods
toProps()
Returns: Map<String,Serializable>
Builds the event properties map used by the funnels engine and exposed to JS, including the delivery action name and a URN reference to the email item involved.
getTrigger()
Returns: BaseEmailJob
The email job that originally queued the email whose delivery status this event reports.
getLeadProfile()
Returns: Profile
The profile the email item was sent to, when its recipient is a profile rather than an organisation.
getAction()
Returns: EmailDeliveryAction
The delivery action this event reports, such as delivered, failed, opened or converted.
getEmailItem()
Returns: EmailItem
The email item whose delivery status this event reports.
getRelatedLead()
Returns: Lead
Not used by this event; an email delivery event has no directly related lead.
getTriggeredGoal()
Returns: Class<? extends Goal>
Not used by this event; it declares multiple triggered goals via getTriggeredGoals instead.
getTriggeredGoals()
Returns: List<Class<? extends Goal>>
The goal types that can be triggered by this event, used to limit which funnels are scanned to those using EmailInteractionGoal or EmailResultGoal.