mailosaur 7.15.0 → 7.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8aa36344cdc15eb6630b90d9190139606a1758e814b9f8253bcccbc65de38a
-  data.tar.gz: 699d241ddddef0397ac598c5e873b15698854f116f627f37faccec6abd007f68
+  metadata.gz: 6504f3e1aef2209e036e67f395949c4fb63fa69dfd0b28bfbcee266c5b3e2930
+  data.tar.gz: 0d464db804db6466e9cbab81f478009f9376d26c0a95f59123a7d56b5638b356
 SHA512:
-  metadata.gz: 10f2e39c079e74a85071601d290fcea640e02b154b9dfcbe5d4c00b3f3e60b19aa79064ff76f2e3234694160707d05ce8437e41ddb8912574a1097250fc3427c
-  data.tar.gz: 2a68cde9de2c765f2c346be23e4eabacb3e9a3c9096445e3f66d8d1fbb8fa768e8106991edd0a5d6a166faaebda6bfd5c6141c06678b4b37bd6f96d99186a164
+  metadata.gz: 7d0bdcaa10eb017668738aa7d09f68f5da4822a06330b045689136f8e6f9df9ce7e788a8dacecfbaf47acad1bebfe969c43083795e1fb324d41345b4f8c729a3
+  data.tar.gz: b1761bddcfaafa75df9f1b3398518447c2c7a547e1a035772f7d523b8688ad26aab3856646505183a4f9adf9401bbcbc9a63faa955b71729ba493dc8cdeb5935

data/lib/Mailosaur/analysis.rb

@@ -27,5 +27,21 @@ module Mailosaur
       model = JSON.parse(response.body)
       Mailosaur::Models::SpamAnalysisResult.new(model)
     end
+
+    #
+    # Perform a deliverability report
+    #
+    # Perform deliverability test on the specified email
+    #
+    # @param email The identifier of the email to be analyzed.
+    #
+    # @return [DeliverabilityReport] operation results.
+    #
+    def deliverability(email)
+      response = conn.get "api/analysis/deliverability/#{email}"
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::DeliverabilityReport.new(model)
+    end
   end
 end

data/lib/Mailosaur/models/block_list_result.rb

@@ -0,0 +1,18 @@
+module Mailosaur
+  module Models
+    class BlockListResult < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @name = data['name']
+        @result = data['result']
+      end
+
+      # @return [String]
+      attr_accessor :id
+      # @return [String]
+      attr_accessor :name
+      # @return [String]
+      attr_accessor :result
+    end
+  end
+end

data/lib/Mailosaur/models/content.rb

@@ -0,0 +1,36 @@
+module Mailosaur
+  module Models
+    class Content < BaseModel
+      def initialize(data = {})
+        @embed = data['embed']
+        @iframe = data['iframe']
+        @object = data['object']
+        @script = data['script']
+        @short_urls = data['shortUrls']
+        @text_size = data['textSize']
+        @total_size = data['totalSize']
+        @missing_alt = data['missingAlt']
+        @missing_list_unsubscribe = data['missingListUnsubscribe']
+      end
+
+      # @return [Boolean]
+      attr_accessor :embed
+      # @return [Boolean]
+      attr_accessor :iframe
+      # @return [Boolean]
+      attr_accessor :object
+      # @return [Boolean]
+      attr_accessor :script
+      # @return [Boolean]
+      attr_accessor :short_urls
+      # @return [Integer]
+      attr_accessor :text_size
+      # @return [Integer]
+      attr_accessor :total_size
+      # @return [Boolean]
+      attr_accessor :missing_alt
+      # @return [Boolean]
+      attr_accessor :missing_list_unsubscribe
+    end
+  end
+end

data/lib/Mailosaur/models/deliverability_report.rb

@@ -0,0 +1,32 @@
+module Mailosaur
+  module Models
+    class DeliverabilityReport < BaseModel
+      def initialize(data = {})
+        @spf = Mailosaur::Models::EmailAuthenticationResult.new(data['spf'])
+        @dkim = []
+        (data['dkim'] || []).each { |i| @dkim << Mailosaur::Models::EmailAuthenticationResult.new(i) }
+        @dmarc = Mailosaur::Models::EmailAuthenticationResult.new(data['dmarc'])
+        @block_lists = []
+        (data['blockLists'] || []).each { |i| @block_lists << Mailosaur::Models::BlockListResult.new(i) }
+        @content = Mailosaur::Models::Content.new(data['content'])
+        @dns_records = Mailosaur::Models::DnsRecords.new(data['dnsRecords'])
+        @spam_assassin = Mailosaur::Models::SpamAssassinResult.new(data['spamAssassin'])
+      end
+
+      # @return [EmailAuthenticationResult]
+      attr_accessor :spf
+      # @return [Array<EmailAuthenticationResult>]
+      attr_accessor :dkim
+      # @return [EmailAuthenticationResult]
+      attr_accessor :dmarc
+      # @return [Array<BlockListResult>]
+      attr_accessor :block_lists
+      # @return [Content]
+      attr_accessor :content
+      # @return [DnsRecords]
+      attr_accessor :dns_records
+      # @return [SpamAssassinResult]
+      attr_accessor :spam_assassin
+    end
+  end
+end

