mailosaur 7.11.0 → 7.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6102a62b1dead548c4a915faaa7e5d11fefc16c10850ccee5482c9974ab656df
-  data.tar.gz: 9005be36f38c933f9ada0df3312fc23dcffd74c6611d93ef300277ab9c78a0bb
+  metadata.gz: 0c417909e984bf0a87b874005ad64189ad558f7d84c684fb611f67acbb65e4c0
+  data.tar.gz: 14b33b02313b33441b8b81a38b20a076a4f4d4f3cf9d75c10bf647e19e7f9225
 SHA512:
-  metadata.gz: 43b69b34cae04d096a6c2a7d16275d83b98cd3b9d9a876e6512b4c99ad85eb59c5c4830ca3c3b983e0988037c522e847c7297125175eb5e5240a1aabba857403
-  data.tar.gz: f1cf79f34626e7645ac92a8eef78c9b7d535c5c765170318b03cde0e4385a3a5df82a00b71e3019cb2517b4021c0d5fde7ed7dfeaddeb7b289eff491eea2c029
+  metadata.gz: f3ee70bc3325a97b85affc84f2ed0e72ed6e7ec02bb684fed6894d88ad4a4b74b46e593ac07b6a6ba6e3a1458ef76576cfb715096c04f971a0c2c45a336bf355
+  data.tar.gz: e35f4d3da9895285738241c72f8aa0b40b7da76ed298f83cae7a007222386ec20bdaee136f4c3658f94823786568dc553db05418f8a4da56627fb14bb8412290

data/lib/Mailosaur/files.rb

@@ -43,5 +43,21 @@ module Mailosaur
       @handle_http_error.call(response) unless response.status == 200
       response.body
     end
+
+    #
+    # Download an email preview
+    #
+    # Downloads a screenshot of your email rendered in a real email client. Simply supply
+    # the unique identifier for the required preview.
+    #
+    # @param id The identifier of the email preview to be downloaded.
+    #
+    # @return [NOT_IMPLEMENTED] operation results.
+    #
+    def get_preview(id)
+      response = conn.get "api/files/previews/#{id}"
+      @handle_http_error.call(response) unless response.status == 200
+      response.body
+    end
   end
 end

data/lib/Mailosaur/messages.rb

@@ -27,14 +27,16 @@ module Mailosaur
     # (in milliseconds).
     # @param received_after [DateTime] Limits results to only messages received
     # after this date/time.
+    # @param dir [String] Optionally limits results based on the direction (`Sent`
+    # or `Received`), with the default being `Received`.
     #
     # @return [Message] operation results.
     #
-    def get(server, criteria, timeout: 10_000, received_after: DateTime.now - (1.0 / 24))
+    def get(server, criteria, timeout: 10_000, received_after: DateTime.now - (1.0 / 24), dir: nil)
       # Defaults timeout to 10s, receivedAfter to 1h
       raise Mailosaur::MailosaurError.new('Must provide a valid Server ID.', 'invalid_request') if server.length != 8
 
-      result = search(server, criteria, page: 0, items_per_page: 1, timeout: timeout, received_after: received_after)
+      result = search(server, criteria, page: 0, items_per_page: 1, timeout: timeout, received_after: received_after, dir: dir)
       get_by_id(result.items[0].id)
     end
 
@@ -83,14 +85,17 @@ module Mailosaur
     # returned per page. Can be set between 1 and 1000 items, the default is 50.
     # @param received_after [DateTime] Limits results to only messages received
     # after this date/time.
+    # @param dir [String] Optionally limits results based on the direction (`Sent`
+    # or `Received`), with the default being `Received`.
     #
     # @return [MessageListResult] operation results.
     #
-    def list(server, page: nil, items_per_page: nil, received_after: nil)
+    def list(server, page: nil, items_per_page: nil, received_after: nil, dir: nil)
       url = "api/messages?server=#{server}"
       url += page ? "&page=#{page}" : ''
       url += items_per_page ? "&itemsPerPage=#{items_per_page}" : ''
       url += received_after ? "&receivedAfter=#{CGI.escape(received_after.iso8601)}" : ''
