SuppressionListReader
open class SuppressionListReader<T> : ModeledRequest<[T], SuppressionListReaderParameters> where T : EmailEventRepresentable, T : Decodable
The SuppressionListReader
class is base class inherited by requests that
retrieve entries from a supression list. You should not use this class
directly.
-
Initializes the request with a specific email to look for in the bounce list.
Declaration
Swift
public convenience init(email: String)
Parameters
email
The email address to look for in the bounce list.
-
Initializes the request to retrieve a list of bounces.
Declaration
Swift
public convenience init(start: Date? = nil, end: Date? = nil, page: Page? = nil)
Parameters
start
Limits the search to a specific start time for the event.
end
Limits the search to a specific end time for the event.
range
A range of dates to search between If
nil
, the entire bounce list will be searched.page
A
Page
instance to limit the search to a specific page. Thelimit
value cannot exceed 500. If not specified, the limit will be set to 500 and the offset will be set to 0.
-
Validates that the
limit
value isn’t over 500.Declaration
Swift
open override func validate() throws