recordActivity()

Overview

public void function recordActivity(
      required string  messageId           
    , required string  activity            
    ,          struct  extraData           
    ,          string  userIp              
    ,          string  userAgent           
    ,          boolean first                = false
    ,          date    eventDate           
    ,          string  classification       = ""
    ,          boolean recordStats          = true
    ,          boolean announceInterception = true
)

Records an activity performed against an specific sent email. e.g. opened, clicked link, etc.

Arguments

Name	Type	Required	Description
messageId	string	Yes	ID of the message (send log) to record against
activity	string	Yes	The activity type performed (see system ENUM, `emailActivityType`)
extraData	struct	No	Structure of additional data that may be useful in email send log viewer (e.g. URL of clicked link)
userIp	string	No
userAgent	string	No
first	boolean	No (default=false)
eventDate	date	No
classification	string	No (default="")
recordStats	boolean	No (default=true)
announceInterception	boolean	No (default=true)