+      url += dir ? "&dir=#{dir}" : ''
 
       response = conn.get url
 
@@ -134,14 +139,17 @@ module Mailosaur
     # after this date/time.
     # @param error_on_timeout [Boolean] When set to false, an error will not be
     # throw if timeout is reached (default: true).
+    # @param dir [String] Optionally limits results based on the direction (`Sent`
+    # or `Received`), with the default being `Received`.
     #
     # @return [MessageListResult] operation results.
     #
-    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true)
+    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true, dir: nil)
       url = "api/messages/search?server=#{server}"
       url += page ? "&page=#{page}" : ''
       url += items_per_page ? "&itemsPerPage=#{items_per_page}" : ''
       url += received_after ? "&receivedAfter=#{CGI.escape(received_after.iso8601)}" : ''
+      url += dir ? "&dir=#{dir}" : ''
 
       poll_count = 0
       start_time = Time.now.to_f
@@ -226,5 +234,22 @@ module Mailosaur
       model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
+
+    #
+    # Generate email previews.
+    #
+    # Generates screenshots of an email rendered in the specified email clients.
+    #
+    # @param id [String] The identifier of the email to preview.
+    # @param options [PreviewRequestOptions] The options with which to generate previews.
+    #
+    # @return [PreviewListResult] operation result.
+    #
+    def generate_previews(id, options)
+      response = conn.post "api/messages/#{id}/previews", options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::PreviewListResult.new(model)
+    end
   end
 end

data/lib/Mailosaur/models/message.rb

@@ -3,20 +3,21 @@ module Mailosaur
     class Message < BaseModel
       def initialize(data = {})
         @id = data['id']
+        @type = data['type']
         @from = []
-        (data['from'] || []).each do |i| @from << Mailosaur::Models::MessageAddress.new(i) end
+        (data['from'] || []).each { |i| @from << Mailosaur::Models::MessageAddress.new(i) }
         @to = []
-        (data['to'] || []).each do |i| @to << Mailosaur::Models::MessageAddress.new(i) end
+        (data['to'] || []).each { |i| @to << Mailosaur::Models::MessageAddress.new(i) }
         @cc = []
-        (data['cc'] || []).each do |i| @cc << Mailosaur::Models::MessageAddress.new(i) end
+        (data['cc'] || []).each { |i| @cc << Mailosaur::Models::MessageAddress.new(i) }
         @bcc = []
-        (data['bcc'] || []).each do |i| @bcc << Mailosaur::Models::MessageAddress.new(i) end
+        (data['bcc'] || []).each { |i| @bcc << Mailosaur::Models::MessageAddress.new(i) }
         @received = DateTime.parse(data['received'])
         @subject = data['subject']
         @html = Mailosaur::Models::MessageContent.new(data['html'])
         @text = Mailosaur::Models::MessageContent.new(data['text'])
         @attachments = []
-        (data['attachments'] || []).each do |i| @attachments << Mailosaur::Models::Attachment.new(i) end
+        (data['attachments'] || []).each { |i| @attachments << Mailosaur::Models::Attachment.new(i) }
         @metadata = Mailosaur::Models::Metadata.new(data['metadata'])
         @server = data['server']
       end
@@ -24,6 +25,9 @@ module Mailosaur
       # @return Unique identifier for the message.
       attr_accessor :id
 
+      # @return The type of message.
+      attr_accessor :type
+
       # @return [Array<MessageAddress>] The sender of the message.
       attr_accessor :from
 

data/lib/Mailosaur/models/message_summary.rb

@@ -3,15 +3,16 @@ module Mailosaur
     class MessageSummary < BaseModel
       def initialize(data = {})
         @id = data['id']
+        @type = data['type']
         @server = data['server']
         @from = []
