LeKoala\SparkPost\Api\SparkPostApiClient::searchMessageEvents
Search message events
Use the following parameters (default is current timezone, 100 messages for the last 7 days) 'bounce_classes' : delimited list of bounce classification codes to search. 'campaign_ids' : delimited list of campaign ID's to search (i.e. campaign_id used during creation of a transmission). 'delimiter' : Specifies the delimiter for query parameter lists 'events' : delimited list of event types to search. Example: delivery, injection, bounce, delay, policy_rejection, out_of_band, open, click, ... 'friendly_froms' : delimited list of friendly_froms to search. 'from' : Datetime in format of YYYY-MM-DDTHH:MM. 'message_ids' : delimited list of message ID's to search. 'page' : The results page number to return. Used with per_page for paging through results 'per_page' : Number of results to return per page. Must be between 1 and 10,000 (inclusive). 'reason' : Bounce/failure/rejection reason that will be matched using a wildcard (e.g., %reason%) 'recipients' : delimited list of recipients to search. 'subaccounts' : delimited list of subaccount ID’s to search.. 'template_ids' : delimited list of template ID's to search. 'timezone' : Standard timezone identification string 'to' : Datetime in format of YYYY-MM-DDTHH:MM 'transmission_ids' : delimited list of transmission ID's to search (i.e. id generated during creation of a transmission). Result is an array that looks like this [customer_id] => 0000 [delv_method] => esmtp [event_id] => 99997643157770993 [friendly_from] => some@email.ext [ip_address] => 12.34.56.78 [message_id] => abcd2fd71057477a0fa5 [msg_from] => msprvs1=000000Q7Zx0yG=bounces-12345-1234@sparkpostmail1.com [msg_size] => 1234 [num_retries] => 0 [queue_time] => 1234 [raw_rcpt_to] => some@email.ext [rcpt_meta] => Array [rcpt_tags] => Array [rcpt_to] => some@email.ext [routing_domain] => email.ext [subaccount_id] => 0000 [subject] => my test subject [tdate] => 2050-01-01T11:57:36.000Z [template_id] => template_123456789 [template_version] => 0 [transactional] => 1 [transmission_id] => 12234554568854 [type] => delivery [timestamp] => 2050-01-01T11:57:36.000Z
Signature
public function searchMessageEvents([array
$params = ] )
Parameters
$params
— array
Returns
- array