From e3e16eaa342583c843a2513009acd47d5ed16cc2 Mon Sep 17 00:00:00 2001 From: admin Date: Tue, 22 Mar 2022 18:09:09 +0530 Subject: [PATCH] Update documentation for retrieving list of filtered emails --- USAGE.md | 30 ++++++++++++++++++++----- examples/emailactivity/emailactivity.rb | 26 ++++++++++++++++----- 2 files changed, 44 insertions(+), 12 deletions(-) diff --git a/USAGE.md b/USAGE.md index f5b14771..5c304238 100644 --- a/USAGE.md +++ b/USAGE.md @@ -1788,14 +1788,32 @@ For information about building combined queries, see [Building compound Email Ac ### GET /messages ```ruby -require 'erb' - filter_key = 'to_email' -filter_operator = ERB::Util.url_encode('=') -filter_value = 'testing@sendgrid.net' -filter_value = ERB::Util.url_encode(format('"%s"', filter_value)) +filter_operator = '=' +filter_value = "'testing@sendgrid.net'" +query_params = {} +query_params['query'] = "#{filter_key}#{filter_operator}#{filter_value}" +query_params['limit'] = '1' + +params = query_params +response = sg.client.messages.get(query_params: params) +puts response.status_code +puts response.body +puts response.headers +``` + +### Filter messages by unique arguments + +For information about unique arguments, see [Sendgrid Unique Arguments](https://docs.sendgrid.com/for-developers/sending-email/unique-arguments) + +For passing unique arguments when sending emails, refer to [Sending Custom Args Example](https://github.com/sendgrid/sendgrid-ruby/blob/main/examples/helpers/mail/example.rb#L41) + +```ruby +filter_key = "unique_args['user_id']" +filter_operator = '=' +filter_value = "'123456789'" query_params = {} -query_params['query'] = format("%s%s%s", filter_key, filter_operator, filter_value) +query_params['query'] = "#{filter_key}#{filter_operator}#{filter_value}" query_params['limit'] = '1' params = query_params diff --git a/examples/emailactivity/emailactivity.rb b/examples/emailactivity/emailactivity.rb index 5485f6cf..0cc3ab52 100644 --- a/examples/emailactivity/emailactivity.rb +++ b/examples/emailactivity/emailactivity.rb @@ -6,14 +6,28 @@ # Filter all messages # # GET /messages # -require 'erb' - filter_key = 'to_email' -filter_operator = ERB::Util.url_encode('=') -filter_value = 'testing@sendgrid.net' -filter_value = ERB::Util.url_encode(format('"%s"', filter_value)) +filter_operator = '=' +filter_value = "'testing@sendgrid.net'" +query_params = {} +query_params['query'] = "#{filter_key}#{filter_operator}#{filter_value}" +query_params['limit'] = '1' + +params = query_params +response = sg.client.messages.get(query_params: params) +puts response.status_code +puts response.body +puts response.headers + +################################################## +# Filter messages by unique args # +# GET /messages # + +filter_key = "unique_args['user_id']" +filter_operator = '=' +filter_value = "'123456789'" query_params = {} -query_params['query'] = format("%s%s%s", filter_key, filter_operator, filter_value) +query_params['query'] = "#{filter_key}#{filter_operator}#{filter_value}" query_params['limit'] = '1' params = query_params