-        (data['from'] || []).each do |i| @from << Mailosaur::Models::MessageAddress.new(i) end
+        (data['from'] || []).each { |i| @from << Mailosaur::Models::MessageAddress.new(i) }
         @to = []
-        (data['to'] || []).each do |i| @to << Mailosaur::Models::MessageAddress.new(i) end
+        (data['to'] || []).each { |i| @to << Mailosaur::Models::MessageAddress.new(i) }
         @cc = []
-        (data['cc'] || []).each do |i| @cc << Mailosaur::Models::MessageAddress.new(i) end
+        (data['cc'] || []).each { |i| @cc << Mailosaur::Models::MessageAddress.new(i) }
         @bcc = []
-        (data['bcc'] || []).each do |i| @bcc << Mailosaur::Models::MessageAddress.new(i) end
+        (data['bcc'] || []).each { |i| @bcc << Mailosaur::Models::MessageAddress.new(i) }
         @received = DateTime.parse(data['received'])
         @subject = data['subject']
         @summary = data['summary']
@@ -21,6 +22,9 @@ module Mailosaur
       # @return
       attr_accessor :id
 
+      # @return
+      attr_accessor :type
+
       # @return [String]
       attr_accessor :server
 

data/lib/Mailosaur/models/preview.rb

@@ -0,0 +1,20 @@
+module Mailosaur
+  module Models
+    class Preview < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @email_client = data['emailClient']
+        @disable_images = data['disableImages']
+      end
+
+      # @return [String] Unique identifier for the email preview.
+      attr_accessor :id
+
+      # @return [String] The email client the preview was generated with.
+      attr_accessor :email_client
+
+      # @return [Boolean] True if images were disabled in the preview.
+      attr_accessor :disable_images
+    end
+  end
+end

data/lib/Mailosaur/models/preview_email_client.rb

@@ -0,0 +1,36 @@
+module Mailosaur
+  module Models
+    class PreviewEmailClient < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @name = data['id']
+        @platform_group = data['id']
+        @platform_type = data['id']
+        @platform_version = data['id']
+        @can_disable_images = data['canDisableImages']
+        @status = data['status']
+      end
+
+      # @return [String] Unique identifier for the email preview.
+      attr_accessor :id
+
+      # @return [String] The display name of the email client.
+      attr_accessor :name
+
+      # @return [String] Whether the platform is desktop, mobile, or web-based.
+      attr_accessor :platform_group
+
+      # @return [String] The type of platform on which the email client is running.
+      attr_accessor :platform_type
+
+      # @return [String] The platform version number.
+      attr_accessor :platform_version
+
+      # @return [Boolean] If true, images can be disabled when generating previews.
+      attr_accessor :can_disable_images
+
+      # @return [String] The current status of the email client.
+      attr_accessor :status
+    end
+  end
+end

data/lib/Mailosaur/models/preview_email_client_list_result.rb

@@ -0,0 +1,14 @@
+module Mailosaur
+  module Models
+    class PreviewEmailClientListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::PreviewEmailClient.new(i) }
+      end
+
+      # @return [Array<PreviewEmailClient>] A list of available email clients with which to generate email previews.
+      # A list of available email clients.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/preview_list_result.rb

@@ -0,0 +1,14 @@
+module Mailosaur
+  module Models
+    class PreviewListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::Preview.new(i) }
+      end
+
+      # @return [Array<Preview>] A list of requested email previews.
+      # The summaries for each requested preview.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/preview_request.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class PreviewRequest < BaseModel
+      def initialize(email_client, disable_images: false)
+        @email_client = email_client
+        @disable_images = disable_images
+      end
+
+      # @return [String] The email client the preview was generated with.
+      attr_accessor :email_client
+
+      # @return [Boolean] True if images were disabled in the preview.
+      attr_accessor :disable_images
+    end
+  end
+end

data/lib/Mailosaur/models/preview_request_options.rb

@@ -0,0 +1,12 @@
+module Mailosaur
+  module Models
+    class PreviewRequestOptions < BaseModel
+      def initialize(previews)
+        @previews = previews
+      end
+
+      # @return [PreviewRequest] The list of email preview requests.
+      attr_accessor :previews
+    end
+  end
+end