data/lib/Mailosaur/models/dns_records.rb

@@ -0,0 +1,18 @@
+module Mailosaur
+  module Models
+    class DnsRecords < BaseModel
+      def initialize(data = {})
+        @a = data['a']
+        @mx = data['mx']
+        @ptr = data['ptr']
+      end
+
+      # @return [Array<String>]
+      attr_accessor :a
+      # @return [Array<String>]
+      attr_accessor :mx
+      # @return [Array<String>]
+      attr_accessor :ptr
+    end
+  end
+end

data/lib/Mailosaur/models/email_authentication_result.rb

@@ -0,0 +1,21 @@
+module Mailosaur
+  module Models
+    class EmailAuthenticationResult < BaseModel
+      def initialize(data = {})
+        @result = data['result']
+        @description = data['description']
+        @raw_value = data['rawValue']
+        @tags = data['tags']
+      end
+
+      # @return [String]
+      attr_accessor :result
+      # @return [String]
+      attr_accessor :description
+      # @return [String]
+      attr_accessor :raw_value
+      # @return [Hash<String,String>]
+      attr_accessor :tags
+    end
+  end
+end

data/lib/Mailosaur/models/spam_assassin_result.rb

@@ -0,0 +1,21 @@
+module Mailosaur
+  module Models
+    class SpamAssassinResult < BaseModel
+      def initialize(data = {})
+        @score = data['score']
+        @result = data['result']
+        @rules = []
+        (data['rules'] || []).each { |i| @rules << Mailosaur::Models::SpamAssassinRule.new(i) }
+      end
+
+      attr_accessor :spam_filter_results
+
+      # @return [Float]
+      attr_accessor :score
+      # @return [String]
+      attr_accessor :result
+      # @return [Array<SpamAssassinRule>]
+      attr_accessor :rules
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.15.0'.freeze
+    VERSION = '7.16.0'.freeze
 end

data/lib/mailosaur.rb

@@ -39,6 +39,12 @@ module Mailosaur
     autoload :Code,                                               'Mailosaur/models/code.rb'
     autoload :ServerListResult,                                   'Mailosaur/models/server_list_result.rb'
     autoload :SpamFilterResults,                                  'Mailosaur/models/spam_filter_results.rb'
+    autoload :DeliverabilityReport,                               'Mailosaur/models/deliverability_report.rb'
+    autoload :EmailAuthenticationResult,                          'Mailosaur/models/email_authentication_result.rb'
+    autoload :BlockListResult,                                    'Mailosaur/models/block_list_result.rb'
+    autoload :Content,                                            'Mailosaur/models/content.rb'
+    autoload :DnsRecords,                                         'Mailosaur/models/dns_records.rb'
+    autoload :SpamAssassinResult,                                 'Mailosaur/models/spam_assassin_result.rb'
     autoload :ServerCreateOptions,                                'Mailosaur/models/server_create_options.rb'
     autoload :UsageAccountLimits,                                 'Mailosaur/models/usage_account_limits.rb'
     autoload :UsageAccountLimit,                                  'Mailosaur/models/usage_account_limit.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.15.0
+  version: 7.16.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -148,10 +148,15 @@ files:
 - lib/Mailosaur/messages.rb
 - lib/Mailosaur/models/attachment.rb
 - lib/Mailosaur/models/base_model.rb
+- lib/Mailosaur/models/block_list_result.rb
 - lib/Mailosaur/models/code.rb
+- lib/Mailosaur/models/content.rb
+- lib/Mailosaur/models/deliverability_report.rb
 - lib/Mailosaur/models/device.rb
 - lib/Mailosaur/models/device_create_options.rb
 - lib/Mailosaur/models/device_list_result.rb
+- lib/Mailosaur/models/dns_records.rb
+- lib/Mailosaur/models/email_authentication_result.rb
 - lib/Mailosaur/models/image.rb
 - lib/Mailosaur/models/link.rb
 - lib/Mailosaur/models/message.rb
@@ -176,6 +181,7 @@ files:
 - lib/Mailosaur/models/server_create_options.rb
 - lib/Mailosaur/models/server_list_result.rb
 - lib/Mailosaur/models/spam_analysis_result.rb
+- lib/Mailosaur/models/spam_assassin_result.rb
 - lib/Mailosaur/models/spam_assassin_rule.rb
 - lib/Mailosaur/models/spam_filter_results.rb
 - lib/Mailosaur/models/usage_account_limit.rb
@@ -212,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library