Description
Get sent messages processed by our system.
Params
Name | Type | Description |
---|---|---|
apiKey | string | API key previously generated. |
offset | integer | Optional parameter to specify offset. |
count | integer | Optional parameter to specify the number of records. If not specified, it's 100. The maximum allowed value is 10000. Numbers bigger than 10000 are automatically reduced to 10000. |
string | Optional parameter to search for rcpt's email. | |
startDate | string | Optional parameter for start date. Must be in the following format: YYYY-MM-DD HH:MM:SS. |
endDate | string | Optional parameter for end date. Must be in the following format: YYYY-MM-DD HH:MM:SS. |
mailingList | integer | Optional parameter by mailing list. |
result | string | Optional parameter by result. Valid values are: "b" (bounced), "d" (delivered), "i" (ignored) and "s" (soft bounced). |
spamReported | boolean | Optional parameter to search for messages reported as spam. |
smtpTags | array | Optional parameter to search for messages with specific smtp tags. You must be provide an array of smtp tags ids. |
sortField | string | Optional parameter to specify a search field. |
sortOrder | string | Optional parameter to specify a sort order. Accepted values are ASC and DESC (default). |
Returned data
Type: array
Description: Return array with mailboxes data.
Json sample code
Json sample code is not available.
Result of API call
API call result sample code is not available.