data/lib/Mailosaur/previews.rb

@@ -0,0 +1,29 @@
+module Mailosaur
+  class Previews
+    #
+    # Creates and initializes a new instance of the Previews class.
+    # @param client connection.
+    #
+    def initialize(conn, handle_http_error)
+      @conn = conn
+      @handle_http_error = handle_http_error
+    end
+
+    # @return [Connection] the client connection.
+    attr_reader :conn
+
+    #
+    # List all email clients that can be used to generate email previews.
+    #
+    # Returns a list of available email clients.
+    #
+    # @return [PreviewEmailClientListResult] operation results.
+    #
+    def list_email_clients
+      response = conn.get 'api/previews/clients'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::PreviewEmailClientListResult.new(model)
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.11.0'.freeze
+    VERSION = '7.13.0'.freeze
 end

data/lib/mailosaur.rb

@@ -15,6 +15,7 @@ module Mailosaur
   autoload :Servers,                                            'Mailosaur/servers.rb'
   autoload :Usage,                                              'Mailosaur/usage.rb'
   autoload :Devices,                                            'Mailosaur/devices.rb'
+  autoload :Previews,                                           'Mailosaur/previews.rb'
   autoload :MailosaurError,                                     'Mailosaur/mailosaur_error.rb'
 
   module Models
@@ -47,6 +48,12 @@ module Mailosaur
     autoload :DeviceListResult,                                   'Mailosaur/models/device_list_result.rb'
     autoload :DeviceCreateOptions,                                'Mailosaur/models/device_create_options.rb'
     autoload :OtpResult,                                          'Mailosaur/models/otp_result.rb'
+    autoload :Preview,                                            'Mailosaur/models/preview.rb'
+    autoload :PreviewEmailClient,                                 'Mailosaur/models/preview_email_client.rb'
+    autoload :PreviewEmailClientListResult,                       'Mailosaur/models/preview_email_client_list_result.rb'
+    autoload :PreviewListResult,                                  'Mailosaur/models/preview_list_result.rb'
+    autoload :PreviewRequest,                                     'Mailosaur/models/preview_request.rb'
+    autoload :PreviewRequestOptions,                              'Mailosaur/models/preview_request_options.rb'
     autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
@@ -86,11 +93,16 @@ module Mailosaur
       @usage ||= Usage.new(connection, method(:handle_http_error))
     end
 
-    # @return [Devices] usage
+    # @return [Devices] devices
     def devices
       @devices ||= Devices.new(connection, method(:handle_http_error))
     end
 
+    # @return [Previews] previews
+    def previews
+      @previews ||= Previews.new(connection, method(:handle_http_error))
+    end
+
     private
 
     def connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.13.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,20 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +165,12 @@ files:
 - lib/Mailosaur/models/message_summary.rb
 - lib/Mailosaur/models/metadata.rb
 - lib/Mailosaur/models/otp_result.rb
+- lib/Mailosaur/models/preview.rb
+- lib/Mailosaur/models/preview_email_client.rb
+- lib/Mailosaur/models/preview_email_client_list_result.rb
+- lib/Mailosaur/models/preview_list_result.rb
+- lib/Mailosaur/models/preview_request.rb
+- lib/Mailosaur/models/preview_request_options.rb
 - lib/Mailosaur/models/search_criteria.rb
 - lib/Mailosaur/models/server.rb
 - lib/Mailosaur/models/server_create_options.rb
@@ -183,6 +183,7 @@ files:
 - lib/Mailosaur/models/usage_transaction.rb
 - lib/Mailosaur/models/usage_transaction_list_result.rb
 - lib/Mailosaur/module_definition.rb
+- lib/Mailosaur/previews.rb
 - lib/Mailosaur/servers.rb
 - lib/Mailosaur/usage.rb
 - lib/Mailosaur/version.rb
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library