summaryrefslogtreecommitdiff
path: root/lib/net/pop.rb
blob: 1a0c61b51cf49b209536c12643854d5d49075263 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
=begin

= net/pop.rb

written by Minero Aoki <aamine@dp.u-netsurf.ne.jp>

This library is distributed under the terms of Ruby license.
You can freely distribute/modify this file.

=end


require 'net/session'
require 'md5'


module Net


=begin

== Net::POP3Session

=== Super Class

Net::Session

=== Class Methods

: new( address = 'localhost', port = 110 )

  This method create a new POP3Session object.
  This will not open connection yet.


=== Methods

: start( account, password )

  This method start POP session.

: each{|popmail| ...}

  This method is equals to "pop3session.mails.each"

: mails

  This method returns an array of ((URL:#POPMail)).
  This array is renewed when login.

=end

  class POP3Session < Session

    session_setvar :port,         '110'
    session_setvar :command_type, 'POP3Command'

        
    attr :mails

    def each
      @mails.each {|m| yield m }
    end


    private


    def proto_initialize
      @mails      = [].freeze
    end

    def do_start( acnt, pwd )
      @proto.auth( acnt, pwd )
      @mails = []
      @proto.list.each_with_index do |size,idx|
        if size then
          @mails.push POPMail.new( idx, size, @proto )
        end
      end
      @mails.freeze
    end

  end   # POP3Session

  POPSession = POP3Session
  POP3       = POP3Session


=begin

== Net::POPMail

A class of mail which exists on POP server.

=== Super Class

Object


=== Method

: all
: pop
: mail

  This method fetches a mail and return it.

: header

  This method fetches only mail header.

: top( lines )

  This method fetches mail header and 'lines' lines body.

: delete
: delete!

  This method deletes mail.

: size

  size of mail(bytes)

: deleted?

  true if mail was deleted

=end

  class POPMail

    def initialize( idx, siz, pro )
      @num     = idx
      @size    = siz
      @proto   = pro

      @deleted = false
    end


    attr :size

    def all( dest = '' )
      @proto.retr( @num, dest )
    end
    alias pop all
    alias mail all

    def top( lines, dest = '' )
      @proto.top( @num, lines, dest )
    end

    def header( dest = '' )
      top( 0, dest )
    end

    def delete
      @proto.dele( @num )
      @deleted = true
    end
    alias delete! delete

    def deleted?
      @deleted
    end

    def uidl
      @proto.uidl @num
    end

  end


=begin

== Net::APOP3Session

This class has no new methods. Only way of authetication is changed.

=== Super Class

Net::POP3Session

=end

  class APOPSession < POP3Session

    session_setvar :command_type, 'APOPCommand'

  end

  APOP = APOPSession


=begin

== Net::POP3Command

POP3 protocol class.

=== Super Class

Net::Command

=== Class Methods

: new( socket )

  This method creates new POP3Command object. 'socket' must be ProtocolSocket.


=== Methods

: auth( account, password )

  This method do POP authorization (no RPOP)
  In case of failed authorization, raises Protocol::ProtocolError exception.

: list

  a list of mails which existing on server.
  The list is an array like "array[ number ] = size".

  ex:

    The list from server is

    1 2452
    2 3355
    4 9842
       :

    then, an array is

    [ nil, 2452, 3355, nil, 9842, ... ]

: quit

  This method finishes POP3 session.

: rset

  This method reset all changes done in current session,
  by sending 'RSET' command.

: top( num, lines = 0 )

  This method gets all mail header and 'lines' lines body
  by sending 'TOP' command.  'num' is mail number.

  WARNING: the TOP command is 'Optional' in RFC1939 (POP3)


: retr( num : Integer )

  This method gets a mail by 'RETR' command. 'num' is mail number.


: dele( num : Integer )

  This method deletes a mail on server by 'DELE'.

=end


  class POP3Command < Command

    def initialize( sock )
      super
      check_reply SuccessCode
    end


    def auth( acnt, pass )
      @socket.writeline( 'USER ' + acnt )
      check_reply_auth

      @socket.writeline( 'PASS ' + pass )
      ret = check_reply_auth

      return ret
    end


    def list
      @socket.writeline( 'LIST' )
      check_reply( SuccessCode )
      
      arr = []
      @socket.read_pendlist do |line|
        num, siz = line.split( / +/o )
        arr[ num.to_i ] = siz.to_i
      end

      return arr
    end


    def rset
      @socket.writeline( 'RSET' )
      check_reply( SuccessCode )
    end


    def top( num, lines = 0, dest = '' )
      @socket.writeline( sprintf( 'TOP %d %d', num, lines ) )
      check_reply( SuccessCode )

      return @socket.read_pendstr( dest )
    end


    def retr( num, dest = '', &block )
      @socket.writeline( sprintf( 'RETR %d', num ) )
      check_reply( SuccessCode )

      return @socket.read_pendstr( dest, &block )
    end

    
    def dele( num )
      @socket.writeline( 'DELE ' + num.to_s )
      check_reply( SuccessCode )
    end


    def uidl( num )
      @socket.writeline( 'UIDL ' + num.to_s )
      rep = check_reply( SuccessCode )
      uid = rep.msg.split(' ')[1]

      uid
    end


    private


    def do_quit
      @socket.writeline( 'QUIT' )
      check_reply( SuccessCode )
    end


    def check_reply_auth
      begin
        cod = check_reply( SuccessCode )
      rescue ProtocolError
        raise ProtoAuthError, 'Fail to POP authentication'
      end

      return cod
    end


    def get_reply
      str = @socket.readline

      if /\A\+/ === str then
        return SuccessCode.new( str[0,3], str[3, str.size - 3].strip )
      else
        return ErrorCode.new( str[0,4], str[4, str.size - 4].strip )
      end
    end

  end


=begin

== APOPCommand

=== Super Class

POP3Command

=== Methods

: auth( account, password )

  This method do authorization by sending 'APOP' command.
  If server is not APOP server, this raises Net::ProtoAuthError exception.
  On other errors, raises Net::ProtocolError.

=end

  class APOPCommand < POP3Command

    def initialize( sock )
      rep = super( sock )

      /<[^@]+@[^@>]+>/o === rep.msg
      @stamp = $&
      unless @stamp then
        raise ProtoAuthError, "This is not APOP server: can't login"
      end
    end


    def auth( acnt, pass )
      @socket.writeline( "APOP #{acnt} #{digest(@stamp + pass)}" )
      return check_reply_auth
    end


    def digest( str )
      temp = MD5.new( str ).digest

      ret = ''
      temp.each_byte do |i|
        ret << sprintf( '%02x', i )
      end
      return ret
    end
      
  end

end