mailslurp_client 11.9.4 → 11.9.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/lib/mailslurp_client/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d0a1a411afff479fbacfd18fab51004f6390faa924ea2879b2da91ca430da9df
|
|
4
|
+
data.tar.gz: adf74f4d849806cf70050543d44766b60c6b14ea299302fa8852b65759842ec9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6d8d24e06f13f36d3efb581ab82d4517ab9d6c53c3e2cbe0b7b29e3f3fa8414891917c5e971ea3b23b198cdbde45749b96a7b3e5f5bd6a8c76f9f16484f3bd9a
|
|
7
|
+
data.tar.gz: f74b002c143619edce7abba2a98a76583f10b14006983de0ce593ba77df3253249ab061edafe14b6064a8081e2241085f62f123ff3df38a1da2221da8af20947
|
data/README.md
CHANGED
|
@@ -10,6 +10,14 @@ MailSlurp is an email API service that lets you create real email addresses in c
|
|
|
10
10
|
- [Gem Package](https://rubygems.org/gems/mailslurp_client)
|
|
11
11
|
- [Github Source](https://github.com/mailslurp/mailslurp-client-ruby)
|
|
12
12
|
|
|
13
|
+
### Common controllers
|
|
14
|
+
- [Email controller](https://www.mailslurp.com/docs/ruby/docs/EmailControllerApi/) send and receive emails
|
|
15
|
+
- [Inbox controller](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/) create and manage email addresses
|
|
16
|
+
- [WaitFor controller](https://www.mailslurp.com/docs/ruby/docs/WaitForControllerApi/) wait for expected emails to arrive
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Example tutorials
|
|
20
|
+
|
|
13
21
|
## Get started
|
|
14
22
|
|
|
15
23
|
This section describes how to get up and running with the Ruby client.
|
|
@@ -70,7 +78,7 @@ Here are some common uses:
|
|
|
70
78
|
|
|
71
79
|
### Create inboxes
|
|
72
80
|
|
|
73
|
-
To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address.
|
|
81
|
+
To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address. See methods on the [inbox controller](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/) for more information.
|
|
74
82
|
|
|
75
83
|
```ruby
|
|
76
84
|
inbox_controller = MailSlurpClient::InboxControllerApi.new
|
|
@@ -120,7 +128,7 @@ end
|
|
|
120
128
|
|
|
121
129
|
### List inboxes
|
|
122
130
|
|
|
123
|
-
Inboxes you create can be listed in a paginated way.
|
|
131
|
+
Inboxes you create can be listed in a paginated way using the [InboxController](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/)).
|
|
124
132
|
|
|
125
133
|
```ruby
|
|
126
134
|
it 'can list inboxes' do
|
|
@@ -181,7 +189,7 @@ opts = {
|
|
|
181
189
|
inbox_controller.send_email(inbox_1.id, opts)
|
|
182
190
|
```
|
|
183
191
|
### Receive emails
|
|
184
|
-
|
|
192
|
+
To read already existing emails use the [Email Controller](https://www.mailslurp.com/docs/ruby/docs/EmailControllerApi/). To wait for expected emails to arrive use the [WaitFor Controller](https://www.mailslurp.com/docs/ruby/docs/WaitForControllerApi/).
|
|
185
193
|
You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
|
|
186
194
|
If a timeout is exceeded it will throw an error instead:
|
|
187
195
|
|
|
@@ -214,7 +222,7 @@ code, * = match.captures
|
|
|
214
222
|
|
|
215
223
|
### Attachments
|
|
216
224
|
|
|
217
|
-
You can send attachments by first uploading files with the
|
|
225
|
+
You can send attachments by first uploading files with the [AttachmentControllerApi](https://www.mailslurp.com/docs/ruby/docs/AttachmentControllerApi/) then using the returned attachment IDs in the send email method.
|
|
218
226
|
|
|
219
227
|
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.
|
|
220
228
|
|