Merge pull request #16 from tmtm/version_0.2.0

Version 0.2.0
ruby · Nov 14, 2020 · 0d4da4c · 0d4da4c
2 parents 0ca3289 + 9b9249c
commit 0d4da4c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 7 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,17 +1,37 @@
 # NEWS
 
-## Version X.X.X (YYYY-MM-DD)
+## Version 0.2.0 (2020-11-15)
 
 ### Incompatible changes
 
-* Verify the server's certificate by default. <https://github.com/ruby/net-smtp/pull/12>
-* Use STARTTLS by default if possible. <https://github.com/ruby/net-smtp/pull/9>
+* Verify the server's certificate by default.
+  If you don't want verification, specify `start(tls_verify: false)`.
+  <https://github.com/ruby/net-smtp/pull/12>
+
+* Use STARTTLS by default if possible.
+  If you don't want starttls, specify:
+      ```
+      smtp = Net::SMTP.new(hostname, port)
+      smtp.disable_starttls
+      smtp.start do |s|
+        s.send_message ....
+      end
+      ```
+  <https://github.com/ruby/net-smtp/pull/9>
 
 ### Improvements
 
-* Net::SMTP.start arguments are keyword arguments <https://github.com/ruby/net-smtp/pull/7>
-* Add tls_verify parameter. <https://github.com/ruby/net-smtp/pull/12>
-* Add tls_hostname parameter. <https://github.com/ruby/net-smtp/pull/14>
+* Net::SMTP.start and Net::SMTP#start arguments are keyword arguments.
+      ```
+      start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... }
+      ```
+  `password` is an alias of `secret`.
+  <https://github.com/ruby/net-smtp/pull/7>
+
+* Add `tls_hostname` parameter to `start()`.
+  If you want to use a different hostname than the certificate for the connection, you can specify the certificate hostname with `tls_hostname`.
+  <https://github.com/ruby/net-smtp/pull/14>
+
 * Add SNI support to net/smtp <https://github.com/ruby/net-smtp/pull/4>
 
 ### Fixes

diff --git a/lib/net/smtp.rb b/lib/net/smtp.rb
@@ -168,7 +168,7 @@ class SMTPUnsupportedCommand < ProtocolError
   #                     user: 'Your Account', secret: 'Your Password', authtype: :cram_md5)
   #
   class SMTP < Protocol
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
 
     Revision = %q$Revision$.split[1]