mailosaur 7.3.2 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 056e993a519633fcca85156531e4eb18cc1643fa230d7f15f6239794b5529f97
-  data.tar.gz: de2d43526a0512c7f92882fa5b23ca0d462852f7b2123ada28e34c42b0ad6b9b
+  metadata.gz: '0629407acde130c71828a35283ecc427f73881193164f236a970d6226fe4ed7d'
+  data.tar.gz: 66d6af0d7d7bd39d52f61c87c80acbf4524e2324c5ffe0c264397d8c99e4cdd0
 SHA512:
-  metadata.gz: f10d8c30b5b44f8a1fa19e2305599f8d5c48ab1e00e1c903cf4380d992e4c892b6a5e7637fe09b86016023545d70c357d5603802cdb6fb8e2169051f4ffa3e6d
-  data.tar.gz: b1a02d600af6526d11fffae86c94ea78c768a073489d3be996f803c943ba6f5a6223240933f2a6db07884fba239b633f95f87784b2d3ddb447c34b4a508805be
+  metadata.gz: 1754ac94d3a1566bf813e9adc6012ca42fa7be204dab7d733a2ae8bcc8d14b44a947f18a2795212ad49fd09406ebc3ba93c4cbc77b0ef57ecbf8c4f303cf4ea1
+  data.tar.gz: 511648f014115e7ab22f8cf2893ff87264a7355b8dddf193655c992b742ff48a30cc69d57f8ca44589e45e246fb6566cb17a503714fc9c30c013e712127a0817

data/lib/Mailosaur/messages.rb

@@ -170,5 +170,61 @@ module Mailosaur
         sleep(delay / 1000)
       end
     end
+
+    #
+    # Create a message.
+    #
+    # Creates a new message that can be sent to a verified email address. This is
+    # useful in scenarios where you want an email to trigger a workflow in your
+    # product
+    #
+    # @param server [String] The identifier of the server to create the message in.
+    # @param options [MessageCreateOptions] The options with which to create the message.
+    #
+    # @return [Message] operation result.
+    #
+    def create(server, message_create_options)
+      response = conn.post 'api/messages?server=' + server, message_create_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
+
+    #
+    # Forward an email.
+    #
+    # Forwards the specified email to a verified email address.
+    #
+    # @param id [String] The identifier of the email to forward.
+    # @param options [MessageForwardOptions] The options with which to forward the email.
+    # against.
+    #
+    # @return [Message] operation result.
+    #
+    def forward(id, message_forward_options)
+      response = conn.post 'api/messages/' + id + '/forward', message_forward_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
+
+    #
+    # Reply to an email.
+    #
+    # Sends a reply to the specified email. This is useful for when simulating a user
+    # replying to one of your emails.
+    #
+    # @param id [String] The identifier of the email to reply to.
+    # @param options [MessageReplyOptions] The options with which to reply to the email.
+    # against.
+    #
+    # @return [Message] operation result.
+    #
+    def reply(id, message_reply_options)
+      response = conn.post 'api/messages/' + id + '/reply', message_reply_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
   end
 end

data/lib/Mailosaur/models/message_create_options.rb

@@ -0,0 +1,31 @@
+module Mailosaur
+  module Models
+    class MessageCreateOptions < BaseModel
+      def initialize(data = {})
+        @to = data['to']
+        @send = data['send']
+        @subject = data['subject']
+        @text = data['text']
+        @html = data['html']
+      end
+
+      # @return [String] The email address to which the email will be sent.
+      # Must be a verified email address.
+      attr_accessor :to
+
+      # @return [Boolean] If true, email will be sent upon creation.
+      attr_accessor :send
+
+      # @return [String] The email subject line.
+      attr_accessor :subject
+
+      # @return [String] The plain text body of the email. Note that only
+      # text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] The HTML body of the email. Note that only text
+      # or html can be supplied, not both.
+      attr_accessor :html
+    end
+  end
+end

data/lib/Mailosaur/models/message_forward_options.rb

@@ -0,0 +1,23 @@
+module Mailosaur
+  module Models
+    class MessageForwardOptions < BaseModel
+      def initialize(data = {})
+        @to = data['to']
+        @text = data['text']
+        @html = data['html']
+      end
+
+      # @return [String] The email address to which the email will be sent.
+      # Must be a verified email address.
+      attr_accessor :to
+
+      # @return [String] Any additional plain text content to forward the
+      # email with. Note that only text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] Any additional HTML content to forward the email
+      # with. Note that only html or text can be supplied, not both.
+      attr_accessor :html
+    end
+  end
+end

data/lib/Mailosaur/models/message_reply_options.rb

@@ -0,0 +1,18 @@
+module Mailosaur
+  module Models
+    class MessageReplyOptions < BaseModel
+      def initialize(data = {})
+        @text = data['text']
+        @html = data['html']
+      end
+
+      # @return [String] Any additional plain text content to include in
+      # the reply. Note that only text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] Any additional HTML content to include in the
+      # reply. Note that only html or text can be supplied, not both.
+      attr_accessor :html
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.3.2'.freeze
+    VERSION = '7.4.0'.freeze
 end

data/lib/mailosaur.rb

@@ -26,6 +26,9 @@ module Mailosaur
     autoload :MessageSummary,                                     'Mailosaur/models/message_summary.rb'
     autoload :Image,                                              'Mailosaur/models/image.rb'
     autoload :MessageListResult,                                  'Mailosaur/models/message_list_result.rb'
+    autoload :MessageCreateOptions,                               'Mailosaur/models/message_create_options.rb'
+    autoload :MessageForwardOptions,                              'Mailosaur/models/message_forward_options.rb'
+    autoload :MessageReplyOptions,                                'Mailosaur/models/message_reply_options.rb'
     autoload :Attachment,                                         'Mailosaur/models/attachment.rb'
     autoload :SearchCriteria,                                     'Mailosaur/models/search_criteria.rb'
     autoload :MessageContent,                                     'Mailosaur/models/message_content.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.3.2
+  version: 7.4.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -164,8 +164,11 @@ files:
 - lib/Mailosaur/models/message.rb
 - lib/Mailosaur/models/message_address.rb
 - lib/Mailosaur/models/message_content.rb
+- lib/Mailosaur/models/message_create_options.rb
+- lib/Mailosaur/models/message_forward_options.rb
 - lib/Mailosaur/models/message_header.rb
 - lib/Mailosaur/models/message_list_result.rb
+- lib/Mailosaur/models/message_reply_options.rb
 - lib/Mailosaur/models/message_summary.rb
 - lib/Mailosaur/models/metadata.rb
 - lib/Mailosaur/models/search_criteria.rb