Class BounceFilteringParameters

Describes filtering parameters that can be used when retrieving bounces. When pagination parameters are not specified, default values are set.

Hierarchy

FilteringParameters
- BounceFilteringParameters

Index

Constructors

Properties

count? emailFilter? fromDate? inactive? messageID? messageStream? offset? tag? toDate? type?

Constructors

constructor

new BounceFilteringParameters(count?, offset?, type?, inactive?, emailFilter?, tag?, messageID?, fromDate?, toDate?, messageStream?): BounceFilteringParameters
Parameters
- count: number = 100
- offset: number = 0
- Optional type: BounceType
- Optional inactive: boolean
- Optional emailFilter: string
- Optional tag: string
- Optional messageID: string
- Optional fromDate: string
- Optional toDate: string
- Optional messageStream: string
Returns BounceFilteringParameters
Overrides FilteringParameters.constructor
- Defined in client/models/bounces/BounceFilteringParameters.ts:18

Properties

`Optional` count

count?: number

`Optional` emailFilter

emailFilter?: string

`Optional` fromDate

fromDate?: string

`Optional` inactive

inactive?: boolean

`Optional` messageID

messageID?: string

`Optional` messageStream

messageStream?: string

`Optional` offset

offset?: number

`Optional` tag

tag?: string

`Optional` toDate

toDate?: string

`Optional` type

type?: BounceType