mailslurp_client 8.2.2 → 8.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93232136e472641c4912032ba0ed4bc7f3c78ef341733304a196f3905e8cbd6b
-  data.tar.gz: 10105fc33f340605cd60c26f8394cec9cdc3446866aff735ccd2d9111069d032
+  metadata.gz: 14c8172e82d0cc82bc46542483fb851b2777335c4eb54763a5468963faff7bd2
+  data.tar.gz: 8256fcef95c9dec144f7ab4b2e3e6ea16d624a3e19823f6d1f42b85b29510f02
 SHA512:
-  metadata.gz: 2d13af2cffe00a7e7b1916e1e676a6a338e4559f9a1dc306212be8b026d60039afc03622ddd8e03096dff79988bb5adbd3f0b270274889521e19ee5f54e7edf0
-  data.tar.gz: 102c0544b57ffd544cba06e9feadd9771470daa8c834aeebb8a3b6e17a21910d4497852a20e4c35985a17b5aa26fc2b39d5a7e3d6df4745c2d93afad766f38e3
+  metadata.gz: 8318ee26eb26b2851e543c5e1391da15b0222f11a914625ee064dbfd0f96cca44514a90496b2cf9f5aafab0705a3268829ecb4c45c630bb5b54972d669706356
+  data.tar.gz: b1e5948a5e6edd68b2b4b24d4d922c5d2b1fe3f45183137e38be5f8a999c91ab2aecb5b749912f76abba22cb3f56a1edc56983069bc148963f5b902535353171

data/README.md

@@ -39,15 +39,23 @@ gem install mailslurp_client
 Or in your `Gemfile`:
 
 ```ruby
-gem 'mailslurp_client', '~> 7.0', '>= 7.0.8'
+gem 'mailslurp_client', '~> 8.2', '>= 8.2.2'
 ```
 
+And then run bundler install:
+
+```bash
+gem install bundler
+bundle install
+```
+
+
 ### Configure the client
 
 ```ruby
 require 'mailslurp_client'
 
-# configure the mailslurp client with an API Key
+# configure mailslurp client globally with API key (or pass each controller a client instance)
 MailSlurpClient.configure do |config|
     config.api_key['x-api-key'] = "YOUR_API_KEY_HERE"
 end
@@ -80,6 +88,26 @@ it 'can create email addresses' do
 end
 ```
 
+### List inboxes
+
+Inboxes you create can be listed in a paginated way.
+
+```ruby
+it 'can list inboxes' do
+    inbox_controller = MailSlurpClient::InboxControllerApi.new
+    paged_inboxes = inbox_controller.get_all_inboxes({ page: 0, size: 20 })
+
+    # assert on pagination fields
+    expect(paged_inboxes.content).not_to be_empty
+    expect(paged_inboxes.number).to be(0)
+    expect(paged_inboxes.size).to be(20)
+
+    # can access inbox result
+    expect(paged_inboxes.content[0].id).not_to be_empty
+end
+```
+
+
 ### Send emails
 
 You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
@@ -104,6 +132,24 @@ inbox_controller.send_email(inbox.id, {
 })
 ```
 
+You can also use objects for most method options:
+
+```ruby
+# for send options see https://github.com/mailslurp/mailslurp-client-ruby/blob/master/docs/SendEmailOptions.md
+opts = {
+  send_email_options: MailSlurpClient::SendEmailOptions.new(
+    {
+      to: [inbox_2.email_address],
+      subject: 'Test email',
+      from: inbox_1.email_address,
+      body: 'Test email content',
+      is_html: true,
+      attachments: attachment_ids
+    }
+  )
+}
+inbox_controller.send_email(inbox_1.id, opts)
+```
 ### Receive emails
 
 You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
@@ -111,13 +157,159 @@ If a timeout is exceeded it will throw an error instead:
 
 ```ruby
 waitfor_controller = MailSlurpClient::WaitForControllerApi.new
-email = waitfor_controller.wait_for_latest_email({ inbox_id: inbox.id, unread_only: true })
+email = waitfor_controller.wait_for_latest_email({ inbox_id: inbox.id, unread_only: true, timeout: 30_000 })
 
 # verify email contents
 expect(email.subject).to include("Test")
 expect(email.body).to include("Your email body")
 ```
 
+### Attachments
+
+You can send attachments by first uploading files with the `AttachmentControllerApi` then using the returned attachment IDs in the send email method.
+
+::: tip
+MailSlurp endpoints use base64 string encoding for upload and download files. To encode or decode strings in Ruby make sure you use the **strict** variables that avoid added newlines.
+:::
+
+#### Upload and send
+```ruby
+# upload a file to mailslurp to use as attachment
+# @return [Array<String>]
+def upload_file
+# read a file to upload
+data = File.open(PATH_TO_ATTACHMENT).read
+
+# encode the data as base64 string (must be strict to avoid ruby adding new line characters)
+encoded = Base64.strict_encode64(data)
+
+attachment_controller = MailSlurpClient::AttachmentControllerApi.new
+upload_options = MailSlurpClient::UploadAttachmentOptions.new(
+  {
+    base64_contents: encoded,
+    content_type: 'text/plain',
+    filename: 'attachment.txt'
+  }
+)
+
+# return list of attachment ids
+attachment_controller.upload_attachment(upload_options)
+end
+```
+
+To send attachments
+
+```ruby
+attachment_ids = upload_file
+
+opts = {
+  send_email_options: MailSlurpClient::SendEmailOptions.new(
+    {
+      to: [inbox_2.email_address],
+      subject: 'Test email',
+      from: inbox_1.email_address,
+      body: 'Test email content',
+      is_html: true,
+      attachments: attachment_ids
+    }
+  )
+}
+inbox_controller.send_email(inbox_1.id, opts)
+```
+
+#### Download received attachments
+```ruby
+ # wait for the email to arrive (or fetch directly using email controller if you know it is there)
+wait_opts = {
+  inbox_id: inbox_2.id,
+  timeout: 30_000,
+  unread_only: true
+}
+email = wait_controller.wait_for_latest_email(wait_opts)
+
+# find the attachments on the email object
+expect(email.attachments.size).to be(1)
+
+# download the attachment
+email_controller = MailSlurpClient::EmailControllerApi.new
+downloaded_attachment = email_controller.download_attachment_base64(email.attachments[0], email.id)
+
+# extract attachment content
+expect(downloaded_attachment.content_type).to eq("text/plain")
+expect(downloaded_attachment.size_bytes).to be_truthy
+expect(downloaded_attachment.base64_file_contents).to be_truthy
+```
+
+## Examples
+
+### Send email between two inboxes
+
+It is common to use MailSlurp in test environments. Here is an example RSpec test:
+
+```ruby
+
+require 'mailslurp_client'
+
+# read mailslurp api key from environment variables
+API_KEY = ENV['API_KEY']
+
+describe 'use MailSlurp ruby sdk to create email addresses then send and receive email' do
+  before(:all) do
+    expect(API_KEY).to be_truthy
+
+    # configure mailslurp with API key
+    MailSlurpClient.configure do |config|
+      config.api_key['x-api-key'] = API_KEY
+    end
+  end
+
+  it 'can an inbox with an email address' do
+    # create a new email address
+    inbox_controller = MailSlurpClient::InboxControllerApi.new
+    inbox = inbox_controller.create_inbox
+
+    # has a mailslurp email address
+    expect(inbox.id).to be_truthy
+    expect(inbox.email_address).to include('@mailslurp.com')
+  end
+
+  it 'can send and receive emails' do
+    inbox_controller = MailSlurpClient::InboxControllerApi.new
+    wait_controller  = MailSlurpClient::WaitForControllerApi.new
+
+    # create two inboxes
+    inbox_1 = inbox_controller.create_inbox
+    inbox_2 = inbox_controller.create_inbox
+
+    # send email from inbox 1 to inbox 2 (you can send emails to any address)
+    # for send options see https://github.com/mailslurp/mailslurp-client-ruby/blob/master/docs/SendEmailOptions.md
+    opts = {
+      send_email_options: MailSlurpClient::SendEmailOptions.new(
+        {
+          to: [inbox_2.email_address],
+          subject: 'Test email',
+          from: inbox_1.email_address,
+          body: 'Test email content',
+          is_html: true
+        }
+      )
+    }
+    inbox_controller.send_email(inbox_1.id, opts)
+
+    expect(inbox_2.id).to be_truthy
+
+    # now wait for the email to arrive
+    wait_opts = {
+      inbox_id: inbox_2.id,
+      timeout: 30_000,
+      unread_only: true
+    }
+    email = wait_controller.wait_for_latest_email(wait_opts)
+    expect(email.body).to include('Test email content')
+  end
+end
+```
+
 ## SDK Documentation
 
 See the [examples page](https://www.mailslurp.com/examples/) or the full [Method Documentation](./docs) on Github.

data/lib/mailslurp_client/models/upload_attachment_options.rb

@@ -15,7 +15,7 @@ require 'date'
 module MailSlurpClient
   # Options for uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your `SendEmailOptions` when sending an email. This way you can use attachments multiple times once they have been uploaded.
   class UploadAttachmentOptions
-    # Base64 encoded string of file contents
+    # Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string.
     attr_accessor :base64_contents
 
     # Optional contentType for file. For instance `application/pdf`

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '8.2.2'
+  VERSION = '8.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 8.2.2
+  version: 8.2.4
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.