Evergage Core API
Options
All
  • Public
  • Public/Protected
  • All
Menu

An email global suppression (ensures Evergage will never email a user).

Hierarchy

  • Entity
    • EmailGlobalSuppression

Index

Properties

emailAddress

emailAddress: string

the email address to be globally suppressed

Optional primaryUserId

primaryUserId: string

the primary ID of the Evergage user that owns emailAddress if one exists

The Profile system service can be used to find the user that owns the email address. This field should always be populated when it is possible.

Optional reason

reason: string

the reason the user is being suppressed

Optional time

time: Date

the time at which the user was globally suppressed; if null in a staged update, the current time will be used

Optional timeSource

timeSource: string

indicates the source of {@link #time} - ProcessingTime (least accurate), FileName, or FileContent (most accurate)

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc