konstruo 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.rspec +3 -0
- data/.rubocop.yml +22 -0
- data/.tool-versions +1 -0
- data/CHANGELOG.md +21 -0
- data/LICENSE.txt +21 -0
- data/README.md +35 -0
- data/Rakefile +10 -0
- data/lib/konstruo/mapper.rb +120 -0
- data/lib/konstruo/version.rb +6 -0
- data/lib/konstruo.rb +18 -0
- data/sorbet/config +4 -0
- data/sorbet/rbi/annotations/.gitattributes +1 -0
- data/sorbet/rbi/annotations/actionmailer.rbi +10 -0
- data/sorbet/rbi/annotations/actionpack.rbi +430 -0
- data/sorbet/rbi/annotations/actionview.rbi +75 -0
- data/sorbet/rbi/annotations/activejob.rbi +44 -0
- data/sorbet/rbi/annotations/activemodel.rbi +89 -0
- data/sorbet/rbi/annotations/activerecord.rbi +92 -0
- data/sorbet/rbi/annotations/activesupport.rbi +454 -0
- data/sorbet/rbi/annotations/globalid.rbi +30 -0
- data/sorbet/rbi/annotations/minitest.rbi +119 -0
- data/sorbet/rbi/annotations/railties.rbi +61 -0
- data/sorbet/rbi/annotations/rainbow.rbi +269 -0
- data/sorbet/rbi/dsl/.gitattributes +1 -0
- data/sorbet/rbi/dsl/active_support/callbacks.rbi +23 -0
- data/sorbet/rbi/gems/.gitattributes +1 -0
- data/sorbet/rbi/gems/actioncable@7.2.1.rbi +3096 -0
- data/sorbet/rbi/gems/actionmailbox@7.2.1.rbi +1832 -0
- data/sorbet/rbi/gems/actionmailer@7.2.1.rbi +2664 -0
- data/sorbet/rbi/gems/actionpack@7.2.1.rbi +20536 -0
- data/sorbet/rbi/gems/actiontext@7.2.1.rbi +1697 -0
- data/sorbet/rbi/gems/actionview@7.2.1.rbi +15752 -0
- data/sorbet/rbi/gems/activejob@7.2.1.rbi +2828 -0
- data/sorbet/rbi/gems/activemodel@7.2.1.rbi +6762 -0
- data/sorbet/rbi/gems/activerecord@7.2.1.rbi +41433 -0
- data/sorbet/rbi/gems/activestorage@7.2.1.rbi +3247 -0
- data/sorbet/rbi/gems/activesupport@7.2.1.rbi +21142 -0
- data/sorbet/rbi/gems/ast@2.4.2.rbi +585 -0
- data/sorbet/rbi/gems/base64@0.2.0.rbi +509 -0
- data/sorbet/rbi/gems/bigdecimal@3.1.8.rbi +78 -0
- data/sorbet/rbi/gems/builder@3.3.0.rbi +9 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.3.4.rbi +11645 -0
- data/sorbet/rbi/gems/connection_pool@2.4.1.rbi +9 -0
- data/sorbet/rbi/gems/crass@1.0.6.rbi +623 -0
- data/sorbet/rbi/gems/dashbrains-rubocop-config@1.0.4.rbi +9 -0
- data/sorbet/rbi/gems/date@3.3.4.rbi +75 -0
- data/sorbet/rbi/gems/diff-lcs@1.5.1.rbi +1131 -0
- data/sorbet/rbi/gems/drb@2.2.1.rbi +1347 -0
- data/sorbet/rbi/gems/erubi@1.13.0.rbi +150 -0
- data/sorbet/rbi/gems/globalid@1.2.1.rbi +749 -0
- data/sorbet/rbi/gems/i18n@1.14.5.rbi +2359 -0
- data/sorbet/rbi/gems/io-console@0.7.2.rbi +9 -0
- data/sorbet/rbi/gems/json@2.7.2.rbi +1562 -0
- data/sorbet/rbi/gems/language_server-protocol@3.17.0.3.rbi +14238 -0
- data/sorbet/rbi/gems/logger@1.6.1.rbi +920 -0
- data/sorbet/rbi/gems/loofah@2.22.0.rbi +1081 -0
- data/sorbet/rbi/gems/mail@2.8.1.rbi +8658 -0
- data/sorbet/rbi/gems/marcel@1.0.4.rbi +239 -0
- data/sorbet/rbi/gems/mini_mime@1.1.5.rbi +173 -0
- data/sorbet/rbi/gems/minitest@5.25.1.rbi +1546 -0
- data/sorbet/rbi/gems/net-imap@0.4.16.rbi +10845 -0
- data/sorbet/rbi/gems/net-pop@0.1.2.rbi +927 -0
- data/sorbet/rbi/gems/net-protocol@0.2.2.rbi +292 -0
- data/sorbet/rbi/gems/net-smtp@0.5.0.rbi +1228 -0
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +159 -0
- data/sorbet/rbi/gems/nio4r@2.7.3.rbi +293 -0
- data/sorbet/rbi/gems/nokogiri@1.16.7.rbi +7311 -0
- data/sorbet/rbi/gems/parallel@1.26.3.rbi +291 -0
- data/sorbet/rbi/gems/parser@3.3.5.0.rbi +5519 -0
- data/sorbet/rbi/gems/prism@1.0.0.rbi +35493 -0
- data/sorbet/rbi/gems/psych@5.1.2.rbi +1769 -0
- data/sorbet/rbi/gems/racc@1.8.1.rbi +162 -0
- data/sorbet/rbi/gems/rack-session@2.0.0.rbi +727 -0
- data/sorbet/rbi/gems/rack-test@2.1.0.rbi +747 -0
- data/sorbet/rbi/gems/rack@3.1.7.rbi +4902 -0
- data/sorbet/rbi/gems/rackup@2.1.0.rbi +390 -0
- data/sorbet/rbi/gems/rails-dom-testing@2.2.0.rbi +758 -0
- data/sorbet/rbi/gems/rails-html-sanitizer@1.6.0.rbi +785 -0
- data/sorbet/rbi/gems/rails@7.2.1.rbi +9 -0
- data/sorbet/rbi/gems/railties@7.2.1.rbi +3824 -0
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +403 -0
- data/sorbet/rbi/gems/rake@13.2.1.rbi +3046 -0
- data/sorbet/rbi/gems/rbi@0.2.0.rbi +4105 -0
- data/sorbet/rbi/gems/rdoc@6.7.0.rbi +12721 -0
- data/sorbet/rbi/gems/regexp_parser@2.9.2.rbi +3772 -0
- data/sorbet/rbi/gems/reline@0.5.10.rbi +9 -0
- data/sorbet/rbi/gems/rspec-core@3.13.1.rbi +11012 -0
- data/sorbet/rbi/gems/rspec-expectations@3.13.3.rbi +8183 -0
- data/sorbet/rbi/gems/rspec-mocks@3.13.1.rbi +5341 -0
- data/sorbet/rbi/gems/rspec-support@3.13.1.rbi +1630 -0
- data/sorbet/rbi/gems/rspec@3.13.0.rbi +83 -0
- data/sorbet/rbi/gems/rubocop-ast@1.32.3.rbi +7446 -0
- data/sorbet/rbi/gems/rubocop-capybara@2.21.0.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-factory_bot@2.26.1.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-graphql@1.5.4.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-minitest@0.36.0.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-performance@1.21.1.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-rails@2.26.1.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-rake@0.6.0.rbi +329 -0
- data/sorbet/rbi/gems/rubocop-rspec@3.0.5.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-rspec_rails@2.30.0.rbi +9 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.8.5.rbi +9 -0
- data/sorbet/rbi/gems/rubocop@1.66.1.rbi +58268 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +1318 -0
- data/sorbet/rbi/gems/securerandom@0.3.1.rbi +396 -0
- data/sorbet/rbi/gems/spoom@1.4.2.rbi +4932 -0
- data/sorbet/rbi/gems/stringio@3.1.1.rbi +9 -0
- data/sorbet/rbi/gems/tapioca@0.16.2.rbi +3581 -0
- data/sorbet/rbi/gems/thor@1.3.2.rbi +4378 -0
- data/sorbet/rbi/gems/timeout@0.4.1.rbi +149 -0
- data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +5918 -0
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +66 -0
- data/sorbet/rbi/gems/useragent@0.16.10.rbi +9 -0
- data/sorbet/rbi/gems/webrick@1.8.1.rbi +2607 -0
- data/sorbet/rbi/gems/websocket-driver@0.7.6.rbi +993 -0
- data/sorbet/rbi/gems/websocket-extensions@0.1.5.rbi +121 -0
- data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +435 -0
- data/sorbet/rbi/gems/yard@0.9.37.rbi +18570 -0
- data/sorbet/rbi/gems/zeitwerk@2.6.18.rbi +1051 -0
- data/sorbet/rbi/todo.rbi +6 -0
- data/sorbet/tapioca/config.yml +13 -0
- data/sorbet/tapioca/require.rb +9 -0
- data/tasks/bundle_update.rake +14 -0
- data/tasks/sorbet.rake +26 -0
- metadata +216 -0
@@ -0,0 +1,1228 @@
|
|
1
|
+
# typed: false
|
2
|
+
|
3
|
+
# DO NOT EDIT MANUALLY
|
4
|
+
# This is an autogenerated file for types exported from the `net-smtp` gem.
|
5
|
+
# Please instead update this file by running `bin/tapioca gem net-smtp`.
|
6
|
+
|
7
|
+
|
8
|
+
# == What is This Library?
|
9
|
+
#
|
10
|
+
# This library provides functionality to send internet
|
11
|
+
# mail via \SMTP, the Simple Mail Transfer Protocol. For details of
|
12
|
+
# \SMTP itself, see [RFC5321[https://www.rfc-editor.org/rfc/rfc5321.txt]].
|
13
|
+
# This library also implements \SMTP authentication, which is often
|
14
|
+
# necessary for message composers to submit messages to their
|
15
|
+
# outgoing \SMTP server, see
|
16
|
+
# [RFC6409[https://www.rfc-editor.org/rfc/rfc6409.html]],
|
17
|
+
# and [SMTPUTF8[https://www.rfc-editor.org/rfc/rfc6531.txt]], which is
|
18
|
+
# necessary to send messages to/from addresses containing characters
|
19
|
+
# outside the ASCII range.
|
20
|
+
#
|
21
|
+
# == What is This Library NOT?
|
22
|
+
#
|
23
|
+
# This library does NOT provide functions to compose internet mails.
|
24
|
+
# You must create them by yourself. If you want better mail support,
|
25
|
+
# try the mail[https://rubygems.org/gems/mail] or
|
26
|
+
# rmail[https://rubygems.org/gems/rmail] gems, or search for alternatives in
|
27
|
+
# {RubyGems.org}[https://rubygems.org/] or {The Ruby
|
28
|
+
# Toolbox}[https://www.ruby-toolbox.com/].
|
29
|
+
#
|
30
|
+
# FYI: the official specification on internet mail is:
|
31
|
+
# [RFC5322[https://www.rfc-editor.org/rfc/rfc5322.txt]].
|
32
|
+
#
|
33
|
+
# == Examples
|
34
|
+
#
|
35
|
+
# === Sending Messages
|
36
|
+
#
|
37
|
+
# You must open a connection to an \SMTP server before sending messages.
|
38
|
+
# The first argument is the address of your \SMTP server, and the second
|
39
|
+
# argument is the port number. Using SMTP.start with a block is the simplest
|
40
|
+
# way to do this. This way, the SMTP connection is closed automatically
|
41
|
+
# after the block is executed.
|
42
|
+
#
|
43
|
+
# require 'net/smtp'
|
44
|
+
# Net::SMTP.start('your.smtp.server', 25) do |smtp|
|
45
|
+
# # Use the SMTP object smtp only in this block.
|
46
|
+
# end
|
47
|
+
#
|
48
|
+
# Replace 'your.smtp.server' with your \SMTP server. Normally
|
49
|
+
# your system manager or internet provider supplies a server
|
50
|
+
# for you.
|
51
|
+
#
|
52
|
+
# Then you can send messages.
|
53
|
+
#
|
54
|
+
# msgstr = <<END_OF_MESSAGE
|
55
|
+
# From: Your Name <your@mail.address>
|
56
|
+
# To: Destination Address <someone@example.com>
|
57
|
+
# Subject: test message
|
58
|
+
# Date: Sat, 23 Jun 2001 16:26:43 +0900
|
59
|
+
# Message-Id: <unique.message.id.string@example.com>
|
60
|
+
#
|
61
|
+
# This is a test message.
|
62
|
+
# END_OF_MESSAGE
|
63
|
+
#
|
64
|
+
# require 'net/smtp'
|
65
|
+
# Net::SMTP.start('your.smtp.server', 25) do |smtp|
|
66
|
+
# smtp.send_message msgstr,
|
67
|
+
# 'your@mail.address',
|
68
|
+
# 'his_address@example.com'
|
69
|
+
# end
|
70
|
+
#
|
71
|
+
# === Closing the Session
|
72
|
+
#
|
73
|
+
# You MUST close the SMTP session after sending messages, by calling
|
74
|
+
# the #finish method:
|
75
|
+
#
|
76
|
+
# # using SMTP#finish
|
77
|
+
# smtp = Net::SMTP.start('your.smtp.server', 25)
|
78
|
+
# smtp.send_message msgstr, 'from@address', 'to@address'
|
79
|
+
# smtp.finish
|
80
|
+
#
|
81
|
+
# You can also use the block form of SMTP.start or SMTP#start. This closes
|
82
|
+
# the SMTP session automatically:
|
83
|
+
#
|
84
|
+
# # using block form of SMTP.start
|
85
|
+
# Net::SMTP.start('your.smtp.server', 25) do |smtp|
|
86
|
+
# smtp.send_message msgstr, 'from@address', 'to@address'
|
87
|
+
# end
|
88
|
+
#
|
89
|
+
# I strongly recommend this scheme. This form is simpler and more robust.
|
90
|
+
#
|
91
|
+
# === HELO domain
|
92
|
+
#
|
93
|
+
# In almost all situations, you must provide a third argument
|
94
|
+
# to SMTP.start or SMTP#start. This is the domain name which you are on
|
95
|
+
# (the host to send mail from). It is called the "HELO domain".
|
96
|
+
# The \SMTP server will judge whether it should send or reject
|
97
|
+
# the SMTP session by inspecting the HELO domain.
|
98
|
+
#
|
99
|
+
# Net::SMTP.start('your.smtp.server', 25, helo: 'mail.from.domain') do |smtp|
|
100
|
+
# smtp.send_message msgstr, 'from@address', 'to@address'
|
101
|
+
# end
|
102
|
+
#
|
103
|
+
# === \SMTP Authentication
|
104
|
+
#
|
105
|
+
# The Net::SMTP class supports the \SMTP extension for SASL Authentication
|
106
|
+
# [RFC4954[https://www.rfc-editor.org/rfc/rfc4954.html]] and the following
|
107
|
+
# SASL mechanisms: +PLAIN+, +LOGIN+ _(deprecated)_, and +CRAM-MD5+
|
108
|
+
# _(deprecated)_.
|
109
|
+
#
|
110
|
+
# To use \SMTP authentication, pass extra arguments to
|
111
|
+
# SMTP.start or SMTP#start.
|
112
|
+
#
|
113
|
+
# # PLAIN
|
114
|
+
# Net::SMTP.start('your.smtp.server', 25,
|
115
|
+
# user: 'Your Account', secret: 'Your Password', authtype: :plain)
|
116
|
+
#
|
117
|
+
# Support for other SASL mechanisms-such as +EXTERNAL+, +OAUTHBEARER+,
|
118
|
+
# +SCRAM-SHA-256+, and +XOAUTH2+-will be added in a future release.
|
119
|
+
#
|
120
|
+
# The +LOGIN+ and +CRAM-MD5+ mechanisms are still available for backwards
|
121
|
+
# compatibility, but are deprecated and should be avoided.
|
122
|
+
#
|
123
|
+
# source://net-smtp//lib/net/smtp.rb#194
|
124
|
+
class Net::SMTP < ::Net::Protocol
|
125
|
+
# Creates a new Net::SMTP object.
|
126
|
+
#
|
127
|
+
# +address+ is the hostname or ip address of your SMTP
|
128
|
+
# server. +port+ is the port to connect to; it defaults to
|
129
|
+
# port 25.
|
130
|
+
#
|
131
|
+
# If +tls+ is true, enable TLS. The default is false.
|
132
|
+
# If +starttls+ is :always, enable STARTTLS, if +:auto+, use STARTTLS when the server supports it,
|
133
|
+
# if false, disable STARTTLS.
|
134
|
+
#
|
135
|
+
# If +tls_verify+ is true, verify the server's certificate. The default is true.
|
136
|
+
# If the hostname in the server certificate is different from +address+,
|
137
|
+
# it can be specified with +tls_hostname+.
|
138
|
+
#
|
139
|
+
# Additional SSLContext[https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html]
|
140
|
+
# params can be added to the +ssl_context_params+ hash argument and are
|
141
|
+
# passed to {OpenSSL::SSL::SSLContext#set_params}[https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html#method-i-set_params].
|
142
|
+
#
|
143
|
+
# <tt>tls_verify: true</tt> is equivalent to <tt>ssl_context_params: {
|
144
|
+
# verify_mode: OpenSSL::SSL::VERIFY_PEER }</tt>.
|
145
|
+
#
|
146
|
+
# This method does not open the TCP connection. You can use
|
147
|
+
# SMTP.start instead of SMTP.new if you want to do everything
|
148
|
+
# at once. Otherwise, follow SMTP.new with SMTP#start.
|
149
|
+
#
|
150
|
+
# @return [SMTP] a new instance of SMTP
|
151
|
+
#
|
152
|
+
# source://net-smtp//lib/net/smtp.rb#248
|
153
|
+
def initialize(address, port = T.unsafe(nil), tls: T.unsafe(nil), starttls: T.unsafe(nil), tls_verify: T.unsafe(nil), tls_hostname: T.unsafe(nil), ssl_context_params: T.unsafe(nil)); end
|
154
|
+
|
155
|
+
# The address of the SMTP server to connect to.
|
156
|
+
#
|
157
|
+
# source://net-smtp//lib/net/smtp.rb#414
|
158
|
+
def address; end
|
159
|
+
|
160
|
+
# Returns whether the server advertises support for the authentication type.
|
161
|
+
# You cannot get valid result before opening SMTP session.
|
162
|
+
#
|
163
|
+
# @return [Boolean]
|
164
|
+
#
|
165
|
+
# source://net-smtp//lib/net/smtp.rb#329
|
166
|
+
def auth_capable?(type); end
|
167
|
+
|
168
|
+
# Authenticates with the server, using the "AUTH" command.
|
169
|
+
#
|
170
|
+
# +authtype+ is the name of a SASL authentication mechanism.
|
171
|
+
#
|
172
|
+
# All arguments-other than +authtype+-are forwarded to the authenticator.
|
173
|
+
# Different authenticators may interpret the +user+ and +secret+
|
174
|
+
# arguments differently.
|
175
|
+
#
|
176
|
+
# source://net-smtp//lib/net/smtp.rb#872
|
177
|
+
def authenticate(user, secret, authtype = T.unsafe(nil)); end
|
178
|
+
|
179
|
+
# The server capabilities by EHLO response
|
180
|
+
#
|
181
|
+
# source://net-smtp//lib/net/smtp.rb#307
|
182
|
+
def capabilities; end
|
183
|
+
|
184
|
+
# true if the EHLO response contains +key+.
|
185
|
+
#
|
186
|
+
# @return [Boolean]
|
187
|
+
#
|
188
|
+
# source://net-smtp//lib/net/smtp.rb#301
|
189
|
+
def capable?(key); end
|
190
|
+
|
191
|
+
# Returns supported authentication methods on this server.
|
192
|
+
# You cannot get valid value before opening SMTP session.
|
193
|
+
#
|
194
|
+
# source://net-smtp//lib/net/smtp.rb#337
|
195
|
+
def capable_auth_types; end
|
196
|
+
|
197
|
+
# true if server advertises AUTH CRAM-MD5.
|
198
|
+
# You cannot get valid value before opening SMTP session.
|
199
|
+
#
|
200
|
+
# @return [Boolean]
|
201
|
+
#
|
202
|
+
# source://net-smtp//lib/net/smtp.rb#323
|
203
|
+
def capable_cram_md5_auth?; end
|
204
|
+
|
205
|
+
# true if server advertises AUTH LOGIN.
|
206
|
+
# You cannot get valid value before opening SMTP session.
|
207
|
+
#
|
208
|
+
# @return [Boolean]
|
209
|
+
#
|
210
|
+
# source://net-smtp//lib/net/smtp.rb#317
|
211
|
+
def capable_login_auth?; end
|
212
|
+
|
213
|
+
# true if server advertises AUTH PLAIN.
|
214
|
+
# You cannot get valid value before opening SMTP session.
|
215
|
+
#
|
216
|
+
# @return [Boolean]
|
217
|
+
#
|
218
|
+
# source://net-smtp//lib/net/smtp.rb#311
|
219
|
+
def capable_plain_auth?; end
|
220
|
+
|
221
|
+
# true if server advertises STARTTLS.
|
222
|
+
# You cannot get valid value before opening SMTP session.
|
223
|
+
#
|
224
|
+
# @return [Boolean]
|
225
|
+
#
|
226
|
+
# source://net-smtp//lib/net/smtp.rb#296
|
227
|
+
def capable_starttls?; end
|
228
|
+
|
229
|
+
# This method sends a message.
|
230
|
+
# If +msgstr+ is given, sends it as a message.
|
231
|
+
# If block is given, yield a message writer stream.
|
232
|
+
# You must write message before the block is closed.
|
233
|
+
#
|
234
|
+
# # Example 1 (by string)
|
235
|
+
# smtp.data(<<EndMessage)
|
236
|
+
# From: john@example.com
|
237
|
+
# To: betty@example.com
|
238
|
+
# Subject: I found a bug
|
239
|
+
#
|
240
|
+
# Check vm.c:58879.
|
241
|
+
# EndMessage
|
242
|
+
#
|
243
|
+
# # Example 2 (by block)
|
244
|
+
# smtp.data {|f|
|
245
|
+
# f.puts "From: john@example.com"
|
246
|
+
# f.puts "To: betty@example.com"
|
247
|
+
# f.puts "Subject: I found a bug"
|
248
|
+
# f.puts ""
|
249
|
+
# f.puts "Check vm.c:58879."
|
250
|
+
# }
|
251
|
+
#
|
252
|
+
# source://net-smtp//lib/net/smtp.rb#958
|
253
|
+
def data(msgstr = T.unsafe(nil), &block); end
|
254
|
+
|
255
|
+
# WARNING: This method causes serious security holes.
|
256
|
+
# Use this method for only debugging.
|
257
|
+
#
|
258
|
+
# Set an output stream for debug logging.
|
259
|
+
# You must call this before #start.
|
260
|
+
#
|
261
|
+
# # example
|
262
|
+
# smtp = Net::SMTP.new(addr, port)
|
263
|
+
# smtp.set_debug_output $stderr
|
264
|
+
# smtp.start do |smtp|
|
265
|
+
# ....
|
266
|
+
# end
|
267
|
+
#
|
268
|
+
# source://net-smtp//lib/net/smtp.rb#450
|
269
|
+
def debug_output=(arg); end
|
270
|
+
|
271
|
+
# Disables SMTP/TLS for this object. Must be called before the
|
272
|
+
# connection is established to have any effect.
|
273
|
+
#
|
274
|
+
# source://net-smtp//lib/net/smtp.rb#364
|
275
|
+
def disable_ssl; end
|
276
|
+
|
277
|
+
# Disables SMTP/TLS (STARTTLS) for this object. Must be called
|
278
|
+
# before the connection is established to have any effect.
|
279
|
+
#
|
280
|
+
# source://net-smtp//lib/net/smtp.rb#408
|
281
|
+
def disable_starttls; end
|
282
|
+
|
283
|
+
# Disables SMTP/TLS for this object. Must be called before the
|
284
|
+
# connection is established to have any effect.
|
285
|
+
#
|
286
|
+
# source://net-smtp//lib/net/smtp.rb#364
|
287
|
+
def disable_tls; end
|
288
|
+
|
289
|
+
# source://net-smtp//lib/net/smtp.rb#907
|
290
|
+
def ehlo(domain); end
|
291
|
+
|
292
|
+
# Enables SMTP/TLS (SMTPS: \SMTP over direct TLS connection) for
|
293
|
+
# this object. Must be called before the connection is established
|
294
|
+
# to have any effect. +context+ is a OpenSSL::SSL::SSLContext object.
|
295
|
+
#
|
296
|
+
# @raise [ArgumentError]
|
297
|
+
#
|
298
|
+
# source://net-smtp//lib/net/smtp.rb#353
|
299
|
+
def enable_ssl(context = T.unsafe(nil)); end
|
300
|
+
|
301
|
+
# Enables SMTP/TLS (STARTTLS) for this object.
|
302
|
+
# +context+ is a OpenSSL::SSL::SSLContext object.
|
303
|
+
#
|
304
|
+
# @raise [ArgumentError]
|
305
|
+
#
|
306
|
+
# source://net-smtp//lib/net/smtp.rb#390
|
307
|
+
def enable_starttls(context = T.unsafe(nil)); end
|
308
|
+
|
309
|
+
# Enables SMTP/TLS (STARTTLS) for this object if server accepts.
|
310
|
+
# +context+ is a OpenSSL::SSL::SSLContext object.
|
311
|
+
#
|
312
|
+
# @raise [ArgumentError]
|
313
|
+
#
|
314
|
+
# source://net-smtp//lib/net/smtp.rb#399
|
315
|
+
def enable_starttls_auto(context = T.unsafe(nil)); end
|
316
|
+
|
317
|
+
# Enables SMTP/TLS (SMTPS: \SMTP over direct TLS connection) for
|
318
|
+
# this object. Must be called before the connection is established
|
319
|
+
# to have any effect. +context+ is a OpenSSL::SSL::SSLContext object.
|
320
|
+
#
|
321
|
+
# @raise [ArgumentError]
|
322
|
+
#
|
323
|
+
# source://net-smtp//lib/net/smtp.rb#353
|
324
|
+
def enable_tls(context = T.unsafe(nil)); end
|
325
|
+
|
326
|
+
# Set whether to use ESMTP or not. This should be done before
|
327
|
+
# calling #start. Note that if #start is called in ESMTP mode,
|
328
|
+
# and the connection fails due to a ProtocolError, the SMTP
|
329
|
+
# object will automatically switch to plain SMTP mode and
|
330
|
+
# retry (but not vice versa).
|
331
|
+
#
|
332
|
+
# source://net-smtp//lib/net/smtp.rb#289
|
333
|
+
def esmtp; end
|
334
|
+
|
335
|
+
# Set whether to use ESMTP or not. This should be done before
|
336
|
+
# calling #start. Note that if #start is called in ESMTP mode,
|
337
|
+
# and the connection fails due to a ProtocolError, the SMTP
|
338
|
+
# object will automatically switch to plain SMTP mode and
|
339
|
+
# retry (but not vice versa).
|
340
|
+
#
|
341
|
+
# source://net-smtp//lib/net/smtp.rb#289
|
342
|
+
def esmtp=(_arg0); end
|
343
|
+
|
344
|
+
# Set whether to use ESMTP or not. This should be done before
|
345
|
+
# calling #start. Note that if #start is called in ESMTP mode,
|
346
|
+
# and the connection fails due to a ProtocolError, the SMTP
|
347
|
+
# object will automatically switch to plain SMTP mode and
|
348
|
+
# retry (but not vice versa).
|
349
|
+
# +true+ if the SMTP object uses ESMTP (which it does by default).
|
350
|
+
#
|
351
|
+
# source://net-smtp//lib/net/smtp.rb#289
|
352
|
+
def esmtp?; end
|
353
|
+
|
354
|
+
# Finishes the SMTP session and closes TCP connection.
|
355
|
+
# Raises IOError if not started.
|
356
|
+
#
|
357
|
+
# @raise [IOError]
|
358
|
+
#
|
359
|
+
# source://net-smtp//lib/net/smtp.rb#655
|
360
|
+
def finish; end
|
361
|
+
|
362
|
+
# source://net-smtp//lib/net/smtp.rb#989
|
363
|
+
def get_response(reqline); end
|
364
|
+
|
365
|
+
# source://net-smtp//lib/net/smtp.rb#903
|
366
|
+
def helo(domain); end
|
367
|
+
|
368
|
+
# Provide human-readable stringification of class state.
|
369
|
+
#
|
370
|
+
# source://net-smtp//lib/net/smtp.rb#278
|
371
|
+
def inspect; end
|
372
|
+
|
373
|
+
# +from_addr+ is +String+ or +Net::SMTP::Address+
|
374
|
+
#
|
375
|
+
# source://net-smtp//lib/net/smtp.rb#912
|
376
|
+
def mailfrom(from_addr); end
|
377
|
+
|
378
|
+
# Opens a message writer stream and gives it to the block.
|
379
|
+
# The stream is valid only in the block, and has these methods:
|
380
|
+
#
|
381
|
+
# puts(str = ''):: outputs STR and CR LF.
|
382
|
+
# print(str):: outputs STR.
|
383
|
+
# printf(fmt, *args):: outputs sprintf(fmt,*args).
|
384
|
+
# write(str):: outputs STR and returns the length of written bytes.
|
385
|
+
# <<(str):: outputs STR and returns self.
|
386
|
+
#
|
387
|
+
# If a single CR ("\r") or LF ("\n") is found in the message,
|
388
|
+
# it is converted to the CR LF pair. You cannot send a binary
|
389
|
+
# message with this method.
|
390
|
+
#
|
391
|
+
# === Parameters
|
392
|
+
#
|
393
|
+
# +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
|
394
|
+
#
|
395
|
+
# +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
|
396
|
+
# the destination mail address or addresses.
|
397
|
+
#
|
398
|
+
# === Example
|
399
|
+
#
|
400
|
+
# Net::SMTP.start('smtp.example.com', 25) do |smtp|
|
401
|
+
# smtp.open_message_stream('from@example.com', ['dest@example.com']) do |f|
|
402
|
+
# f.puts 'From: from@example.com'
|
403
|
+
# f.puts 'To: dest@example.com'
|
404
|
+
# f.puts 'Subject: test message'
|
405
|
+
# f.puts
|
406
|
+
# f.puts 'This is a test message.'
|
407
|
+
# end
|
408
|
+
# end
|
409
|
+
#
|
410
|
+
# === Errors
|
411
|
+
#
|
412
|
+
# This method may raise:
|
413
|
+
#
|
414
|
+
# * Net::SMTPServerBusy
|
415
|
+
# * Net::SMTPSyntaxError
|
416
|
+
# * Net::SMTPFatalError
|
417
|
+
# * Net::SMTPUnknownError
|
418
|
+
# * Net::ReadTimeout
|
419
|
+
# * IOError
|
420
|
+
#
|
421
|
+
# @raise [IOError]
|
422
|
+
#
|
423
|
+
# source://net-smtp//lib/net/smtp.rb#849
|
424
|
+
def open_message_stream(from_addr, *to_addrs, &block); end
|
425
|
+
|
426
|
+
# Seconds to wait while attempting to open a connection.
|
427
|
+
# If the connection cannot be opened within this time, a
|
428
|
+
# Net::OpenTimeout is raised. The default value is 30 seconds.
|
429
|
+
#
|
430
|
+
# source://net-smtp//lib/net/smtp.rb#422
|
431
|
+
def open_timeout; end
|
432
|
+
|
433
|
+
# Seconds to wait while attempting to open a connection.
|
434
|
+
# If the connection cannot be opened within this time, a
|
435
|
+
# Net::OpenTimeout is raised. The default value is 30 seconds.
|
436
|
+
#
|
437
|
+
# source://net-smtp//lib/net/smtp.rb#422
|
438
|
+
def open_timeout=(_arg0); end
|
439
|
+
|
440
|
+
# The port number of the SMTP server to connect to.
|
441
|
+
#
|
442
|
+
# source://net-smtp//lib/net/smtp.rb#417
|
443
|
+
def port; end
|
444
|
+
|
445
|
+
# source://net-smtp//lib/net/smtp.rb#985
|
446
|
+
def quit; end
|
447
|
+
|
448
|
+
# +to_addr+ is +String+ or +Net::SMTP::Address+
|
449
|
+
#
|
450
|
+
# source://net-smtp//lib/net/smtp.rb#930
|
451
|
+
def rcptto(to_addr); end
|
452
|
+
|
453
|
+
# @raise [ArgumentError]
|
454
|
+
#
|
455
|
+
# source://net-smtp//lib/net/smtp.rb#921
|
456
|
+
def rcptto_list(to_addrs); end
|
457
|
+
|
458
|
+
# Seconds to wait while reading one block (by one read(2) call).
|
459
|
+
# If the read(2) call does not complete within this time, a
|
460
|
+
# Net::ReadTimeout is raised. The default value is 60 seconds.
|
461
|
+
#
|
462
|
+
# source://net-smtp//lib/net/smtp.rb#427
|
463
|
+
def read_timeout; end
|
464
|
+
|
465
|
+
# Set the number of seconds to wait until timing-out a read(2)
|
466
|
+
# call.
|
467
|
+
#
|
468
|
+
# source://net-smtp//lib/net/smtp.rb#431
|
469
|
+
def read_timeout=(sec); end
|
470
|
+
|
471
|
+
# Opens a message writer stream and gives it to the block.
|
472
|
+
# The stream is valid only in the block, and has these methods:
|
473
|
+
#
|
474
|
+
# puts(str = ''):: outputs STR and CR LF.
|
475
|
+
# print(str):: outputs STR.
|
476
|
+
# printf(fmt, *args):: outputs sprintf(fmt,*args).
|
477
|
+
# write(str):: outputs STR and returns the length of written bytes.
|
478
|
+
# <<(str):: outputs STR and returns self.
|
479
|
+
#
|
480
|
+
# If a single CR ("\r") or LF ("\n") is found in the message,
|
481
|
+
# it is converted to the CR LF pair. You cannot send a binary
|
482
|
+
# message with this method.
|
483
|
+
#
|
484
|
+
# === Parameters
|
485
|
+
#
|
486
|
+
# +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
|
487
|
+
#
|
488
|
+
# +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
|
489
|
+
# the destination mail address or addresses.
|
490
|
+
#
|
491
|
+
# === Example
|
492
|
+
#
|
493
|
+
# Net::SMTP.start('smtp.example.com', 25) do |smtp|
|
494
|
+
# smtp.open_message_stream('from@example.com', ['dest@example.com']) do |f|
|
495
|
+
# f.puts 'From: from@example.com'
|
496
|
+
# f.puts 'To: dest@example.com'
|
497
|
+
# f.puts 'Subject: test message'
|
498
|
+
# f.puts
|
499
|
+
# f.puts 'This is a test message.'
|
500
|
+
# end
|
501
|
+
# end
|
502
|
+
#
|
503
|
+
# === Errors
|
504
|
+
#
|
505
|
+
# This method may raise:
|
506
|
+
#
|
507
|
+
# * Net::SMTPServerBusy
|
508
|
+
# * Net::SMTPSyntaxError
|
509
|
+
# * Net::SMTPFatalError
|
510
|
+
# * Net::SMTPUnknownError
|
511
|
+
# * Net::ReadTimeout
|
512
|
+
# * IOError
|
513
|
+
# obsolete
|
514
|
+
#
|
515
|
+
# @raise [IOError]
|
516
|
+
#
|
517
|
+
# source://net-smtp//lib/net/smtp.rb#849
|
518
|
+
def ready(from_addr, *to_addrs, &block); end
|
519
|
+
|
520
|
+
# Aborts the current mail transaction
|
521
|
+
#
|
522
|
+
# source://net-smtp//lib/net/smtp.rb#895
|
523
|
+
def rset; end
|
524
|
+
|
525
|
+
# Sends +msgstr+ as a message. Single CR ("\r") and LF ("\n") found
|
526
|
+
# in the +msgstr+, are converted into the CR LF pair. You cannot send a
|
527
|
+
# binary message with this method. +msgstr+ should include both
|
528
|
+
# the message headers and body.
|
529
|
+
#
|
530
|
+
# +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
|
531
|
+
#
|
532
|
+
# +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
|
533
|
+
# the destination mail address or addresses.
|
534
|
+
#
|
535
|
+
# === Example
|
536
|
+
#
|
537
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
538
|
+
# smtp.send_message msgstr,
|
539
|
+
# 'from@example.com',
|
540
|
+
# ['dest@example.com', 'dest2@example.com']
|
541
|
+
# end
|
542
|
+
#
|
543
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
544
|
+
# smtp.send_message msgstr,
|
545
|
+
# Net::SMTP::Address.new('from@example.com', size: 12345),
|
546
|
+
# Net::SMTP::Address.new('dest@example.com', notify: :success)
|
547
|
+
# end
|
548
|
+
#
|
549
|
+
# === Errors
|
550
|
+
#
|
551
|
+
# This method may raise:
|
552
|
+
#
|
553
|
+
# * Net::SMTPServerBusy
|
554
|
+
# * Net::SMTPSyntaxError
|
555
|
+
# * Net::SMTPFatalError
|
556
|
+
# * Net::SMTPUnknownError
|
557
|
+
# * Net::ReadTimeout
|
558
|
+
# * IOError
|
559
|
+
#
|
560
|
+
# @raise [IOError]
|
561
|
+
#
|
562
|
+
# source://net-smtp//lib/net/smtp.rb#794
|
563
|
+
def send_mail(msgstr, from_addr, *to_addrs); end
|
564
|
+
|
565
|
+
# Sends +msgstr+ as a message. Single CR ("\r") and LF ("\n") found
|
566
|
+
# in the +msgstr+, are converted into the CR LF pair. You cannot send a
|
567
|
+
# binary message with this method. +msgstr+ should include both
|
568
|
+
# the message headers and body.
|
569
|
+
#
|
570
|
+
# +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
|
571
|
+
#
|
572
|
+
# +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
|
573
|
+
# the destination mail address or addresses.
|
574
|
+
#
|
575
|
+
# === Example
|
576
|
+
#
|
577
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
578
|
+
# smtp.send_message msgstr,
|
579
|
+
# 'from@example.com',
|
580
|
+
# ['dest@example.com', 'dest2@example.com']
|
581
|
+
# end
|
582
|
+
#
|
583
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
584
|
+
# smtp.send_message msgstr,
|
585
|
+
# Net::SMTP::Address.new('from@example.com', size: 12345),
|
586
|
+
# Net::SMTP::Address.new('dest@example.com', notify: :success)
|
587
|
+
# end
|
588
|
+
#
|
589
|
+
# === Errors
|
590
|
+
#
|
591
|
+
# This method may raise:
|
592
|
+
#
|
593
|
+
# * Net::SMTPServerBusy
|
594
|
+
# * Net::SMTPSyntaxError
|
595
|
+
# * Net::SMTPFatalError
|
596
|
+
# * Net::SMTPUnknownError
|
597
|
+
# * Net::ReadTimeout
|
598
|
+
# * IOError
|
599
|
+
#
|
600
|
+
# @raise [IOError]
|
601
|
+
#
|
602
|
+
# source://net-smtp//lib/net/smtp.rb#794
|
603
|
+
def send_message(msgstr, from_addr, *to_addrs); end
|
604
|
+
|
605
|
+
# Sends +msgstr+ as a message. Single CR ("\r") and LF ("\n") found
|
606
|
+
# in the +msgstr+, are converted into the CR LF pair. You cannot send a
|
607
|
+
# binary message with this method. +msgstr+ should include both
|
608
|
+
# the message headers and body.
|
609
|
+
#
|
610
|
+
# +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
|
611
|
+
#
|
612
|
+
# +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
|
613
|
+
# the destination mail address or addresses.
|
614
|
+
#
|
615
|
+
# === Example
|
616
|
+
#
|
617
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
618
|
+
# smtp.send_message msgstr,
|
619
|
+
# 'from@example.com',
|
620
|
+
# ['dest@example.com', 'dest2@example.com']
|
621
|
+
# end
|
622
|
+
#
|
623
|
+
# Net::SMTP.start('smtp.example.com') do |smtp|
|
624
|
+
# smtp.send_message msgstr,
|
625
|
+
# Net::SMTP::Address.new('from@example.com', size: 12345),
|
626
|
+
# Net::SMTP::Address.new('dest@example.com', notify: :success)
|
627
|
+
# end
|
628
|
+
#
|
629
|
+
# === Errors
|
630
|
+
#
|
631
|
+
# This method may raise:
|
632
|
+
#
|
633
|
+
# * Net::SMTPServerBusy
|
634
|
+
# * Net::SMTPSyntaxError
|
635
|
+
# * Net::SMTPFatalError
|
636
|
+
# * Net::SMTPUnknownError
|
637
|
+
# * Net::ReadTimeout
|
638
|
+
# * IOError
|
639
|
+
# obsolete
|
640
|
+
#
|
641
|
+
# @raise [IOError]
|
642
|
+
#
|
643
|
+
# source://net-smtp//lib/net/smtp.rb#794
|
644
|
+
def sendmail(msgstr, from_addr, *to_addrs); end
|
645
|
+
|
646
|
+
# WARNING: This method causes serious security holes.
|
647
|
+
# Use this method for only debugging.
|
648
|
+
#
|
649
|
+
# Set an output stream for debug logging.
|
650
|
+
# You must call this before #start.
|
651
|
+
#
|
652
|
+
# # example
|
653
|
+
# smtp = Net::SMTP.new(addr, port)
|
654
|
+
# smtp.set_debug_output $stderr
|
655
|
+
# smtp.start do |smtp|
|
656
|
+
# ....
|
657
|
+
# end
|
658
|
+
#
|
659
|
+
# source://net-smtp//lib/net/smtp.rb#450
|
660
|
+
def set_debug_output(arg); end
|
661
|
+
|
662
|
+
# true if this object uses SMTP/TLS (SMTPS).
|
663
|
+
#
|
664
|
+
# @return [Boolean]
|
665
|
+
#
|
666
|
+
# source://net-smtp//lib/net/smtp.rb#344
|
667
|
+
def ssl?; end
|
668
|
+
|
669
|
+
# Hash for additional SSLContext parameters.
|
670
|
+
#
|
671
|
+
# source://net-smtp//lib/net/smtp.rb#275
|
672
|
+
def ssl_context_params; end
|
673
|
+
|
674
|
+
# Hash for additional SSLContext parameters.
|
675
|
+
#
|
676
|
+
# source://net-smtp//lib/net/smtp.rb#275
|
677
|
+
def ssl_context_params=(_arg0); end
|
678
|
+
|
679
|
+
# :call-seq:
|
680
|
+
# start(helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... }
|
681
|
+
# start(helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }
|
682
|
+
#
|
683
|
+
# Opens a TCP connection and starts the SMTP session.
|
684
|
+
#
|
685
|
+
# === Parameters
|
686
|
+
#
|
687
|
+
# +helo+ is the _HELO_ _domain_ that you'll dispatch mails from; see
|
688
|
+
# the discussion in the overview notes.
|
689
|
+
#
|
690
|
+
# The remaining arguments are used for \SMTP authentication, if required or
|
691
|
+
# desired.
|
692
|
+
#
|
693
|
+
# +authtype+ is the SASL authentication mechanism.
|
694
|
+
#
|
695
|
+
# +user+ is the authentication or authorization identity.
|
696
|
+
#
|
697
|
+
# +secret+ or +password+ is your password or other authentication token.
|
698
|
+
#
|
699
|
+
# These will be sent to #authenticate as positional arguments-the exact
|
700
|
+
# semantics are dependent on the +authtype+.
|
701
|
+
#
|
702
|
+
# See the discussion of Net::SMTP@SMTP+Authentication in the overview notes.
|
703
|
+
#
|
704
|
+
# See also: Net::SMTP.start
|
705
|
+
#
|
706
|
+
# === Block Usage
|
707
|
+
#
|
708
|
+
# When this methods is called with a block, the newly-started SMTP
|
709
|
+
# object is yielded to the block, and automatically closed after
|
710
|
+
# the block call finishes. Otherwise, it is the caller's
|
711
|
+
# responsibility to close the session when finished.
|
712
|
+
#
|
713
|
+
# === Example
|
714
|
+
#
|
715
|
+
# This is very similar to the class method SMTP.start.
|
716
|
+
#
|
717
|
+
# require 'net/smtp'
|
718
|
+
# smtp = Net::SMTP.new('smtp.mail.server', 25)
|
719
|
+
# smtp.start(helo: helo_domain, user: account, secret: password, authtype: authtype) do |smtp|
|
720
|
+
# smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
|
721
|
+
# end
|
722
|
+
#
|
723
|
+
# The primary use of this method (as opposed to SMTP.start)
|
724
|
+
# is probably to set debugging (#set_debug_output) or ESMTP
|
725
|
+
# (#esmtp=), which must be done before the session is
|
726
|
+
# started.
|
727
|
+
#
|
728
|
+
# === Errors
|
729
|
+
#
|
730
|
+
# If session has already been started, an IOError will be raised.
|
731
|
+
#
|
732
|
+
# This method may raise:
|
733
|
+
#
|
734
|
+
# * Net::SMTPAuthenticationError
|
735
|
+
# * Net::SMTPServerBusy
|
736
|
+
# * Net::SMTPSyntaxError
|
737
|
+
# * Net::SMTPFatalError
|
738
|
+
# * Net::SMTPUnknownError
|
739
|
+
# * Net::OpenTimeout
|
740
|
+
# * Net::ReadTimeout
|
741
|
+
# * IOError
|
742
|
+
#
|
743
|
+
# @raise [ArgumentError]
|
744
|
+
#
|
745
|
+
# source://net-smtp//lib/net/smtp.rb#622
|
746
|
+
def start(*args, helo: T.unsafe(nil), user: T.unsafe(nil), secret: T.unsafe(nil), password: T.unsafe(nil), authtype: T.unsafe(nil)); end
|
747
|
+
|
748
|
+
# +true+ if the \SMTP session has been started.
|
749
|
+
#
|
750
|
+
# @return [Boolean]
|
751
|
+
#
|
752
|
+
# source://net-smtp//lib/net/smtp.rb#553
|
753
|
+
def started?; end
|
754
|
+
|
755
|
+
# source://net-smtp//lib/net/smtp.rb#899
|
756
|
+
def starttls; end
|
757
|
+
|
758
|
+
# Returns truth value if this object uses STARTTLS.
|
759
|
+
# If this object always uses STARTTLS, returns :always.
|
760
|
+
# If this object uses STARTTLS when the server support TLS, returns :auto.
|
761
|
+
#
|
762
|
+
# @return [Boolean]
|
763
|
+
#
|
764
|
+
# source://net-smtp//lib/net/smtp.rb#374
|
765
|
+
def starttls?; end
|
766
|
+
|
767
|
+
# true if this object uses STARTTLS.
|
768
|
+
#
|
769
|
+
# @return [Boolean]
|
770
|
+
#
|
771
|
+
# source://net-smtp//lib/net/smtp.rb#379
|
772
|
+
def starttls_always?; end
|
773
|
+
|
774
|
+
# true if this object uses STARTTLS when server advertises STARTTLS.
|
775
|
+
#
|
776
|
+
# @return [Boolean]
|
777
|
+
#
|
778
|
+
# source://net-smtp//lib/net/smtp.rb#384
|
779
|
+
def starttls_auto?; end
|
780
|
+
|
781
|
+
# true if this object uses SMTP/TLS (SMTPS).
|
782
|
+
#
|
783
|
+
# @return [Boolean]
|
784
|
+
#
|
785
|
+
# source://net-smtp//lib/net/smtp.rb#344
|
786
|
+
def tls?; end
|
787
|
+
|
788
|
+
# The hostname for verifying hostname in the server certificatate.
|
789
|
+
#
|
790
|
+
# source://net-smtp//lib/net/smtp.rb#272
|
791
|
+
def tls_hostname; end
|
792
|
+
|
793
|
+
# The hostname for verifying hostname in the server certificatate.
|
794
|
+
#
|
795
|
+
# source://net-smtp//lib/net/smtp.rb#272
|
796
|
+
def tls_hostname=(_arg0); end
|
797
|
+
|
798
|
+
# If +true+, verify th server's certificate.
|
799
|
+
#
|
800
|
+
# source://net-smtp//lib/net/smtp.rb#269
|
801
|
+
def tls_verify; end
|
802
|
+
|
803
|
+
# If +true+, verify th server's certificate.
|
804
|
+
#
|
805
|
+
# source://net-smtp//lib/net/smtp.rb#269
|
806
|
+
def tls_verify=(_arg0); end
|
807
|
+
|
808
|
+
private
|
809
|
+
|
810
|
+
# source://net-smtp//lib/net/smtp.rb#748
|
811
|
+
def any_require_smtputf8(addresses); end
|
812
|
+
|
813
|
+
# source://net-smtp//lib/net/smtp.rb#880
|
814
|
+
def check_auth_args(type, *args, **kwargs); end
|
815
|
+
|
816
|
+
# source://net-smtp//lib/net/smtp.rb#1040
|
817
|
+
def check_continue(res); end
|
818
|
+
|
819
|
+
# source://net-smtp//lib/net/smtp.rb#1034
|
820
|
+
def check_response(res); end
|
821
|
+
|
822
|
+
# source://net-smtp//lib/net/smtp.rb#1024
|
823
|
+
def critical; end
|
824
|
+
|
825
|
+
# source://net-smtp//lib/net/smtp.rb#731
|
826
|
+
def do_finish; end
|
827
|
+
|
828
|
+
# source://net-smtp//lib/net/smtp.rb#719
|
829
|
+
def do_helo(helo_domain); end
|
830
|
+
|
831
|
+
# source://net-smtp//lib/net/smtp.rb#666
|
832
|
+
def do_start(helo_domain, user, secret, authtype); end
|
833
|
+
|
834
|
+
# source://net-smtp//lib/net/smtp.rb#1004
|
835
|
+
def getok(reqline); end
|
836
|
+
|
837
|
+
# source://net-smtp//lib/net/smtp.rb#1125
|
838
|
+
def logging(msg); end
|
839
|
+
|
840
|
+
# source://net-smtp//lib/net/smtp.rb#714
|
841
|
+
def new_internet_message_io(s); end
|
842
|
+
|
843
|
+
# source://net-smtp//lib/net/smtp.rb#1014
|
844
|
+
def recv_response; end
|
845
|
+
|
846
|
+
# source://net-smtp//lib/net/smtp.rb#740
|
847
|
+
def requires_smtputf8(address); end
|
848
|
+
|
849
|
+
# source://net-smtp//lib/net/smtp.rb#697
|
850
|
+
def ssl_socket(socket, context); end
|
851
|
+
|
852
|
+
# source://net-smtp//lib/net/smtp.rb#662
|
853
|
+
def tcp_socket(address, port); end
|
854
|
+
|
855
|
+
# source://net-smtp//lib/net/smtp.rb#701
|
856
|
+
def tlsconnect(s, context); end
|
857
|
+
|
858
|
+
# source://net-smtp//lib/net/smtp.rb#997
|
859
|
+
def validate_line(line); end
|
860
|
+
|
861
|
+
class << self
|
862
|
+
# The default SMTP port number, 25.
|
863
|
+
#
|
864
|
+
# source://net-smtp//lib/net/smtp.rb#198
|
865
|
+
def default_port; end
|
866
|
+
|
867
|
+
# source://net-smtp//lib/net/smtp.rb#216
|
868
|
+
def default_ssl_context(ssl_context_params = T.unsafe(nil)); end
|
869
|
+
|
870
|
+
# The default SMTPS port number, 465.
|
871
|
+
#
|
872
|
+
# source://net-smtp//lib/net/smtp.rb#208
|
873
|
+
def default_ssl_port; end
|
874
|
+
|
875
|
+
# The default mail submission port number, 587.
|
876
|
+
#
|
877
|
+
# source://net-smtp//lib/net/smtp.rb#203
|
878
|
+
def default_submission_port; end
|
879
|
+
|
880
|
+
# The default SMTPS port number, 465.
|
881
|
+
#
|
882
|
+
# source://net-smtp//lib/net/smtp.rb#208
|
883
|
+
def default_tls_port; end
|
884
|
+
|
885
|
+
# :call-seq:
|
886
|
+
# start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil) { |smtp| ... }
|
887
|
+
# start(address, port = nil, helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }
|
888
|
+
#
|
889
|
+
# Creates a new Net::SMTP object and connects to the server.
|
890
|
+
#
|
891
|
+
# This method is equivalent to:
|
892
|
+
#
|
893
|
+
# Net::SMTP.new(address, port, tls_verify: flag, tls_hostname: hostname, ssl_context_params: nil)
|
894
|
+
# .start(helo: helo_domain, user: account, secret: password, authtype: authtype)
|
895
|
+
#
|
896
|
+
# See also: Net::SMTP.new, #start
|
897
|
+
#
|
898
|
+
# === Example
|
899
|
+
#
|
900
|
+
# Net::SMTP.start('your.smtp.server') do |smtp|
|
901
|
+
# smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
|
902
|
+
# end
|
903
|
+
#
|
904
|
+
# === Block Usage
|
905
|
+
#
|
906
|
+
# If called with a block, the newly-opened Net::SMTP object is yielded
|
907
|
+
# to the block, and automatically closed when the block finishes. If called
|
908
|
+
# without a block, the newly-opened Net::SMTP object is returned to
|
909
|
+
# the caller, and it is the caller's responsibility to close it when
|
910
|
+
# finished.
|
911
|
+
#
|
912
|
+
# === Parameters
|
913
|
+
#
|
914
|
+
# +address+ is the hostname or ip address of your smtp server.
|
915
|
+
#
|
916
|
+
# +port+ is the port to connect to; it defaults to port 25.
|
917
|
+
#
|
918
|
+
# +helo+ is the _HELO_ _domain_ provided by the client to the
|
919
|
+
# server (see overview comments); it defaults to 'localhost'.
|
920
|
+
#
|
921
|
+
# If +tls+ is true, enable TLS. The default is false.
|
922
|
+
# If +starttls+ is :always, enable STARTTLS, if +:auto+, use STARTTLS when the server supports it,
|
923
|
+
# if false, disable STARTTLS.
|
924
|
+
#
|
925
|
+
# If +tls_verify+ is true, verify the server's certificate. The default is true.
|
926
|
+
# If the hostname in the server certificate is different from +address+,
|
927
|
+
# it can be specified with +tls_hostname+.
|
928
|
+
#
|
929
|
+
# Additional SSLContext[https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html]
|
930
|
+
# params can be added to the +ssl_context_params+ hash argument and are
|
931
|
+
# passed to {OpenSSL::SSL::SSLContext#set_params}[https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html#method-i-set_params].
|
932
|
+
#
|
933
|
+
# <tt>tls_verify: true</tt> is equivalent to <tt>ssl_context_params: {
|
934
|
+
# verify_mode: OpenSSL::SSL::VERIFY_PEER }</tt>.
|
935
|
+
#
|
936
|
+
# The remaining arguments are used for \SMTP authentication, if required or
|
937
|
+
# desired.
|
938
|
+
#
|
939
|
+
# +authtype+ is the SASL authentication mechanism.
|
940
|
+
#
|
941
|
+
# +user+ is the authentication or authorization identity.
|
942
|
+
#
|
943
|
+
# +secret+ or +password+ is your password or other authentication token.
|
944
|
+
#
|
945
|
+
# These will be sent to #authenticate as positional arguments-the exact
|
946
|
+
# semantics are dependent on the +authtype+.
|
947
|
+
#
|
948
|
+
# See the discussion of Net::SMTP@SMTP+Authentication in the overview notes.
|
949
|
+
#
|
950
|
+
# === Errors
|
951
|
+
#
|
952
|
+
# This method may raise:
|
953
|
+
#
|
954
|
+
# * Net::SMTPAuthenticationError
|
955
|
+
# * Net::SMTPServerBusy
|
956
|
+
# * Net::SMTPSyntaxError
|
957
|
+
# * Net::SMTPFatalError
|
958
|
+
# * Net::SMTPUnknownError
|
959
|
+
# * Net::OpenTimeout
|
960
|
+
# * Net::ReadTimeout
|
961
|
+
# * IOError
|
962
|
+
#
|
963
|
+
# @raise [ArgumentError]
|
964
|
+
#
|
965
|
+
# source://net-smtp//lib/net/smtp.rb#539
|
966
|
+
def start(address, port = T.unsafe(nil), *args, helo: T.unsafe(nil), user: T.unsafe(nil), secret: T.unsafe(nil), password: T.unsafe(nil), authtype: T.unsafe(nil), tls: T.unsafe(nil), starttls: T.unsafe(nil), tls_verify: T.unsafe(nil), tls_hostname: T.unsafe(nil), ssl_context_params: T.unsafe(nil), &block); end
|
967
|
+
end
|
968
|
+
end
|
969
|
+
|
970
|
+
# Address with parametres for MAIL or RCPT command
|
971
|
+
#
|
972
|
+
# source://net-smtp//lib/net/smtp.rb#1130
|
973
|
+
class Net::SMTP::Address
|
974
|
+
# :call-seq:
|
975
|
+
# initialize(address, parameter, ...)
|
976
|
+
#
|
977
|
+
# address +String+ or +Net::SMTP::Address+
|
978
|
+
# parameter +String+ or +Hash+
|
979
|
+
#
|
980
|
+
# @return [Address] a new instance of Address
|
981
|
+
#
|
982
|
+
# source://net-smtp//lib/net/smtp.rb#1141
|
983
|
+
def initialize(address, *args, **kw_args); end
|
984
|
+
|
985
|
+
# mail address [String]
|
986
|
+
#
|
987
|
+
# source://net-smtp//lib/net/smtp.rb#1132
|
988
|
+
def address; end
|
989
|
+
|
990
|
+
# parameters [Array<String>]
|
991
|
+
#
|
992
|
+
# source://net-smtp//lib/net/smtp.rb#1134
|
993
|
+
def parameters; end
|
994
|
+
|
995
|
+
# source://net-smtp//lib/net/smtp.rb#1152
|
996
|
+
def to_s; end
|
997
|
+
end
|
998
|
+
|
999
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#9
|
1000
|
+
class Net::SMTP::AuthCramMD5 < ::Net::SMTP::Authenticator
|
1001
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#12
|
1002
|
+
def auth(user, secret); end
|
1003
|
+
|
1004
|
+
# CRAM-MD5: [RFC2195]
|
1005
|
+
#
|
1006
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#22
|
1007
|
+
def cram_md5_response(secret, challenge); end
|
1008
|
+
|
1009
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#29
|
1010
|
+
def cram_secret(secret, mask); end
|
1011
|
+
|
1012
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#38
|
1013
|
+
def digest_class; end
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#27
|
1017
|
+
Net::SMTP::AuthCramMD5::CRAM_BUFSIZE = T.let(T.unsafe(nil), Integer)
|
1018
|
+
|
1019
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#18
|
1020
|
+
Net::SMTP::AuthCramMD5::IMASK = T.let(T.unsafe(nil), Integer)
|
1021
|
+
|
1022
|
+
# source://net-smtp//lib/net/smtp/auth_cram_md5.rb#19
|
1023
|
+
Net::SMTP::AuthCramMD5::OMASK = T.let(T.unsafe(nil), Integer)
|
1024
|
+
|
1025
|
+
# source://net-smtp//lib/net/smtp/auth_login.rb#2
|
1026
|
+
class Net::SMTP::AuthLogin < ::Net::SMTP::Authenticator
|
1027
|
+
# source://net-smtp//lib/net/smtp/auth_login.rb#5
|
1028
|
+
def auth(user, secret); end
|
1029
|
+
end
|
1030
|
+
|
1031
|
+
# source://net-smtp//lib/net/smtp/auth_plain.rb#2
|
1032
|
+
class Net::SMTP::AuthPlain < ::Net::SMTP::Authenticator
|
1033
|
+
# source://net-smtp//lib/net/smtp/auth_plain.rb#5
|
1034
|
+
def auth(user, secret); end
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# source://net-smtp//lib/net/smtp/auth_xoauth2.rb#2
|
1038
|
+
class Net::SMTP::AuthXoauth2 < ::Net::SMTP::Authenticator
|
1039
|
+
# source://net-smtp//lib/net/smtp/auth_xoauth2.rb#5
|
1040
|
+
def auth(user, secret); end
|
1041
|
+
|
1042
|
+
private
|
1043
|
+
|
1044
|
+
# source://net-smtp//lib/net/smtp/auth_xoauth2.rb#13
|
1045
|
+
def xoauth2_string(user, secret); end
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#3
|
1049
|
+
class Net::SMTP::Authenticator
|
1050
|
+
# @return [Authenticator] a new instance of Authenticator
|
1051
|
+
#
|
1052
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#29
|
1053
|
+
def initialize(smtp); end
|
1054
|
+
|
1055
|
+
# @param str [String]
|
1056
|
+
# @return [String] Base64 encoded string
|
1057
|
+
#
|
1058
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#51
|
1059
|
+
def base64_encode(str); end
|
1060
|
+
|
1061
|
+
# @param arg [String] message to server
|
1062
|
+
# @raise [res.exception_class]
|
1063
|
+
# @return [String] message from server
|
1064
|
+
#
|
1065
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#35
|
1066
|
+
def continue(arg); end
|
1067
|
+
|
1068
|
+
# @param arg [String] message to server
|
1069
|
+
# @raise [SMTPAuthenticationError]
|
1070
|
+
# @return [Net::SMTP::Response] response from server
|
1071
|
+
#
|
1072
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#43
|
1073
|
+
def finish(arg); end
|
1074
|
+
|
1075
|
+
# Returns the value of attribute smtp.
|
1076
|
+
#
|
1077
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#27
|
1078
|
+
def smtp; end
|
1079
|
+
|
1080
|
+
class << self
|
1081
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#13
|
1082
|
+
def auth_class(type); end
|
1083
|
+
|
1084
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#4
|
1085
|
+
def auth_classes; end
|
1086
|
+
|
1087
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#8
|
1088
|
+
def auth_type(type); end
|
1089
|
+
|
1090
|
+
# source://net-smtp//lib/net/smtp/authenticator.rb#18
|
1091
|
+
def check_args(user_arg = T.unsafe(nil), secret_arg = T.unsafe(nil), *_arg2, **_arg3); end
|
1092
|
+
end
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# This class represents a response received by the SMTP server. Instances
|
1096
|
+
# of this class are created by the SMTP class; they should not be directly
|
1097
|
+
# created by the user. For more information on SMTP responses, view
|
1098
|
+
# {Section 4.2 of RFC 5321}[http://tools.ietf.org/html/rfc5321#section-4.2]
|
1099
|
+
#
|
1100
|
+
# source://net-smtp//lib/net/smtp.rb#1050
|
1101
|
+
class Net::SMTP::Response
|
1102
|
+
# Creates a new instance of the Response class and sets the status and
|
1103
|
+
# string attributes
|
1104
|
+
#
|
1105
|
+
# @return [Response] a new instance of Response
|
1106
|
+
#
|
1107
|
+
# source://net-smtp//lib/net/smtp.rb#1059
|
1108
|
+
def initialize(status, string); end
|
1109
|
+
|
1110
|
+
# Returns a hash of the human readable reply text in the response if it
|
1111
|
+
# is multiple lines. It does not return the first line. The key of the
|
1112
|
+
# hash is the first word the value of the hash is an array with each word
|
1113
|
+
# thereafter being a value in the array
|
1114
|
+
#
|
1115
|
+
# source://net-smtp//lib/net/smtp.rb#1102
|
1116
|
+
def capabilities; end
|
1117
|
+
|
1118
|
+
# Determines whether the response received was a Positive Intermediate
|
1119
|
+
# reply (3xx reply code)
|
1120
|
+
#
|
1121
|
+
# @return [Boolean]
|
1122
|
+
#
|
1123
|
+
# source://net-smtp//lib/net/smtp.rb#1083
|
1124
|
+
def continue?; end
|
1125
|
+
|
1126
|
+
# Creates a CRAM-MD5 challenge. You can view more information on CRAM-MD5
|
1127
|
+
# on Wikipedia: https://en.wikipedia.org/wiki/CRAM-MD5
|
1128
|
+
#
|
1129
|
+
# source://net-smtp//lib/net/smtp.rb#1094
|
1130
|
+
def cram_md5_challenge; end
|
1131
|
+
|
1132
|
+
# Determines whether there was an error and raises the appropriate error
|
1133
|
+
# based on the reply code of the response
|
1134
|
+
#
|
1135
|
+
# source://net-smtp//lib/net/smtp.rb#1114
|
1136
|
+
def exception_class; end
|
1137
|
+
|
1138
|
+
# The first line of the human readable reply text
|
1139
|
+
#
|
1140
|
+
# source://net-smtp//lib/net/smtp.rb#1088
|
1141
|
+
def message; end
|
1142
|
+
|
1143
|
+
# The three digit reply code of the SMTP response
|
1144
|
+
#
|
1145
|
+
# source://net-smtp//lib/net/smtp.rb#1065
|
1146
|
+
def status; end
|
1147
|
+
|
1148
|
+
# Takes the first digit of the reply code to determine the status type
|
1149
|
+
#
|
1150
|
+
# source://net-smtp//lib/net/smtp.rb#1071
|
1151
|
+
def status_type_char; end
|
1152
|
+
|
1153
|
+
# The human readable reply text of the SMTP response
|
1154
|
+
#
|
1155
|
+
# source://net-smtp//lib/net/smtp.rb#1068
|
1156
|
+
def string; end
|
1157
|
+
|
1158
|
+
# Determines whether the response received was a Positive Completion
|
1159
|
+
# reply (2xx reply code)
|
1160
|
+
#
|
1161
|
+
# @return [Boolean]
|
1162
|
+
#
|
1163
|
+
# source://net-smtp//lib/net/smtp.rb#1077
|
1164
|
+
def success?; end
|
1165
|
+
|
1166
|
+
class << self
|
1167
|
+
# Parses the received response and separates the reply code and the human
|
1168
|
+
# readable reply text
|
1169
|
+
#
|
1170
|
+
# source://net-smtp//lib/net/smtp.rb#1053
|
1171
|
+
def parse(str); end
|
1172
|
+
end
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
# source://net-smtp//lib/net/smtp.rb#195
|
1176
|
+
Net::SMTP::VERSION = T.let(T.unsafe(nil), String)
|
1177
|
+
|
1178
|
+
# source://net-smtp//lib/net/smtp.rb#49
|
1179
|
+
class Net::SMTPAuthenticationError < ::Net::ProtoAuthError
|
1180
|
+
include ::Net::SMTPError
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# Module mixed in to all SMTP error classes
|
1184
|
+
#
|
1185
|
+
# source://net-smtp//lib/net/smtp.rb#27
|
1186
|
+
module Net::SMTPError
|
1187
|
+
# source://net-smtp//lib/net/smtp.rb#33
|
1188
|
+
def initialize(response, message: T.unsafe(nil)); end
|
1189
|
+
|
1190
|
+
# source://net-smtp//lib/net/smtp.rb#43
|
1191
|
+
def message; end
|
1192
|
+
|
1193
|
+
# This *class* is a module for backward compatibility.
|
1194
|
+
# In later release, this module becomes a class.
|
1195
|
+
#
|
1196
|
+
# source://net-smtp//lib/net/smtp.rb#31
|
1197
|
+
def response; end
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
# source://net-smtp//lib/net/smtp.rb#64
|
1201
|
+
class Net::SMTPFatalError < ::Net::ProtoFatalError
|
1202
|
+
include ::Net::SMTPError
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# source://net-smtp//lib/net/smtp.rb#54
|
1206
|
+
class Net::SMTPServerBusy < ::Net::ProtoServerError
|
1207
|
+
include ::Net::SMTPError
|
1208
|
+
end
|
1209
|
+
|
1210
|
+
# class SMTP
|
1211
|
+
#
|
1212
|
+
# source://net-smtp//lib/net/smtp.rb#1158
|
1213
|
+
Net::SMTPSession = Net::SMTP
|
1214
|
+
|
1215
|
+
# source://net-smtp//lib/net/smtp.rb#59
|
1216
|
+
class Net::SMTPSyntaxError < ::Net::ProtoSyntaxError
|
1217
|
+
include ::Net::SMTPError
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# source://net-smtp//lib/net/smtp.rb#69
|
1221
|
+
class Net::SMTPUnknownError < ::Net::ProtoUnknownError
|
1222
|
+
include ::Net::SMTPError
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# source://net-smtp//lib/net/smtp.rb#74
|
1226
|
+
class Net::SMTPUnsupportedCommand < ::Net::ProtocolError
|
1227
|
+
include ::Net::SMTPError
|
1228
|
+
end
|