packwerk 2.2.0 → 2.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +29 -20
- data/.github/workflows/cla.yml +22 -0
- data/.rubocop.yml +48 -19
- data/Gemfile +7 -2
- data/Gemfile.lock +201 -175
- data/README.md +1 -1
- data/RESOLVING_VIOLATIONS.md +81 -0
- data/Rakefile +1 -1
- data/USAGE.md +14 -5
- data/bin/m +1 -1
- data/bin/rake +1 -1
- data/bin/rubocop +1 -1
- data/bin/srb +1 -1
- data/bin/tapioca +1 -1
- data/gemfiles/Gemfile-rails-6-0 +1 -1
- data/gemfiles/Gemfile-rails-6-1 +22 -0
- data/lib/packwerk/application_validator.rb +7 -6
- data/lib/packwerk/association_inspector.rb +17 -15
- data/lib/packwerk/cache.rb +36 -29
- data/lib/packwerk/cli.rb +5 -6
- data/lib/packwerk/const_node_inspector.rb +8 -7
- data/lib/packwerk/constant_name_inspector.rb +2 -2
- data/lib/packwerk/deprecated_references.rb +34 -19
- data/lib/packwerk/file_processor.rb +14 -14
- data/lib/packwerk/files_for_processing.rb +27 -31
- data/lib/packwerk/formatters/offenses_formatter.rb +3 -3
- data/lib/packwerk/formatters/progress_formatter.rb +2 -2
- data/lib/packwerk/node.rb +1 -294
- data/lib/packwerk/node_helpers.rb +335 -0
- data/lib/packwerk/node_processor.rb +6 -5
- data/lib/packwerk/node_processor_factory.rb +3 -3
- data/lib/packwerk/node_visitor.rb +1 -1
- data/lib/packwerk/offense_collection.rb +6 -3
- data/lib/packwerk/offenses_formatter.rb +2 -2
- data/lib/packwerk/package.rb +3 -0
- data/lib/packwerk/package_set.rb +2 -0
- data/lib/packwerk/parse_run.rb +15 -13
- data/lib/packwerk/parsed_constant_definitions.rb +23 -20
- data/lib/packwerk/parsers/erb.rb +3 -3
- data/lib/packwerk/reference_checking/checkers/checker.rb +16 -3
- data/lib/packwerk/reference_checking/checkers/dependency_checker.rb +16 -0
- data/lib/packwerk/reference_checking/checkers/privacy_checker.rb +18 -0
- data/lib/packwerk/reference_checking/reference_checker.rb +3 -1
- data/lib/packwerk/reference_extractor.rb +51 -48
- data/lib/packwerk/reference_offense.rb +3 -27
- data/lib/packwerk/run_context.rb +3 -3
- data/lib/packwerk/spring_command.rb +1 -1
- data/lib/packwerk/version.rb +1 -1
- data/lib/packwerk.rb +1 -0
- data/packwerk.gemspec +4 -12
- data/sorbet/rbi/gems/actioncable@7.0.3.1.rbi +2754 -0
- data/sorbet/rbi/gems/actionmailbox@7.0.3.1.rbi +1496 -0
- data/sorbet/rbi/gems/actionmailer@7.0.3.1.rbi +2362 -0
- data/sorbet/rbi/gems/actionpack@7.0.3.1.rbi +19397 -0
- data/sorbet/rbi/gems/actiontext@7.0.3.1.rbi +1569 -0
- data/sorbet/rbi/gems/actionview@7.0.3.1.rbi +14907 -0
- data/sorbet/rbi/gems/activejob@7.0.3.1.rbi +2553 -0
- data/sorbet/rbi/gems/activemodel@7.0.3.1.rbi +5999 -0
- data/sorbet/rbi/gems/activerecord@7.0.3.1.rbi +37832 -0
- data/sorbet/rbi/gems/activestorage@7.0.3.1.rbi +2321 -0
- data/sorbet/rbi/gems/activesupport@7.0.3.1.rbi +18818 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi +11722 -0
- data/sorbet/rbi/gems/constant_resolver@0.2.0.rbi +90 -0
- data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +1079 -0
- data/sorbet/rbi/gems/digest@3.1.0.rbi +189 -0
- data/sorbet/rbi/gems/erubi@1.11.0.rbi +140 -0
- data/sorbet/rbi/gems/globalid@1.0.0.rbi +572 -0
- data/sorbet/rbi/gems/i18n@1.12.0.rbi +2296 -0
- data/sorbet/rbi/gems/json@2.6.2.rbi +1548 -0
- data/sorbet/rbi/gems/language_server-protocol@3.16.0.3.rbi +8 -0
- data/sorbet/rbi/gems/loofah@2.18.0.rbi +877 -0
- data/sorbet/rbi/gems/m@1.6.0.rbi +257 -0
- data/sorbet/rbi/gems/marcel@1.0.2.rbi +220 -0
- data/sorbet/rbi/gems/mini_mime@1.1.2.rbi +170 -0
- data/sorbet/rbi/gems/mini_portile2@2.8.0.rbi +8 -0
- data/sorbet/rbi/gems/minitest-focus@1.3.1.rbi +104 -0
- data/sorbet/rbi/gems/minitest@5.16.2.rbi +2136 -0
- data/sorbet/rbi/gems/mocha@1.14.0.rbi +4177 -0
- data/sorbet/rbi/gems/net-imap@0.2.3.rbi +2147 -0
- data/sorbet/rbi/gems/net-pop@0.1.1.rbi +926 -0
- data/sorbet/rbi/gems/net-protocol@0.1.3.rbi +11 -0
- data/sorbet/rbi/gems/net-smtp@0.3.1.rbi +1108 -0
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +153 -0
- data/sorbet/rbi/gems/nio4r@2.5.8.rbi +292 -0
- data/sorbet/rbi/gems/nokogiri@1.13.8.rbi +6478 -0
- data/sorbet/rbi/gems/parallel@1.22.1.rbi +277 -0
- data/sorbet/rbi/gems/parser@3.1.2.1.rbi +9029 -0
- data/sorbet/rbi/gems/prettier_print@0.1.0.rbi +8 -0
- data/sorbet/rbi/gems/pry@0.14.1.rbi +8 -0
- data/sorbet/rbi/gems/racc@1.6.0.rbi +152 -0
- data/sorbet/rbi/gems/rack-test@2.0.2.rbi +953 -0
- data/sorbet/rbi/gems/rack@2.2.4.rbi +5636 -0
- data/sorbet/rbi/gems/rails-html-sanitizer@1.4.3.rbi +688 -0
- data/sorbet/rbi/gems/rails@7.0.3.1.rbi +8 -0
- data/sorbet/rbi/gems/railties@7.0.3.1.rbi +3507 -0
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +392 -0
- data/sorbet/rbi/gems/rake@13.0.6.rbi +2924 -0
- data/sorbet/rbi/gems/rbi@0.0.15.rbi +3007 -0
- data/sorbet/rbi/gems/regexp_parser@2.5.0.rbi +3383 -0
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +4714 -0
- data/sorbet/rbi/gems/rubocop-ast@1.21.0.rbi +6961 -0
- data/sorbet/rbi/gems/rubocop-performance@1.14.3.rbi +2986 -0
- data/sorbet/rbi/gems/{rubocop-shopify@2.0.1.rbi → rubocop-shopify@2.9.0.rbi} +4 -4
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +992 -0
- data/sorbet/rbi/gems/rubocop@1.34.1.rbi +51820 -0
- data/sorbet/rbi/gems/ruby-lsp@0.2.1.rbi +11 -0
- data/sorbet/rbi/gems/smart_properties@1.17.0.rbi +474 -0
- data/sorbet/rbi/gems/spoom@1.1.11.rbi +2181 -0
- data/sorbet/rbi/gems/spring@4.0.0.rbi +411 -0
- data/sorbet/rbi/gems/strscan@3.0.4.rbi +8 -0
- data/sorbet/rbi/gems/syntax_tree@3.3.0.rbi +8 -0
- data/sorbet/rbi/gems/tapioca@0.9.2.rbi +3181 -0
- data/sorbet/rbi/gems/thor@1.2.1.rbi +3956 -0
- data/sorbet/rbi/gems/timeout@0.3.0.rbi +142 -0
- data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +5896 -0
- data/sorbet/rbi/gems/unicode-display_width@2.2.0.rbi +48 -0
- data/sorbet/rbi/gems/unparser@0.6.5.rbi +4529 -0
- data/sorbet/rbi/gems/webrick@1.7.0.rbi +2582 -0
- data/sorbet/rbi/gems/websocket-driver@0.7.5.rbi +993 -0
- data/sorbet/rbi/gems/yard-sorbet@0.6.1.rbi +388 -0
- data/sorbet/rbi/gems/yard@0.9.28.rbi +18242 -0
- data/sorbet/rbi/gems/zeitwerk@2.6.0.rbi +867 -0
- data/sorbet/rbi/shims/psych.rbi +5 -0
- data/sorbet/tapioca/require.rb +2 -3
- metadata +88 -157
- data/.github/probots.yml +0 -2
- data/library.yml +0 -6
- data/service.yml +0 -1
- data/sorbet/rbi/gems/actioncable@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -860
- data/sorbet/rbi/gems/actionmailbox@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -568
- data/sorbet/rbi/gems/actionmailer@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -587
- data/sorbet/rbi/gems/actionpack@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -5314
- data/sorbet/rbi/gems/actiontext@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -699
- data/sorbet/rbi/gems/actionview@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -2515
- data/sorbet/rbi/gems/activejob@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -624
- data/sorbet/rbi/gems/activemodel@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -1248
- data/sorbet/rbi/gems/activerecord@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -8363
- data/sorbet/rbi/gems/activestorage@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -876
- data/sorbet/rbi/gems/activesupport@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -3987
- data/sorbet/rbi/gems/colorize@0.8.1.rbi +0 -40
- data/sorbet/rbi/gems/commander@4.5.2.rbi +0 -8
- data/sorbet/rbi/gems/concurrent-ruby@1.1.8.rbi +0 -1969
- data/sorbet/rbi/gems/constant_resolver@0.1.5.rbi +0 -26
- data/sorbet/rbi/gems/erubi@1.10.0.rbi +0 -41
- data/sorbet/rbi/gems/globalid@0.4.2.rbi +0 -178
- data/sorbet/rbi/gems/highline@2.0.3.rbi +0 -8
- data/sorbet/rbi/gems/i18n@1.8.10.rbi +0 -600
- data/sorbet/rbi/gems/loofah@2.9.0.rbi +0 -274
- data/sorbet/rbi/gems/m@1.5.1.rbi +0 -108
- data/sorbet/rbi/gems/marcel@1.0.0.rbi +0 -70
- data/sorbet/rbi/gems/mini_mime@1.0.3.rbi +0 -71
- data/sorbet/rbi/gems/minitest-focus@1.2.1.rbi +0 -8
- data/sorbet/rbi/gems/minitest@5.14.4.rbi +0 -544
- data/sorbet/rbi/gems/mocha@1.12.0.rbi +0 -953
- data/sorbet/rbi/gems/nio4r@2.5.7.rbi +0 -90
- data/sorbet/rbi/gems/nokogiri@1.11.2.rbi +0 -1647
- data/sorbet/rbi/gems/parallel@1.20.1.rbi +0 -117
- data/sorbet/rbi/gems/parlour@6.0.0.rbi +0 -1272
- data/sorbet/rbi/gems/parser@3.0.0.0.rbi +0 -1745
- data/sorbet/rbi/gems/pry@0.14.0.rbi +0 -8
- data/sorbet/rbi/gems/psych@3.3.2.rbi +0 -24
- data/sorbet/rbi/gems/racc@1.5.2.rbi +0 -57
- data/sorbet/rbi/gems/rack-test@1.1.0.rbi +0 -335
- data/sorbet/rbi/gems/rack@2.2.3.rbi +0 -1718
- data/sorbet/rbi/gems/rails-html-sanitizer@1.3.0.rbi +0 -213
- data/sorbet/rbi/gems/rails@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -8
- data/sorbet/rbi/gems/railties@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi +0 -880
- data/sorbet/rbi/gems/rainbow@3.0.0.rbi +0 -155
- data/sorbet/rbi/gems/rake@13.0.3.rbi +0 -837
- data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +0 -8
- data/sorbet/rbi/gems/rexml@3.2.4.rbi +0 -8
- data/sorbet/rbi/gems/rubocop-ast@1.4.1.rbi +0 -8
- data/sorbet/rbi/gems/rubocop-performance@1.10.2.rbi +0 -8
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.1.rbi +0 -8
- data/sorbet/rbi/gems/rubocop@1.12.0.rbi +0 -8
- data/sorbet/rbi/gems/smart_properties@1.15.0.rbi +0 -168
- data/sorbet/rbi/gems/spoom@1.1.0.rbi +0 -1061
- data/sorbet/rbi/gems/spring@2.1.1.rbi +0 -160
- data/sorbet/rbi/gems/sprockets-rails@3.2.2.rbi +0 -451
- data/sorbet/rbi/gems/sprockets@4.0.2.rbi +0 -1133
- data/sorbet/rbi/gems/tapioca@0.4.19.rbi +0 -603
- data/sorbet/rbi/gems/thor@1.1.0.rbi +0 -893
- data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +0 -566
- data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +0 -8
- data/sorbet/rbi/gems/websocket-driver@0.7.3.rbi +0 -438
- data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +0 -177
@@ -0,0 +1,926 @@
|
|
1
|
+
# typed: true
|
2
|
+
|
3
|
+
# DO NOT EDIT MANUALLY
|
4
|
+
# This is an autogenerated file for types exported from the `net-pop` gem.
|
5
|
+
# Please instead update this file by running `bin/tapioca gem net-pop`.
|
6
|
+
|
7
|
+
# This class is equivalent to POP3, except that it uses APOP authentication.
|
8
|
+
#
|
9
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:727
|
10
|
+
class Net::APOP < ::Net::POP3
|
11
|
+
# Always returns true.
|
12
|
+
#
|
13
|
+
# @return [Boolean]
|
14
|
+
#
|
15
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:728
|
16
|
+
def apop?; end
|
17
|
+
end
|
18
|
+
|
19
|
+
# class aliases
|
20
|
+
#
|
21
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:734
|
22
|
+
Net::APOPSession = Net::APOP
|
23
|
+
|
24
|
+
# class aliases
|
25
|
+
#
|
26
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:719
|
27
|
+
Net::POP = Net::POP3
|
28
|
+
|
29
|
+
# == What is This Library?
|
30
|
+
#
|
31
|
+
# This library provides functionality for retrieving
|
32
|
+
# email via POP3, the Post Office Protocol version 3. For details
|
33
|
+
# of POP3, see [RFC1939] (http://www.ietf.org/rfc/rfc1939.txt).
|
34
|
+
#
|
35
|
+
# == Examples
|
36
|
+
#
|
37
|
+
# === Retrieving Messages
|
38
|
+
#
|
39
|
+
# This example retrieves messages from the server and deletes them
|
40
|
+
# on the server.
|
41
|
+
#
|
42
|
+
# Messages are written to files named 'inbox/1', 'inbox/2', ....
|
43
|
+
# Replace 'pop.example.com' with your POP3 server address, and
|
44
|
+
# 'YourAccount' and 'YourPassword' with the appropriate account
|
45
|
+
# details.
|
46
|
+
#
|
47
|
+
# require 'net/pop'
|
48
|
+
#
|
49
|
+
# pop = Net::POP3.new('pop.example.com')
|
50
|
+
# pop.start('YourAccount', 'YourPassword') # (1)
|
51
|
+
# if pop.mails.empty?
|
52
|
+
# puts 'No mail.'
|
53
|
+
# else
|
54
|
+
# i = 0
|
55
|
+
# pop.each_mail do |m| # or "pop.mails.each ..." # (2)
|
56
|
+
# File.open("inbox/#{i}", 'w') do |f|
|
57
|
+
# f.write m.pop
|
58
|
+
# end
|
59
|
+
# m.delete
|
60
|
+
# i += 1
|
61
|
+
# end
|
62
|
+
# puts "#{pop.mails.size} mails popped."
|
63
|
+
# end
|
64
|
+
# pop.finish # (3)
|
65
|
+
#
|
66
|
+
# 1. Call Net::POP3#start and start POP session.
|
67
|
+
# 2. Access messages by using POP3#each_mail and/or POP3#mails.
|
68
|
+
# 3. Close POP session by calling POP3#finish or use the block form of #start.
|
69
|
+
#
|
70
|
+
# === Shortened Code
|
71
|
+
#
|
72
|
+
# The example above is very verbose. You can shorten the code by using
|
73
|
+
# some utility methods. First, the block form of Net::POP3.start can
|
74
|
+
# be used instead of POP3.new, POP3#start and POP3#finish.
|
75
|
+
#
|
76
|
+
# require 'net/pop'
|
77
|
+
#
|
78
|
+
# Net::POP3.start('pop.example.com', 110,
|
79
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
80
|
+
# if pop.mails.empty?
|
81
|
+
# puts 'No mail.'
|
82
|
+
# else
|
83
|
+
# i = 0
|
84
|
+
# pop.each_mail do |m| # or "pop.mails.each ..."
|
85
|
+
# File.open("inbox/#{i}", 'w') do |f|
|
86
|
+
# f.write m.pop
|
87
|
+
# end
|
88
|
+
# m.delete
|
89
|
+
# i += 1
|
90
|
+
# end
|
91
|
+
# puts "#{pop.mails.size} mails popped."
|
92
|
+
# end
|
93
|
+
# end
|
94
|
+
#
|
95
|
+
# POP3#delete_all is an alternative for #each_mail and #delete.
|
96
|
+
#
|
97
|
+
# require 'net/pop'
|
98
|
+
#
|
99
|
+
# Net::POP3.start('pop.example.com', 110,
|
100
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
101
|
+
# if pop.mails.empty?
|
102
|
+
# puts 'No mail.'
|
103
|
+
# else
|
104
|
+
# i = 1
|
105
|
+
# pop.delete_all do |m|
|
106
|
+
# File.open("inbox/#{i}", 'w') do |f|
|
107
|
+
# f.write m.pop
|
108
|
+
# end
|
109
|
+
# i += 1
|
110
|
+
# end
|
111
|
+
# end
|
112
|
+
# end
|
113
|
+
#
|
114
|
+
# And here is an even shorter example.
|
115
|
+
#
|
116
|
+
# require 'net/pop'
|
117
|
+
#
|
118
|
+
# i = 0
|
119
|
+
# Net::POP3.delete_all('pop.example.com', 110,
|
120
|
+
# 'YourAccount', 'YourPassword') do |m|
|
121
|
+
# File.open("inbox/#{i}", 'w') do |f|
|
122
|
+
# f.write m.pop
|
123
|
+
# end
|
124
|
+
# i += 1
|
125
|
+
# end
|
126
|
+
#
|
127
|
+
# === Memory Space Issues
|
128
|
+
#
|
129
|
+
# All the examples above get each message as one big string.
|
130
|
+
# This example avoids this.
|
131
|
+
#
|
132
|
+
# require 'net/pop'
|
133
|
+
#
|
134
|
+
# i = 1
|
135
|
+
# Net::POP3.delete_all('pop.example.com', 110,
|
136
|
+
# 'YourAccount', 'YourPassword') do |m|
|
137
|
+
# File.open("inbox/#{i}", 'w') do |f|
|
138
|
+
# m.pop do |chunk| # get a message little by little.
|
139
|
+
# f.write chunk
|
140
|
+
# end
|
141
|
+
# i += 1
|
142
|
+
# end
|
143
|
+
# end
|
144
|
+
#
|
145
|
+
# === Using APOP
|
146
|
+
#
|
147
|
+
# The net/pop library supports APOP authentication.
|
148
|
+
# To use APOP, use the Net::APOP class instead of the Net::POP3 class.
|
149
|
+
# You can use the utility method, Net::POP3.APOP(). For example:
|
150
|
+
#
|
151
|
+
# require 'net/pop'
|
152
|
+
#
|
153
|
+
# # Use APOP authentication if $isapop == true
|
154
|
+
# pop = Net::POP3.APOP($isapop).new('apop.example.com', 110)
|
155
|
+
# pop.start('YourAccount', 'YourPassword') do |pop|
|
156
|
+
# # Rest of the code is the same.
|
157
|
+
# end
|
158
|
+
#
|
159
|
+
# === Fetch Only Selected Mail Using 'UIDL' POP Command
|
160
|
+
#
|
161
|
+
# If your POP server provides UIDL functionality,
|
162
|
+
# you can grab only selected mails from the POP server.
|
163
|
+
# e.g.
|
164
|
+
#
|
165
|
+
# def need_pop?( id )
|
166
|
+
# # determine if we need pop this mail...
|
167
|
+
# end
|
168
|
+
#
|
169
|
+
# Net::POP3.start('pop.example.com', 110,
|
170
|
+
# 'Your account', 'Your password') do |pop|
|
171
|
+
# pop.mails.select { |m| need_pop?(m.unique_id) }.each do |m|
|
172
|
+
# do_something(m.pop)
|
173
|
+
# end
|
174
|
+
# end
|
175
|
+
#
|
176
|
+
# The POPMail#unique_id() method returns the unique-id of the message as a
|
177
|
+
# String. Normally the unique-id is a hash of the message.
|
178
|
+
#
|
179
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:197
|
180
|
+
class Net::POP3 < ::Net::Protocol
|
181
|
+
# Creates a new POP3 object.
|
182
|
+
#
|
183
|
+
# +address+ is the hostname or ip address of your POP3 server.
|
184
|
+
#
|
185
|
+
# The optional +port+ is the port to connect to.
|
186
|
+
#
|
187
|
+
# The optional +isapop+ specifies whether this connection is going
|
188
|
+
# to use APOP authentication; it defaults to +false+.
|
189
|
+
#
|
190
|
+
# This method does *not* open the TCP connection.
|
191
|
+
#
|
192
|
+
# @return [POP3] a new instance of POP3
|
193
|
+
#
|
194
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:417
|
195
|
+
def initialize(addr, port = T.unsafe(nil), isapop = T.unsafe(nil)); end
|
196
|
+
|
197
|
+
# +true+ if the POP3 session has started.
|
198
|
+
#
|
199
|
+
# @return [Boolean]
|
200
|
+
#
|
201
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:514
|
202
|
+
def active?; end
|
203
|
+
|
204
|
+
# The address to connect to.
|
205
|
+
#
|
206
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:490
|
207
|
+
def address; end
|
208
|
+
|
209
|
+
# Does this instance use APOP authentication?
|
210
|
+
#
|
211
|
+
# @return [Boolean]
|
212
|
+
#
|
213
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:436
|
214
|
+
def apop?; end
|
215
|
+
|
216
|
+
# Starts a pop3 session, attempts authentication, and quits.
|
217
|
+
# This method must not be called while POP3 session is opened.
|
218
|
+
# This method raises POPAuthenticationError if authentication fails.
|
219
|
+
#
|
220
|
+
# @raise [IOError]
|
221
|
+
#
|
222
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:314
|
223
|
+
def auth_only(account, password); end
|
224
|
+
|
225
|
+
# Deletes all messages on the server.
|
226
|
+
#
|
227
|
+
# If called with a block, yields each message in turn before deleting it.
|
228
|
+
#
|
229
|
+
# === Example
|
230
|
+
#
|
231
|
+
# n = 1
|
232
|
+
# pop.delete_all do |m|
|
233
|
+
# File.open("inbox/#{n}") do |f|
|
234
|
+
# f.write m.pop
|
235
|
+
# end
|
236
|
+
# n += 1
|
237
|
+
# end
|
238
|
+
#
|
239
|
+
# This method raises a POPError if an error occurs.
|
240
|
+
#
|
241
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:687
|
242
|
+
def delete_all; end
|
243
|
+
|
244
|
+
# Disable SSL for all new instances.
|
245
|
+
#
|
246
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:463
|
247
|
+
def disable_ssl; end
|
248
|
+
|
249
|
+
# Yields each message to the passed-in block in turn.
|
250
|
+
# Equivalent to:
|
251
|
+
#
|
252
|
+
# pop3.mails.each do |popmail|
|
253
|
+
# ....
|
254
|
+
# end
|
255
|
+
#
|
256
|
+
# This method raises a POPError if an error occurs.
|
257
|
+
#
|
258
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:665
|
259
|
+
def each(&block); end
|
260
|
+
|
261
|
+
# Yields each message to the passed-in block in turn.
|
262
|
+
# Equivalent to:
|
263
|
+
#
|
264
|
+
# pop3.mails.each do |popmail|
|
265
|
+
# ....
|
266
|
+
# end
|
267
|
+
#
|
268
|
+
# This method raises a POPError if an error occurs.
|
269
|
+
#
|
270
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:665
|
271
|
+
def each_mail(&block); end
|
272
|
+
|
273
|
+
# :call-seq:
|
274
|
+
# Net::POP#enable_ssl(params = {})
|
275
|
+
#
|
276
|
+
# Enables SSL for this instance. Must be called before the connection is
|
277
|
+
# established to have any effect.
|
278
|
+
# +params[:port]+ is port to establish the SSL connection on; Defaults to 995.
|
279
|
+
# +params+ (except :port) is passed to OpenSSL::SSLContext#set_params.
|
280
|
+
#
|
281
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:452
|
282
|
+
def enable_ssl(verify_or_params = T.unsafe(nil), certs = T.unsafe(nil), port = T.unsafe(nil)); end
|
283
|
+
|
284
|
+
# Finishes a POP3 session and closes TCP connection.
|
285
|
+
#
|
286
|
+
# @raise [IOError]
|
287
|
+
#
|
288
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:586
|
289
|
+
def finish; end
|
290
|
+
|
291
|
+
# Provide human-readable stringification of class state.
|
292
|
+
#
|
293
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:468
|
294
|
+
def inspect; end
|
295
|
+
|
296
|
+
# debugging output for +msg+
|
297
|
+
#
|
298
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:712
|
299
|
+
def logging(msg); end
|
300
|
+
|
301
|
+
# Returns an array of Net::POPMail objects, representing all the
|
302
|
+
# messages on the server. This array is renewed when the session
|
303
|
+
# restarts; otherwise, it is fetched from the server the first time
|
304
|
+
# this method is called (directly or indirectly) and cached.
|
305
|
+
#
|
306
|
+
# This method raises a POPError if an error occurs.
|
307
|
+
#
|
308
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:643
|
309
|
+
def mails; end
|
310
|
+
|
311
|
+
# Returns the total size in bytes of all the messages on the POP server.
|
312
|
+
#
|
313
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:631
|
314
|
+
def n_bytes; end
|
315
|
+
|
316
|
+
# Returns the number of messages on the POP server.
|
317
|
+
#
|
318
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:624
|
319
|
+
def n_mails; end
|
320
|
+
|
321
|
+
# Seconds to wait until a connection is opened.
|
322
|
+
# If the POP3 object cannot open a connection within this time,
|
323
|
+
# it raises a Net::OpenTimeout exception. The default value is 30 seconds.
|
324
|
+
#
|
325
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:500
|
326
|
+
def open_timeout; end
|
327
|
+
|
328
|
+
# Seconds to wait until a connection is opened.
|
329
|
+
# If the POP3 object cannot open a connection within this time,
|
330
|
+
# it raises a Net::OpenTimeout exception. The default value is 30 seconds.
|
331
|
+
#
|
332
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:500
|
333
|
+
def open_timeout=(_arg0); end
|
334
|
+
|
335
|
+
# The port number to connect to.
|
336
|
+
#
|
337
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:493
|
338
|
+
def port; end
|
339
|
+
|
340
|
+
# Seconds to wait until reading one block (by one read(1) call).
|
341
|
+
# If the POP3 object cannot complete a read() within this time,
|
342
|
+
# it raises a Net::ReadTimeout exception. The default value is 60 seconds.
|
343
|
+
#
|
344
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:505
|
345
|
+
def read_timeout; end
|
346
|
+
|
347
|
+
# Set the read timeout.
|
348
|
+
#
|
349
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:508
|
350
|
+
def read_timeout=(sec); end
|
351
|
+
|
352
|
+
# Resets the session. This clears all "deleted" marks from messages.
|
353
|
+
#
|
354
|
+
# This method raises a POPError if an error occurs.
|
355
|
+
#
|
356
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:697
|
357
|
+
def reset; end
|
358
|
+
|
359
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:706
|
360
|
+
def set_all_uids; end
|
361
|
+
|
362
|
+
# *WARNING*: This method causes a serious security hole.
|
363
|
+
# Use this method only for debugging.
|
364
|
+
#
|
365
|
+
# Set an output stream for debugging.
|
366
|
+
#
|
367
|
+
# === Example
|
368
|
+
#
|
369
|
+
# pop = Net::POP.new(addr, port)
|
370
|
+
# pop.set_debug_output $stderr
|
371
|
+
# pop.start(account, passwd) do |pop|
|
372
|
+
# ....
|
373
|
+
# end
|
374
|
+
#
|
375
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:485
|
376
|
+
def set_debug_output(arg); end
|
377
|
+
|
378
|
+
# Starts a POP3 session.
|
379
|
+
#
|
380
|
+
# When called with block, gives a POP3 object to the block and
|
381
|
+
# closes the session after block call finishes.
|
382
|
+
#
|
383
|
+
# This method raises a POPAuthenticationError if authentication fails.
|
384
|
+
#
|
385
|
+
# @raise [IOError]
|
386
|
+
#
|
387
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:526
|
388
|
+
def start(account, password); end
|
389
|
+
|
390
|
+
# +true+ if the POP3 session has started.
|
391
|
+
#
|
392
|
+
# @return [Boolean]
|
393
|
+
#
|
394
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:514
|
395
|
+
def started?; end
|
396
|
+
|
397
|
+
# does this instance use SSL?
|
398
|
+
#
|
399
|
+
# @return [Boolean]
|
400
|
+
#
|
401
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:441
|
402
|
+
def use_ssl?; end
|
403
|
+
|
404
|
+
private
|
405
|
+
|
406
|
+
# Returns the current command.
|
407
|
+
#
|
408
|
+
# Raises IOError if there is no active socket
|
409
|
+
#
|
410
|
+
# @raise [IOError]
|
411
|
+
#
|
412
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:612
|
413
|
+
def command; end
|
414
|
+
|
415
|
+
# nil's out the:
|
416
|
+
# - mails
|
417
|
+
# - number counter for mails
|
418
|
+
# - number counter for bytes
|
419
|
+
# - quits the current command, if any
|
420
|
+
#
|
421
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:596
|
422
|
+
def do_finish; end
|
423
|
+
|
424
|
+
# internal method for Net::POP3.start
|
425
|
+
#
|
426
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:542
|
427
|
+
def do_start(account, password); end
|
428
|
+
|
429
|
+
# Does nothing
|
430
|
+
#
|
431
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:581
|
432
|
+
def on_connect; end
|
433
|
+
|
434
|
+
class << self
|
435
|
+
# Returns the APOP class if +isapop+ is true; otherwise, returns
|
436
|
+
# the POP class. For example:
|
437
|
+
#
|
438
|
+
# # Example 1
|
439
|
+
# pop = Net::POP3::APOP($is_apop).new(addr, port)
|
440
|
+
#
|
441
|
+
# # Example 2
|
442
|
+
# Net::POP3::APOP($is_apop).start(addr, port) do |pop|
|
443
|
+
# ....
|
444
|
+
# end
|
445
|
+
#
|
446
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:238
|
447
|
+
def APOP(isapop); end
|
448
|
+
|
449
|
+
# Opens a POP3 session, attempts authentication, and quits.
|
450
|
+
#
|
451
|
+
# This method raises POPAuthenticationError if authentication fails.
|
452
|
+
#
|
453
|
+
# === Example: normal POP3
|
454
|
+
#
|
455
|
+
# Net::POP3.auth_only('pop.example.com', 110,
|
456
|
+
# 'YourAccount', 'YourPassword')
|
457
|
+
#
|
458
|
+
# === Example: APOP
|
459
|
+
#
|
460
|
+
# Net::POP3.auth_only('pop.example.com', 110,
|
461
|
+
# 'YourAccount', 'YourPassword', true)
|
462
|
+
#
|
463
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:305
|
464
|
+
def auth_only(address, port = T.unsafe(nil), account = T.unsafe(nil), password = T.unsafe(nil), isapop = T.unsafe(nil)); end
|
465
|
+
|
466
|
+
# returns the :ca_file or :ca_path from POP3.ssl_params
|
467
|
+
#
|
468
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:377
|
469
|
+
def certs; end
|
470
|
+
|
471
|
+
# Constructs proper parameters from arguments
|
472
|
+
#
|
473
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:337
|
474
|
+
def create_ssl_params(verify_or_params = T.unsafe(nil), certs = T.unsafe(nil)); end
|
475
|
+
|
476
|
+
# The default port for POP3 connections, port 110
|
477
|
+
#
|
478
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:210
|
479
|
+
def default_pop3_port; end
|
480
|
+
|
481
|
+
# The default port for POP3S connections, port 995
|
482
|
+
#
|
483
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:215
|
484
|
+
def default_pop3s_port; end
|
485
|
+
|
486
|
+
# returns the port for POP3
|
487
|
+
#
|
488
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:205
|
489
|
+
def default_port; end
|
490
|
+
|
491
|
+
# Starts a POP3 session and deletes all messages on the server.
|
492
|
+
# If a block is given, each POPMail object is yielded to it before
|
493
|
+
# being deleted.
|
494
|
+
#
|
495
|
+
# This method raises a POPAuthenticationError if authentication fails.
|
496
|
+
#
|
497
|
+
# === Example
|
498
|
+
#
|
499
|
+
# Net::POP3.delete_all('pop.example.com', 110,
|
500
|
+
# 'YourAccount', 'YourPassword') do |m|
|
501
|
+
# file.write m.pop
|
502
|
+
# end
|
503
|
+
#
|
504
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:283
|
505
|
+
def delete_all(address, port = T.unsafe(nil), account = T.unsafe(nil), password = T.unsafe(nil), isapop = T.unsafe(nil), &block); end
|
506
|
+
|
507
|
+
# Disable SSL for all new instances.
|
508
|
+
#
|
509
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:355
|
510
|
+
def disable_ssl; end
|
511
|
+
|
512
|
+
# :call-seq:
|
513
|
+
# Net::POP.enable_ssl(params = {})
|
514
|
+
#
|
515
|
+
# Enable SSL for all new instances.
|
516
|
+
# +params+ is passed to OpenSSL::SSLContext#set_params.
|
517
|
+
#
|
518
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:332
|
519
|
+
def enable_ssl(*args); end
|
520
|
+
|
521
|
+
# Starts a POP3 session and iterates over each POPMail object,
|
522
|
+
# yielding it to the +block+.
|
523
|
+
# This method is equivalent to:
|
524
|
+
#
|
525
|
+
# Net::POP3.start(address, port, account, password) do |pop|
|
526
|
+
# pop.each_mail do |m|
|
527
|
+
# yield m
|
528
|
+
# end
|
529
|
+
# end
|
530
|
+
#
|
531
|
+
# This method raises a POPAuthenticationError if authentication fails.
|
532
|
+
#
|
533
|
+
# === Example
|
534
|
+
#
|
535
|
+
# Net::POP3.foreach('pop.example.com', 110,
|
536
|
+
# 'YourAccount', 'YourPassword') do |m|
|
537
|
+
# file.write m.pop
|
538
|
+
# m.delete if $DELETE
|
539
|
+
# end
|
540
|
+
#
|
541
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:262
|
542
|
+
def foreach(address, port = T.unsafe(nil), account = T.unsafe(nil), password = T.unsafe(nil), isapop = T.unsafe(nil), &block); end
|
543
|
+
|
544
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:219
|
545
|
+
def socket_type; end
|
546
|
+
|
547
|
+
# returns the SSL Parameters
|
548
|
+
#
|
549
|
+
# see also POP3.enable_ssl
|
550
|
+
#
|
551
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:362
|
552
|
+
def ssl_params; end
|
553
|
+
|
554
|
+
# Creates a new POP3 object and open the connection. Equivalent to
|
555
|
+
#
|
556
|
+
# Net::POP3.new(address, port, isapop).start(account, password)
|
557
|
+
#
|
558
|
+
# If +block+ is provided, yields the newly-opened POP3 object to it,
|
559
|
+
# and automatically closes it at the end of the session.
|
560
|
+
#
|
561
|
+
# === Example
|
562
|
+
#
|
563
|
+
# Net::POP3.start(addr, port, account, password) do |pop|
|
564
|
+
# pop.each_mail do |m|
|
565
|
+
# file.write m.pop
|
566
|
+
# m.delete
|
567
|
+
# end
|
568
|
+
# end
|
569
|
+
#
|
570
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:401
|
571
|
+
def start(address, port = T.unsafe(nil), account = T.unsafe(nil), password = T.unsafe(nil), isapop = T.unsafe(nil), &block); end
|
572
|
+
|
573
|
+
# returns +true+ if POP3.ssl_params is set
|
574
|
+
#
|
575
|
+
# @return [Boolean]
|
576
|
+
#
|
577
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:367
|
578
|
+
def use_ssl?; end
|
579
|
+
|
580
|
+
# returns whether verify_mode is enable from POP3.ssl_params
|
581
|
+
#
|
582
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:372
|
583
|
+
def verify; end
|
584
|
+
end
|
585
|
+
end
|
586
|
+
|
587
|
+
# version of this library
|
588
|
+
#
|
589
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:198
|
590
|
+
Net::POP3::VERSION = T.let(T.unsafe(nil), String)
|
591
|
+
|
592
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:889
|
593
|
+
class Net::POP3Command
|
594
|
+
# @return [POP3Command] a new instance of POP3Command
|
595
|
+
#
|
596
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:891
|
597
|
+
def initialize(sock); end
|
598
|
+
|
599
|
+
# @raise [POPAuthenticationError]
|
600
|
+
#
|
601
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:911
|
602
|
+
def apop(account, password); end
|
603
|
+
|
604
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:904
|
605
|
+
def auth(account, password); end
|
606
|
+
|
607
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:959
|
608
|
+
def dele(num); end
|
609
|
+
|
610
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:900
|
611
|
+
def inspect; end
|
612
|
+
|
613
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:921
|
614
|
+
def list; end
|
615
|
+
|
616
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:980
|
617
|
+
def quit; end
|
618
|
+
|
619
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:952
|
620
|
+
def retr(num, &block); end
|
621
|
+
|
622
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:941
|
623
|
+
def rset; end
|
624
|
+
|
625
|
+
# Returns the value of attribute socket.
|
626
|
+
#
|
627
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:898
|
628
|
+
def socket; end
|
629
|
+
|
630
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:934
|
631
|
+
def stat; end
|
632
|
+
|
633
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:945
|
634
|
+
def top(num, lines = T.unsafe(nil), &block); end
|
635
|
+
|
636
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:963
|
637
|
+
def uidl(num = T.unsafe(nil)); end
|
638
|
+
|
639
|
+
private
|
640
|
+
|
641
|
+
# @raise [POPError]
|
642
|
+
#
|
643
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:1000
|
644
|
+
def check_response(res); end
|
645
|
+
|
646
|
+
# @raise [POPAuthenticationError]
|
647
|
+
#
|
648
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:1005
|
649
|
+
def check_response_auth(res); end
|
650
|
+
|
651
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:1010
|
652
|
+
def critical; end
|
653
|
+
|
654
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:991
|
655
|
+
def get_response(fmt, *fargs); end
|
656
|
+
|
657
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:986
|
658
|
+
def getok(fmt, *fargs); end
|
659
|
+
|
660
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:996
|
661
|
+
def recv_response; end
|
662
|
+
end
|
663
|
+
|
664
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:721
|
665
|
+
Net::POP3Session = Net::POP3
|
666
|
+
|
667
|
+
# POP3 authentication error.
|
668
|
+
#
|
669
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:40
|
670
|
+
class Net::POPAuthenticationError < ::Net::ProtoAuthError; end
|
671
|
+
|
672
|
+
# Unexpected response from the server.
|
673
|
+
#
|
674
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:43
|
675
|
+
class Net::POPBadResponse < ::Net::POPError; end
|
676
|
+
|
677
|
+
# Non-authentication POP3 protocol error
|
678
|
+
# (reply code "-ERR", except authentication).
|
679
|
+
#
|
680
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:37
|
681
|
+
class Net::POPError < ::Net::ProtocolError; end
|
682
|
+
|
683
|
+
# This class represents a message which exists on the POP server.
|
684
|
+
# Instances of this class are created by the POP3 class; they should
|
685
|
+
# not be directly created by the user.
|
686
|
+
#
|
687
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:741
|
688
|
+
class Net::POPMail
|
689
|
+
# @return [POPMail] a new instance of POPMail
|
690
|
+
#
|
691
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:743
|
692
|
+
def initialize(num, len, pop, cmd); end
|
693
|
+
|
694
|
+
# This method fetches the message. If called with a block, the
|
695
|
+
# message is yielded to the block one chunk at a time. If called
|
696
|
+
# without a block, the message is returned as a String. The optional
|
697
|
+
# +dest+ argument will be prepended to the returned String; this
|
698
|
+
# argument is essentially obsolete.
|
699
|
+
#
|
700
|
+
# === Example without block
|
701
|
+
#
|
702
|
+
# POP3.start('pop.example.com', 110,
|
703
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
704
|
+
# n = 1
|
705
|
+
# pop.mails.each do |popmail|
|
706
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
707
|
+
# f.write popmail.pop
|
708
|
+
# end
|
709
|
+
# popmail.delete
|
710
|
+
# n += 1
|
711
|
+
# end
|
712
|
+
# end
|
713
|
+
#
|
714
|
+
# === Example with block
|
715
|
+
#
|
716
|
+
# POP3.start('pop.example.com', 110,
|
717
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
718
|
+
# n = 1
|
719
|
+
# pop.mails.each do |popmail|
|
720
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
721
|
+
# popmail.pop do |chunk| ####
|
722
|
+
# f.write chunk
|
723
|
+
# end
|
724
|
+
# end
|
725
|
+
# n += 1
|
726
|
+
# end
|
727
|
+
# end
|
728
|
+
#
|
729
|
+
# This method raises a POPError if an error occurs.
|
730
|
+
#
|
731
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:802
|
732
|
+
def all(dest = T.unsafe(nil), &block); end
|
733
|
+
|
734
|
+
# Marks a message for deletion on the server. Deletion does not
|
735
|
+
# actually occur until the end of the session; deletion may be
|
736
|
+
# cancelled for _all_ marked messages by calling POP3#reset().
|
737
|
+
#
|
738
|
+
# This method raises a POPError if an error occurs.
|
739
|
+
#
|
740
|
+
# === Example
|
741
|
+
#
|
742
|
+
# POP3.start('pop.example.com', 110,
|
743
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
744
|
+
# n = 1
|
745
|
+
# pop.mails.each do |popmail|
|
746
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
747
|
+
# f.write popmail.pop
|
748
|
+
# end
|
749
|
+
# popmail.delete ####
|
750
|
+
# n += 1
|
751
|
+
# end
|
752
|
+
# end
|
753
|
+
#
|
754
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:858
|
755
|
+
def delete; end
|
756
|
+
|
757
|
+
# Marks a message for deletion on the server. Deletion does not
|
758
|
+
# actually occur until the end of the session; deletion may be
|
759
|
+
# cancelled for _all_ marked messages by calling POP3#reset().
|
760
|
+
#
|
761
|
+
# This method raises a POPError if an error occurs.
|
762
|
+
#
|
763
|
+
# === Example
|
764
|
+
#
|
765
|
+
# POP3.start('pop.example.com', 110,
|
766
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
767
|
+
# n = 1
|
768
|
+
# pop.mails.each do |popmail|
|
769
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
770
|
+
# f.write popmail.pop
|
771
|
+
# end
|
772
|
+
# popmail.delete ####
|
773
|
+
# n += 1
|
774
|
+
# end
|
775
|
+
# end
|
776
|
+
#
|
777
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:858
|
778
|
+
def delete!; end
|
779
|
+
|
780
|
+
# True if the mail has been deleted.
|
781
|
+
#
|
782
|
+
# @return [Boolean]
|
783
|
+
#
|
784
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:866
|
785
|
+
def deleted?; end
|
786
|
+
|
787
|
+
# Fetches the message header.
|
788
|
+
#
|
789
|
+
# The optional +dest+ argument is obsolete.
|
790
|
+
#
|
791
|
+
# This method raises a POPError if an error occurs.
|
792
|
+
#
|
793
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:834
|
794
|
+
def header(dest = T.unsafe(nil)); end
|
795
|
+
|
796
|
+
# Provide human-readable stringification of class state.
|
797
|
+
#
|
798
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:760
|
799
|
+
def inspect; end
|
800
|
+
|
801
|
+
# The length of the message in octets.
|
802
|
+
#
|
803
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:756
|
804
|
+
def length; end
|
805
|
+
|
806
|
+
# This method fetches the message. If called with a block, the
|
807
|
+
# message is yielded to the block one chunk at a time. If called
|
808
|
+
# without a block, the message is returned as a String. The optional
|
809
|
+
# +dest+ argument will be prepended to the returned String; this
|
810
|
+
# argument is essentially obsolete.
|
811
|
+
#
|
812
|
+
# === Example without block
|
813
|
+
#
|
814
|
+
# POP3.start('pop.example.com', 110,
|
815
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
816
|
+
# n = 1
|
817
|
+
# pop.mails.each do |popmail|
|
818
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
819
|
+
# f.write popmail.pop
|
820
|
+
# end
|
821
|
+
# popmail.delete
|
822
|
+
# n += 1
|
823
|
+
# end
|
824
|
+
# end
|
825
|
+
#
|
826
|
+
# === Example with block
|
827
|
+
#
|
828
|
+
# POP3.start('pop.example.com', 110,
|
829
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
830
|
+
# n = 1
|
831
|
+
# pop.mails.each do |popmail|
|
832
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
833
|
+
# popmail.pop do |chunk| ####
|
834
|
+
# f.write chunk
|
835
|
+
# end
|
836
|
+
# end
|
837
|
+
# n += 1
|
838
|
+
# end
|
839
|
+
# end
|
840
|
+
#
|
841
|
+
# This method raises a POPError if an error occurs.
|
842
|
+
#
|
843
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:802
|
844
|
+
def mail(dest = T.unsafe(nil), &block); end
|
845
|
+
|
846
|
+
# The sequence number of the message on the server.
|
847
|
+
#
|
848
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:753
|
849
|
+
def number; end
|
850
|
+
|
851
|
+
# This method fetches the message. If called with a block, the
|
852
|
+
# message is yielded to the block one chunk at a time. If called
|
853
|
+
# without a block, the message is returned as a String. The optional
|
854
|
+
# +dest+ argument will be prepended to the returned String; this
|
855
|
+
# argument is essentially obsolete.
|
856
|
+
#
|
857
|
+
# === Example without block
|
858
|
+
#
|
859
|
+
# POP3.start('pop.example.com', 110,
|
860
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
861
|
+
# n = 1
|
862
|
+
# pop.mails.each do |popmail|
|
863
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
864
|
+
# f.write popmail.pop
|
865
|
+
# end
|
866
|
+
# popmail.delete
|
867
|
+
# n += 1
|
868
|
+
# end
|
869
|
+
# end
|
870
|
+
#
|
871
|
+
# === Example with block
|
872
|
+
#
|
873
|
+
# POP3.start('pop.example.com', 110,
|
874
|
+
# 'YourAccount', 'YourPassword') do |pop|
|
875
|
+
# n = 1
|
876
|
+
# pop.mails.each do |popmail|
|
877
|
+
# File.open("inbox/#{n}", 'w') do |f|
|
878
|
+
# popmail.pop do |chunk| ####
|
879
|
+
# f.write chunk
|
880
|
+
# end
|
881
|
+
# end
|
882
|
+
# n += 1
|
883
|
+
# end
|
884
|
+
# end
|
885
|
+
#
|
886
|
+
# This method raises a POPError if an error occurs.
|
887
|
+
#
|
888
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:802
|
889
|
+
def pop(dest = T.unsafe(nil), &block); end
|
890
|
+
|
891
|
+
# The length of the message in octets.
|
892
|
+
#
|
893
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:756
|
894
|
+
def size; end
|
895
|
+
|
896
|
+
# Fetches the message header and +lines+ lines of body.
|
897
|
+
#
|
898
|
+
# The optional +dest+ argument is obsolete.
|
899
|
+
#
|
900
|
+
# This method raises a POPError if an error occurs.
|
901
|
+
#
|
902
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:822
|
903
|
+
def top(lines, dest = T.unsafe(nil)); end
|
904
|
+
|
905
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:882
|
906
|
+
def uid=(uid); end
|
907
|
+
|
908
|
+
# Returns the unique-id of the message.
|
909
|
+
# Normally the unique-id is a hash string of the message.
|
910
|
+
#
|
911
|
+
# This method raises a POPError if an error occurs.
|
912
|
+
#
|
913
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:874
|
914
|
+
def uidl; end
|
915
|
+
|
916
|
+
# Returns the unique-id of the message.
|
917
|
+
# Normally the unique-id is a hash string of the message.
|
918
|
+
#
|
919
|
+
# This method raises a POPError if an error occurs.
|
920
|
+
#
|
921
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:874
|
922
|
+
def unique_id; end
|
923
|
+
end
|
924
|
+
|
925
|
+
# source://net-pop-0.1.1/lib/net/pop.rb:720
|
926
|
+
Net::POPSession = Net::POP3
|