|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require_relative 'base_api' |
| 4 | +require_relative 'email_log_message' |
| 5 | +require_relative 'email_log_event' |
| 6 | +require_relative 'email_log_event_details' |
| 7 | +require_relative 'email_logs_list_response' |
| 8 | + |
| 9 | +module Mailtrap |
| 10 | + class EmailLogsAPI |
| 11 | + include BaseAPI |
| 12 | + |
| 13 | + self.response_class = EmailLogMessage |
| 14 | + |
| 15 | + # Lists email logs with optional filters and cursor-based pagination. |
| 16 | + # |
| 17 | + # @param filters [Hash, nil] Optional filters. Top-level date keys use string values (ISO 8601); |
| 18 | + # other keys use +{ operator:, value: }+. +value+ can be a single value or an Array for |
| 19 | + # operators that accept multiple values (e.g. +equal+, +not_equal+, +ci_equal+, +ci_not_equal+). |
| 20 | + # Examples: |
| 21 | + # +{ sent_after: "2025-01-01T00:00:00Z", sent_before: "2025-01-31T23:59:59Z" }+ |
| 22 | + # +{ to: { operator: "ci_equal", value: "recipient@example.com" } }+ |
| 23 | + # +{ category: { operator: "equal", value: ["Welcome Email", "Transactional Email"] } }+ |
| 24 | + # @param search_after [String, nil] Message UUID cursor for the next page (from previous +next_page_cursor+) |
| 25 | + # @return [EmailLogsListResponse] messages, total_count, and next_page_cursor |
| 26 | + # @!macro api_errors |
| 27 | + def list(filters: nil, search_after: nil) |
| 28 | + query_params = build_list_query_params(filters:, search_after:) |
| 29 | + |
| 30 | + response = client.get(base_path, query_params) |
| 31 | + |
| 32 | + build_list_response(response) |
| 33 | + end |
| 34 | + |
| 35 | + # Iterates over all email log messages matching the filters, automatically fetching each page. |
| 36 | + # Use this when you want to process every message without manually handling +next_page_cursor+. |
| 37 | + # |
| 38 | + # @param filters [Hash, nil] Same as +list+ |
| 39 | + # @yield [EmailLogMessage] Gives each message from every page when a block is given. |
| 40 | + # @return [Enumerator<EmailLogMessage>] if no block given; otherwise the result of the block |
| 41 | + # @!macro api_errors |
| 42 | + def list_each(filters: nil, &block) |
| 43 | + return to_enum(__method__, filters: filters) unless block |
| 44 | + |
| 45 | + search_after = nil |
| 46 | + loop do |
| 47 | + response = list(filters: filters, search_after: search_after) |
| 48 | + response.messages.each { |message| block.call(message) } |
| 49 | + break if response.next_page_cursor.nil? |
| 50 | + |
| 51 | + search_after = response.next_page_cursor |
| 52 | + end |
| 53 | + end |
| 54 | + |
| 55 | + # Fetches a single email log message by ID. |
| 56 | + # |
| 57 | + # @param sending_message_id [String] Message UUID |
| 58 | + # @return [EmailLogMessage] Message with events and raw_message_url when available |
| 59 | + # @!macro api_errors |
| 60 | + def get(sending_message_id) |
| 61 | + base_get(sending_message_id) |
| 62 | + end |
| 63 | + |
| 64 | + private |
| 65 | + |
| 66 | + def base_path |
| 67 | + "/api/accounts/#{account_id}/email_logs" |
| 68 | + end |
| 69 | + |
| 70 | + def build_list_query_params(filters:, search_after:) |
| 71 | + {}.tap do |params| |
| 72 | + params[:search_after] = search_after if search_after |
| 73 | + params.merge!(flatten_filters(filters)) |
| 74 | + end |
| 75 | + end |
| 76 | + |
| 77 | + # Flattens a filters Hash into query param keys expected by the API (deepObject style). |
| 78 | + # Scalar values => filters[key]; Hashes with :operator/:value => filters[key][operator], filters[key][value]. |
| 79 | + # When :value is an Array, the key is repeated (e.g. filters[category][value]=A&filters[category][value]=B) |
| 80 | + # for operators that accept multiple values (e.g. equal, not_equal, ci_equal, ci_not_equal). |
| 81 | + def flatten_filters(filters) |
| 82 | + return {} if filters.nil? || filters.empty? |
| 83 | + |
| 84 | + filters.each_with_object({}) do |(key, value), result| |
| 85 | + if value.is_a?(Hash) |
| 86 | + flatten_filter_hash(key, value, result) |
| 87 | + else |
| 88 | + result["filters[#{key}]"] = value.to_s |
| 89 | + end |
| 90 | + end |
| 91 | + end |
| 92 | + |
| 93 | + def flatten_filter_hash(parent_key, hash, result) |
| 94 | + hash.each do |key, value| |
| 95 | + if value.is_a?(Array) |
| 96 | + result["filters[#{parent_key}][#{key}][]"] = value.map(&:to_s) |
| 97 | + else |
| 98 | + result["filters[#{parent_key}][#{key}]"] = value.to_s |
| 99 | + end |
| 100 | + end |
| 101 | + end |
| 102 | + |
| 103 | + def build_list_response(response) |
| 104 | + EmailLogsListResponse.new( |
| 105 | + messages: Array(response[:messages]).map { |item| handle_response(item) }, |
| 106 | + total_count: response[:total_count], |
| 107 | + next_page_cursor: response[:next_page_cursor] |
| 108 | + ) |
| 109 | + end |
| 110 | + |
| 111 | + def handle_response(response) |
| 112 | + build_message_entity(response) |
| 113 | + end |
| 114 | + |
| 115 | + def build_message_entity(hash) |
| 116 | + attrs = hash.slice(*EmailLogMessage.members) |
| 117 | + attrs[:events] = build_events(attrs[:events]) if attrs[:events] |
| 118 | + |
| 119 | + EmailLogMessage.new(**attrs) |
| 120 | + end |
| 121 | + |
| 122 | + def build_events(events_array) |
| 123 | + Array(events_array).map do |e| |
| 124 | + EmailLogEvent.new( |
| 125 | + event_type: e[:event_type], |
| 126 | + created_at: e[:created_at], |
| 127 | + details: EmailLogEventDetails.build(e[:event_type], e[:details]) |
| 128 | + ) |
| 129 | + end |
| 130 | + end |
| 131 | + end |
| 132 | +end |
0 commit comments