gmailer 0.0.5 → 0.0.6

data/CHANGES

@@ -1,20 +1,25 @@
+== 0.0.6 - 29-Aug-2005
+- add edit star method
+- add edit archive method
+- rename get_ method
+
 == 0.0.5 - 28-Aug-2005
-* add edit label mothods
-* add edit preference method
-* fix some bugs
+- add edit label mothods
+- add edit preference method
+- fix some bugs
 
 == 0.0.4 - 26-Aug-2005
-* remove camelCase methods
-* fix some bugs 
-* modify some key name
+- remove camelCase methods
+- fix some bugs 
+- modify some key name
 
 == 0.0.3 - 25-Aug-2005
-* add some methods 
-* add support for proxy
+- add some methods 
+- add support for proxy
 
 == 0.0.2 - 20-Aug-2005
-* add some methods 
-* make more compact and simple
+- add some methods 
+- make more compact and simple
 
 == 0.0.1 - 17-Aug-2005
-* Initial release
+- Initial release

data/README

@@ -9,7 +9,7 @@
    gmail.set_login_info(name, pwd)
    if gmail.connect
       gmail.fetch_box(GM_LABEL, "my_label", 0)
-      snapshot = gmail.get_snapshot(GM_LABEL)
+      snapshot = gmail.snapshot(GM_LABEL)
       if snapshot
          puts "Total # of conversations of my_label = " + snapshot.box_total.to_s
       end
@@ -65,7 +65,7 @@ Or shorter
    gmail.set_login_info(name, pwd)
    if gmail.connect
       gmail.fetch_box(GM_CONTACT, "freq", 0)
-      snapshot = gmail.get_snapshot(GM_CONTACT)
+      snapshot = gmail.snapshot(GM_CONTACT)
       puts "Your frequently used addresses:"
       snapshot.contacts.each { |item|
          puts "Name: " + item["name"] + ", Email: " + item["email"]
@@ -84,8 +84,8 @@ Or shorter
 === Get list of labels and get list of messages
 
 GMailer.connect(:username=>name,:password=>pwd) do |g|
- labels = g.get_labels
- g.get_messages(:label=>labels[0]).each {|m|
+ labels = g.labels
+ g.messages(:label=>labels[0]).each {|m|
     puts "Subject: #{m['subject']} / Snippet: #{m['snippet']}" if m['new?']
  }
 end
@@ -121,10 +121,30 @@ GMailer.connect(:username=>name,:password=>pwd) do |g|
 		:reply_to=>'return@foo.bar',
 		:snippets=>true,
 		:display_name=>'Display Name')
-    pref = g.get_preference
+    pref = g.preference
     puts "Display language:#{pref['display_language']}, Max Page Size:#{pref['max_page_size']}"
 end
 
+=== Apply star and remove star
+
+GMailer.connect(:username=>name,:password=>pwd) do |g|
+    #apply star to a message
+    g.apply_star(msgid)
+
+    #remove star from a message
+    g.remove_star(msgid)
+end
+
+=== Archive and unarchive a message
+
+GMailer.connect(:username=>name,:password=>pwd) do |g|
+    #archive a message
+    g.archive(msgid)
+
+    #unarchive a message
+    g.unarchive(msgid)
+end
+
 == Class Methods
 GMailer.new(charset='UTF-8')
 	Returns a new GMailer object and set up charset.
@@ -168,24 +188,24 @@ fetch_box(type,box,position)
 	box: name of "box" (e.g. Inbox, your_label, "all"/"freq" of contacts)
 	position: cursor for paged result.
 
-get_snapshot(type)
+snapshot(type)
 	To get a "snapshot", an object (see GMailSnapshot below) for you to
 	access query result at ease.
 
-get_labels()
+labels()
 	To get list of labels.	
 
-get_preference()
+preference()
 	To get hash of preference setting.	
 
-get_messages()
+messages()
 	To get list of messages.	
 
-get_attachment(attachment_id,message_id,filename,zipped)
+attachment(attachment_id,message_id,filename,zipped)
 	To download an attachment of a message. If zipped is true, download ALL
 	attachements of message_id in a zip file.
 
-get_attachments_of(conv, path_to_store_files)
+attachments_of(conv, path_to_store_files)
 	To download ALL files attached to a conversation. The full path of
 	downloaded files will be returned (as array).
 
@@ -204,6 +224,18 @@ apply_label(msgid,label)
 remove_label(msgid,label)
         To remove a label to a message
 
+apply_star(msgid)
+        To apply starring to a message
+
+remove_star(msgid)
+        To remove starring from a message
+
+archive(msgid)
+        To archive a message
+
+unarchive(msgid)
+        To unarchive a message
+
 update_preference(preference hash)
         To update preference setting
         hash is one of :max_page_size(25,50,100),:keyboard_shortcuts(true,false),:indicators(true,false),
@@ -233,7 +265,7 @@ disconnect()
 dump(query)
 	To dump ALL it gets from URL query string, including headers.
 
-get_standard_box()
+standard_box()
 	To get an array of names of the "standard box" (Inbox, Starred, etc.)
 
 invite(email)

data/gmailer.rb

@@ -0,0 +1,1314 @@
+#
+# = gmailer.rb: A class for interface to Google's webmail service
+#
+# Author:: Park Heesob
+#
+# project home page: http://rubyforge.org/projects/gmailutils
+#
+
+# $D_ON = false
+
+require  'net/https'
+
+GM_LNK_GMAIL = "/mail/"
+GM_LNK_HOST =        "mail.google.com"
+GM_LNK_LOGIN =        "/accounts/ServiceLoginAuth"
+GM_LNK_LOGOUT =       "/mail/?logout"
+GM_LNK_ATTACHMENT =          "/mail/?view=att&disp=att"
+GM_LNK_ATTACHMENT_ZIPPED =   "/mail/?view=att&disp=zip"
+
+GM_USER_AGENT = "Mozilla/5.0 (X11 U Linux i686 en-US rv:1.4b) Gecko/20040612 Mozilla Firebird/0.9"
+
+GM_STANDARD =      0x001
+GM_LABEL =         0x002
+GM_CONVERSATION =  0x004
+GM_QUERY =         0x008
+GM_CONTACT =       0x010
+GM_PREFERENCE =    0x020
+
+GM_ACT_CREATELABEL =  1
+GM_ACT_DELETELABEL =  2
+GM_ACT_RENAMELABEL =  3
+GM_ACT_APPLYLABEL =   4
+GM_ACT_REMOVELABEL =  5
+GM_ACT_PREFERENCE =   6
+GM_ACT_STAR =         7
+GM_ACT_UNSTAR =       8
+GM_ACT_SPAM =         9
+GM_ACT_UNSPAM =       10
+GM_ACT_READ =         11
+GM_ACT_UNREAD =       12
+GM_ACT_TRASH =        13
+GM_ACT_DELFOREVER =   14
+GM_ACT_ARCHIVE =      15
+GM_ACT_INBOX =        16
+GM_ACT_UNTRASH =      17
+GM_ACT_UNDRAFT =      18
+GM_ACT_TRASHMSG =     19     # trash individual message
+GM_ACT_DELSPAM =      20     # delete spam, forever
+GM_ACT_DELTRASHED =   21     # delete trash message, forever
+
+class GMailer
+
+    VERSION = "0.0.6"
+
+    @cookie_str
+    @login
+    @pwd
+    @raw             # raw packets
+    @contact_raw     # raw packets for address book
+    @timezone
+    @created
+    @proxy_host
+    @proxy_port
+    @proxy_user
+    @proxy_pass
+
+    def encode(str)
+      return str if @charset.upcase == 'UTF-8'
+      begin
+          require 'Win32API'
+          str += "\0"
+          ostr = "\0" * 256
+          multiByteToWideChar = Win32API.new('kernel32','MultiByteToWideChar',['L','L','P','L','P','L'],'L')
+          multiByteToWideChar.Call(0,0,str,-1,ostr,128)
+          (ostr.strip + "\0").unpack("S*").pack("U*")
+      rescue LoadError
+          require 'iconv'
+          Iconv::iconv('UTF-8',@charset,str)[0]
+      end
+    end
+
+    #
+    # return GMailer
+    # desc Constructor
+    #
+    def initialize(*param)
+       Debugger::say("Constructing GMailer...")
+       @login = ''
+       @pwd = ''
+       @raw = {}
+       @proxy_host = nil
+       @proxy_port = 0
+       @proxy_user = nil
+       @proxy_pass = nil
+       @proxy = false
+       if param.length==1 && param[0].class==Hash
+         param = param[0]
+         set_login_info(param[:username]||'',param[:password]||'')
+         @proxy_host = param[:proxy_host]
+         @proxy = !@proxy_host.nil?
+         @proxy_port = param[:proxy_port] || 80
+         @proxy_user = param[:proxy_user]
+         @proxy_pass = param[:proxy_pass]
+         @charset = param[:charset] || 'UTF-8'
+       elsif param.length==0
+         @charset = 'UTF-8'
+       elsif param.length==1
+         @charset = param[0]
+       elsif param.length==2
+         @charset = 'UTF-8'
+         set_login_info(param[0],param[1])
+       elsif param.length==3
+         @charset = param[2]
+         set_login_info(param[0],param[1])
+       else
+         raise ArgumentError, 'Invalid argument'
+       end
+       Debugger::say("Constructing completed.")
+    end
+
+    #
+    # return void
+    # param string my_login
+    # param string my_pwd
+    # param int my_tz
+    # desc Set GMail login information.
+    #
+    def set_login_info(my_login, my_pwd, my_tz=0)
+        @login = my_login
+        @pwd = my_pwd
+        @timezone = (my_tz*-60).to_i.to_s
+        Debugger::say("LoginInfo set.")
+    end
+
+    #
+    # return bool
+    # desc Connect to GMail without setting any session/cookie.
+    #
+    def connect_no_cookie()
+      Debugger::say("Start connecting without cookie...")
+
+      postdata = "service=mail&Email=" + URI.escape(@login) + "&Passwd=" + URI.escape(@pwd) + "&null=Sign%20in&continue=" +
+                  URI.escape('https://mail.google.com/mail/?ui=html&zy=l') + "&rm=false&PersistentCookie=yes"
+
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 443)
+      np.use_ssl = true
+      np.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      result = ''
+      response = nil
+#     np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.post(GM_LNK_LOGIN, postdata,{'User-agent' => GM_USER_AGENT} )
+        result = response.body
+      }
+
+      if result.include?("errormsg")
+         @cookie_str = ''
+         Debugger::say("Connect failed: " + result)
+         return false
+      end
+
+      cookies = __cookies(response['set-cookie'])
+      arr = URI::split(response["Location"])
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(arr[2], 443)
+      np.use_ssl = true
+      np.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      result = ''
+      response = nil
+#     np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.get(arr[5]+'?'+arr[7], {'Cookie' => cookies,'User-agent' => GM_USER_AGENT} )
+        result = response.body
+      }
+
+      arr = URI::split(response["Location"])
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(arr[2], 443)
+      np.use_ssl = true
+      np.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      result = ''
+      response = nil
+#     np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.get(arr[5]+'?'+arr[7], {'Cookie' => cookies,'User-agent' => GM_USER_AGENT} )
+        result = response.body
+      }
+
+      @loc = response["Location"]
+      cookies += ';' + __cookies(response['set-cookie'])
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(arr[2], 443)
+      np.use_ssl = true
+      np.verify_mode = OpenSSL::SSL::VERIFY_NONE
+#     np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.get(@loc, {'Cookie' => cookies,'User-agent' => GM_USER_AGENT} )
+        result = response.body
+      }
+      cookies += ';' + __cookies(response['set-cookie'])
+
+      @cookie_str = cookies + ";TZ=" + @timezone
+
+      Debugger::say("Finished connecting without cookie.")
+      return true
+    end
+
+    #
+    # return bool
+    # desc Connect to GMail with default session management settings.
+    #
+    def connect()
+      connect_no_cookie()
+    end
+
+    # Singleton method
+    # return bool
+    # desc Connect to GMail with default session management settings.
+    #
+
+    def GMailer.connect(*param)
+      g = GMailer.new(*param)
+      g.connect_no_cookie()
+      if block_given?
+        yield(g)
+        g.disconnect()
+      else
+        g
+      end
+    end
+
+
+    #
+    # return bool
+    # desc See if it is connected to GMail.
+    #
+    def is_connected()
+      !@cookie_str.empty?
+    end
+
+    #
+    # return bool
+    # param string query
+    # desc Fetch contents by URL query.
+    #
+    def __fetch(query)
+      if is_connected()
+        Debugger::say("Start fetching query: " + query)
+        query += "&zv=" + (rand(2000)*2147483.648).to_i.to_s
+        np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+#        np.set_debug_output($stderr)
+        inbox = ''
+        np.start { |http|
+          response = http.get(GM_LNK_GMAIL + "?" + query,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT })
+          inbox = response.body
+        }
+
+        inbox = inbox.gsub("\n",'').gsub("D([","\nD([").gsub("])","])\n")
+
+        matches = inbox.scan(/D\((.*)\)/).flatten
+        packets = {}
+        matches.each {|x|
+          tmp = eval(x.gsub(",,",",'',").gsub(",,",",'',"))
+          if (packets[tmp[0]] || (tmp[0]=="mi"||tmp[0]=="mb"||tmp[0]=="di"))
+             if (tmp[0]=="t"||tmp[0]=="ts"||tmp[0]=="a"||tmp[0]=="cl")
+                packets[tmp[0]] += tmp[1..-1]
+             end
+             if (tmp[0]=="mi"||tmp[0]=="mb"||tmp[0]=="di")
+                if !packets["mg"].nil?
+                   packets["mg"].push(tmp)
+                else
+                   packets["mg"] = [tmp]
+                end
+             end
+          else
+            packets[tmp[0]] = tmp
+          end
+        }
+        if packets["cl"] && packets["cl"].length > 1
+          packets["ce"] = []
+          for i in 1 .. packets["cl"].length-1
+            packets["ce"].push(packets["cl"][i])
+          end
+        end
+        @raw = packets
+
+        Debugger::say("Fetch completed.")
+        true
+      else    # not logged in yet
+        Debugger::say("Fetch failed: not connected.")
+        false
+      end
+    end
+    private :__fetch
+
+    #
+    # return bool
+    # param constant type
+    # param mixed box
+    # param int pos
+    # desc Fetch contents from GMail by type.
+    #
+    def fetch_box(type, box, pos)
+
+      if is_connected()
+        case type
+          when GM_STANDARD
+              q = "search=" + box.downcase + "&view=tl&start=" + pos.to_s
+
+          when GM_LABEL
+              q = "search=cat&cat=" + box.to_s + "&view=tl&start=" + pos.to_s
+
+          when GM_CONVERSATION
+              q = "search=inbox&ser=1&view=cv"
+              if (box.class==Array)
+                 q += "&th=" + box[0].to_s
+                 for i in 1 .. box.length
+                    q += "&msgs=" + box[i].to_s
+                 end
+              else
+                 q += "&th=" + box.to_s
+              end
+
+          when GM_QUERY
+              q = "search=query&q=" + URI.escape(box.to_s) + "&view=tl&start=" + pos.to_s
+
+          when GM_PREFERENCE
+              q = "view=pr&pnl=g"
+
+          when GM_CONTACT
+              if box.downcase == "all"
+                 q = "view=cl&search=contacts&pnl=a"
+              else
+                 q = "view=cl&search=contacts&pnl=d"
+              end
+
+          else
+              q = "search=inbox&view=tl&start=0&init=1"
+        end
+
+        __fetch(q)
+      else
+        false
+      end
+    end
+
+    #
+    # return snapshot
+    # param constant type
+    # param mixed box
+    # param int pos
+    # desc Fetch contents from GMail by type.
+    #
+    def fetch(hash_param)
+        type = GM_STANDARD
+        box = "inbox"
+        pos = 0
+        hash_param.keys.each do |k|
+          case k
+            when :label
+              type = GM_LABEL
+              box = hash_param[k]
+            when :standard
+              type = GM_STANDARD
+              box = hash_param[k]
+            when :conversation
+              type = GM_CONVERSATION
+              box = hash_param[k]
+            when :preference
+              type = GM_PREFERENCE
+              box = hash_param[k]
+            when :contact
+              type = GM_CONTACT
+              box = hash_param[k]
+            when :query
+              type = GM_QUERY
+              box = hash_param[k]
+            when :pos
+              pos = hash_param[k].to_i
+            else
+              raise ArgumentError, 'Invalid hash argument'
+          end
+        end
+        box = "inbox" unless box
+        fetch_box(type,box,pos)
+        snapshot = snapshot(type)
+        if block_given?
+          yield(snapshot)
+        elsif type == GM_CONTACT
+          snapshot.contacts
+        else
+          snapshot
+        end
+    end
+
+    #
+    # return string[]
+    # param string[] convs
+    # param string path
+    # desc Save all attaching files of conversations to a path.
+    #
+    def attachments_of(convs, path)
+
+      if is_connected()
+        if (convs.class != Array)
+           convs = [convs]  # array wrapper
+        end
+        final = []
+        convs.each { |v|
+          if v["attachment"]
+             v["attachment"].each { |vv|
+                f = path+"/"+vv["filename"]
+                f = path+"/"+vv["filename"]+"."+rand(2000).to_s while (FileTest.exist?(f))
+                if attachment(vv["id"],v["id"],f,false)
+                   final.push(f)
+                end
+             }
+             end
+        }
+        final
+      else
+          nil
+      end
+    end
+
+    #
+    # return string[]
+    # param string[] convs
+    # param string path
+    # desc Save all attaching files of conversations to a path.
+    #
+    def zip_attachments_of(convs, path)
+
+      if is_connected()
+           if (convs.class != Array)
+              convs = [convs]  # array wrapper
+           end
+           final = []
+           convs.each {|v|
+              if v["attachment"]
+                f = path+"/attachment.zip"
+                f = path+"/attachment."+rand(2000).to_s+".zip" while (FileTest.exist?(f))
+                if attachment(v["attachment"][0]["id"],v["id"],f,true)
+                   final.push(f)
+                end
+              end
+           }
+           final
+      else
+        nil
+      end
+    end
+
+    #
+    # return bool
+    # param string attid
+    # param string msgid
+    # param string filename
+    # desc Save attachment with attachment ID attid and message ID msgid to file with name filename.
+    #
+    def attachment(attid, msgid, filename, zipped=false)
+
+        if is_connected()
+           Debugger::say("Start getting attachment...")
+
+           if !zipped
+              query = GM_LNK_ATTACHMENT + "&attid=" + URI.escape(attid) + "&th=" + URI.escape(msgid)
+           else
+              query = GM_LNK_ATTACHMENT_ZIPPED + "&th=" + URI.escape(msgid)
+           end
+
+           File.open(filename,"wb") { |f|
+                np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+                np.start { |http|
+                  response = http.get(query,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT })
+                  f.write(response.body)
+                }
+           }
+           Debugger::say("Completed getting attachment.")
+           true
+        else
+           Debugger::say("Failed to get attachment: not connected.")
+           false
+        end
+    end
+
+    #
+    # return array of labels
+    # desc get label lists
+    #
+    def labels()
+        if is_connected()
+           fetch(:standard=>"inbox") {|s| s.label_list }
+        else
+           nil
+        end
+    end
+
+    #
+    # return string
+    # param string label
+    # desc validate label
+    #
+    def validate_label(label)
+        label.strip!
+        if label==''
+            raise ArgumentError, 'Error: Labels cannot empty string'
+        end
+        if label.length  > 40
+            raise ArgumentError, 'Error: Labels cannot contain more than 40 characters'
+        end
+        if label.include?('^')
+            raise ArgumentError, "Error: Labels cannot contain the character '^'"
+        end
+        label
+    end
+
+    #
+    # return boolean
+    # param string label
+    # desc create label
+    #
+    def create_label(label)
+        if is_connected()
+           perform_action(GM_ACT_CREATELABEL, '', validate_label(label))
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string label
+    # desc create label
+    #
+    def delete_label(label)
+        if is_connected()
+           perform_action(GM_ACT_DELETELABEL, '', validate_label(label))
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string old_label
+    # param string new_label
+    # desc create label
+    #
+    def rename_label(old_label,new_label)
+        if is_connected()
+           perform_action(GM_ACT_RENAMELABEL, '',
+              validate_label(old_label) +'^' + validate_label(new_label))
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # param string label
+    # desc apply label to message
+    #
+    def apply_label(id,label)
+        if is_connected()
+           perform_action(GM_ACT_APPLYLABEL, id, validate_label(label))
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # param string label
+    # desc remove label from message
+    #
+    def remove_label(id,label)
+        if is_connected()
+           perform_action(GM_ACT_REMOVELABEL, id, validate_label(label))
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string hash_param
+    # desc remove label from message
+    #
+    def update_preference(hash_param)
+        if is_connected()
+          args = {}
+          hash_param.keys.each do |k|
+            case k
+              when :max_page_size
+                args['p_ix_nt'] = hash_param[k]
+              when :keyboard_shortcuts
+                args['p_bx_hs'] = hash_param[k] ? '1' : '0'
+              when :indicators
+                args['p_bx_sc'] = hash_param[k] ? '1' : '0'
+              when :display_language
+                args['p_sx_dl'] = hash_param[k]
+              when :signature
+                args['p_sx_sg'] = hash_param[k]
+              when :reply_to
+                args['p_sx_rt'] = hash_param[k]
+              when :snippets
+                args['p_bx_ns'] = hash_param[k] ? '0' : '1'
+              when :display_name
+                args['p_sx_dn'] = hash_param[k]
+             end
+           end
+           param = '&' + args.to_a.map {|x| x.join('=')}.join('&')
+           perform_action(GM_ACT_PREFERENCE,'', param)
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # desc apply star to a message
+    #
+    def apply_star(msgid)
+        if is_connected()
+           perform_action(GM_ACT_STAR,msgid, '')
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # desc remove star from a message
+    #
+    def remove_star(msgid)
+        if is_connected()
+           perform_action(GM_ACT_UNSTAR,msgid, '')
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # desc archive a message
+    #
+    def archive(msgid)
+        if is_connected()
+           perform_action(GM_ACT_ARCHIVE,msgid, '')
+        else
+           false
+        end
+    end
+
+    #
+    # return boolean
+    # param string msgid
+    # desc archive a message
+    #
+    def unarchive(msgid)
+        if is_connected()
+           perform_action(GM_ACT_INBOX,msgid, '')
+        else
+           false
+        end
+    end
+    
+    #
+    # return hash of preference
+    # desc get preferences
+    #
+    def preference()
+        if is_connected()
+           fetch(:preference=>"all").preference
+        else
+           nil
+        end
+    end
+
+    #
+    # return array of messages
+    # desc get message lists
+    #
+    def messages(hash_param)
+        if is_connected()
+           fetch(hash_param) {|s| s.box }
+        else
+           nil
+        end
+    end
+
+    #
+    # return string
+    # param string query
+    # desc Dump everything to output.
+    #
+    def dump(query)
+        page = ''
+        if is_connected()
+           Debugger::say("Dumping...")
+           query += "&zv=" + (rand(2000)*2147483.648).to_i.to_s
+           np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+           np.start { |http|
+              response = http.get(GM_LNK_GMAIL + "?"+query,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT })
+              page = response.body
+           }
+
+           Debugger::say("Finished dumping " + page.length.to_s + " bytes.")
+        else    # not logged in yet
+           Debugger::say("Failed to dump: not connected.")
+        end
+        page
+    end
+
+    def stripslashes(string)
+      encode(string.gsub("\\\"", "\"").gsub("\\'", "'").gsub("\\\\", "\\"))
+    end
+
+
+    #
+    # return bool
+    # param string to
+    # param string subject
+    # param string body
+    # param string cc
+    # param string bcc
+    # param string msg_id
+    # param string thread_id
+    # param string[] files
+    # desc Send GMail.
+    #
+    def send(*param)
+      if param.length==1 && param[0].class==Hash
+        param = param[0]
+        to = param[:to] || ''
+        subject = param[:subject] || ''
+        body = param[:body] || ''
+        cc = param[:cc] || ''
+        bcc = param[:bcc] || ''
+        msg_id = param[:msg_id] || ''
+        thread_id = param[:msg_id] || ''
+        files = param[:files] || []
+        draft = param[:draft] || false
+        draft_id = param[:draft_id] || ''
+      elsif param.length==10
+        to, subject, body, cc, bcc, msg_id, thread_id, files, draft, draft_id = param
+      else
+         raise ArgumentError, 'Invalid argument'
+      end
+
+      if is_connected()
+         Debugger::say("Starting to send mail...")
+
+         postdata = {}
+         if draft
+            postdata["view"] = "sd"
+            postdata["draft"] = draft_id
+            postdata["rm"] = msg_id
+            postdata["th"] = thread_id
+         else
+            postdata["view"] = "sm"
+            postdata["draft"] = draft_id
+            postdata["rm"] = msg_id
+            postdata["th"] = thread_id
+         end
+         postdata["msgbody"] = stripslashes(body)
+         postdata["to"] = stripslashes(to)
+         postdata["subject"] = stripslashes(subject)
+         postdata["cc"] = stripslashes(cc)
+         postdata["bcc"] = stripslashes(bcc)
+
+         postdata["cmid"] = 1
+         postdata["ishtml"] = 0
+
+         cc = @cookie_str.split(';')
+         cc.each {|cc_part|
+           cc_parts = cc_part.split('=')
+           if(cc_parts[0]=='GMAIL_AT')
+             postdata["at"] = cc_parts[1]
+             break
+           end
+         }
+
+         boundary = "----#{Time.now.to_i}#{(rand(2000)*2147483.648).to_i}"
+         postdata2 = []
+         postdata.each {|k,v|
+           postdata2.push("Content-Disposition: form-data; name=\"#{k}\"\r\n\r\n#{v}\r\n")
+         }
+
+         files.each_with_index {|f,i|
+            content = File.open(f,'rb') { |c| c.read }
+            postdata2.push("Content-Disposition: form-data; name=\"file#{i}\"; filename=\"#{File.basename(f)}\"\r\n" +
+              "Content-Transfer-Encoding: binary\r\n" +
+              "Content-Type: application/octet-stream\r\n\r\n" + content + "\r\n")
+         }
+
+         postdata = postdata2.collect { |p|
+               "--" + boundary + "\r\n" + p
+         }.join('') + "--" + boundary + "--\r\n"
+
+         np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+         response = nil
+#         np.set_debug_output($stderr)
+         np.start { |http|
+               response = http.post(GM_LNK_GMAIL, postdata,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT,'Content-type' => 'multipart/form-data; boundary=' + boundary  } )
+         }
+         Debugger::say("Finished sending email.")
+         true
+      else
+         Debugger::say("Failed to send email: not connected.")
+         false
+      end
+
+    end
+
+    #
+    # return bool
+    # param constant act
+    # param string[] id
+    # param string para
+    # desc Perform action on messages.
+    #
+    def perform_action(act, id, para)
+
+      if is_connected()
+         Debugger::say("Start performing action...")
+
+         if (act == GM_ACT_DELFOREVER)
+            perform_action(GM_ACT_TRASH, id, 0)  # trash it before
+         end
+         postdata = "act="
+
+         action_codes = ["ib", "cc_", "dc_", "nc_", "ac_", "rc_", "prefs", "st", "xst",
+            "sp", "us", "rd", "ur", "tr", "dl", "rc_^i", "ib", "ib", "dd", "dm", "dl", "dl"]
+         postdata += action_codes[act] ? action_codes[act] : action_codes[GM_ACT_INBOX]
+         if ([GM_ACT_APPLYLABEL,GM_ACT_REMOVELABEL,GM_ACT_CREATELABEL,
+             GM_ACT_DELETELABEL,GM_ACT_RENAMELABEL,GM_ACT_PREFERENCE].include?(act))
+            postdata += para.to_s
+         end
+
+         cc = @cookie_str.split(';')
+         cc.each {|cc_part|
+           cc_parts = cc_part.split('=')
+           if(cc_parts[0]=='GMAIL_AT')
+             postdata += "&at=" + cc_parts[1]
+             break
+           end
+         }
+
+         if (act == GM_ACT_TRASHMSG)
+            postdata += "&m=" + id.to_s
+         else
+            if id.class==Array
+               id.each {|t| postdata += "&t="+t.to_s }
+            else
+               postdata += "&t="+id.to_s
+            end
+         end
+         postdata += "&vp="
+
+         if [GM_ACT_UNTRASH,GM_ACT_DELFOREVER,GM_ACT_DELTRASHED].include?(act)
+            link = GM_LNK_GMAIL+"?search=trash&view=tl&start=0"
+         elsif (act == GM_ACT_DELSPAM)
+            link = GM_LNK_GMAIL+"?search=spam&view=tl&start=0"
+         else
+            link = GM_LNK_GMAIL+"?search=query&q=&view=tl&start=0"
+         end
+
+         np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+#         np.set_debug_output($stderr)
+         np.start { |http|
+            response = http.post(link, postdata,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT} )
+            result = response.body
+         }
+
+         Debugger::say("Finished performing action.")
+         return true
+      else
+         Debugger::say("Failed to perform action: not connected.")
+         return false
+      end
+
+    end
+
+    #
+    # return void
+    # desc Disconnect from GMail.
+    #
+    def disconnect()
+      Debugger::say("Start disconnecting...")
+
+      response = nil
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+#      np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.get(GM_LNK_LOGOUT,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT })
+      }
+      arr = URI::split(response["Location"])
+      np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(arr[2], 80)
+#     np.set_debug_output($stderr)
+      np.start { |http|
+        response = http.get(arr[5]+'?'+arr[7], {'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT} )
+      }
+
+      Debugger::say("Logged-out from GMail.")
+      @cookie_str = ''
+      Debugger::say("Completed disconnecting.")
+    end
+
+    #
+    # return GMailSnapshot
+    # param constant type
+    # desc Get GMSnapshot by type.
+    #
+    def snapshot(type)
+      if [GM_STANDARD,GM_LABEL,GM_CONVERSATION,GM_QUERY,GM_PREFERENCE,GM_CONTACT].include?(type)
+         return GMailSnapshot.new(type, @raw, @charset)
+      else
+         return GMailSnapshot.new(GM_STANDARD, @raw, @charset)  # assuming normal by default
+      end
+    end
+
+    def snap(type)
+      action = GM_STANDARD
+      case type
+        when :standard
+          action = GM_STANDARD
+        when :label
+          action = GM_LABEL
+        when :conversation
+          action = GM_CONVERSATION
+        when :query
+          action = GM_QUERY
+        when :preference
+          action = GM_PREFERENCE
+        when :contact
+          action = GM_CONTACT
+        else
+          raise ArgumentError, 'Invalid type'
+      end
+      snapshot(action)
+    end
+
+    #
+    # return bool
+    # param string email
+    # desc Send Gmail invite to email
+    #
+    def invite(email)
+
+      if is_connected()
+         Debugger::say("Start sending invite...")
+
+         postdata = "act=ii&em=" + URI.escape(email)
+
+         cc = @cookie_str.split(';')
+         cc.each {|cc_part|
+           cc_parts = cc_part.split('=')
+           if(cc_parts[0]=='GMAIL_AT')
+             postdata += "&at=" + cc_parts[1]
+             break
+           end
+         }
+
+         link = GM_LNK_GMAIL + "?view=ii"
+
+         np = Net::HTTP::Proxy(@proxy_host,@proxy_port,@proxy_user,@proxy_pass).new(GM_LNK_HOST, 80)
+         np.use_ssl = true
+         np.verify_mode = OpenSSL::SSL::VERIFY_NONE
+#         np.set_debug_output($stderr)
+         np.start { |http|
+           response = http.post(link, postdata,{'Cookie' => @cookie_str,'User-agent' => GM_USER_AGENT} )
+         }
+
+         Debugger::say("Finished sending invite.")
+         true
+      else
+         Debugger::say("Failed to send invite: not connected.")
+         false
+      end
+
+    end
+
+    #
+    # return string[]
+    # desc (Static) Get names of standard boxes.
+    #
+    def standard_box()
+        ["Inbox","Starred","Sent","Drafts","All","Spam","Trash"]
+    end
+
+    #
+    # return string
+    # param string header
+    # desc (Static Private) Extract cookies from header.
+    #
+    def __cookies(header)
+          return '' unless header
+          arr = []
+          header.split(', ').each { |x|
+            if x.include?('GMT')
+              arr[-1] += ", " + x
+            else
+              arr.push x
+            end
+          }
+         arr.delete_if {|x| x.include?('LSID=EXPIRED') }
+         arr.map! {|x| x.split(';')[0]}
+         arr.join(';')
+    end
+
+end
+
+
+class GMailSnapshot
+
+    GM_STANDARD =      0x001
+    GM_LABEL =         0x002
+    GM_CONVERSATION =  0x004
+    GM_QUERY =         0x008
+    GM_CONTACT =       0x010
+    GM_PREFERENCE =    0x020
+
+    def decode(str)
+      return str if @charset.upcase == 'UTF-8'
+      begin
+          require 'Win32API'
+          str = str.unpack("U*").pack("S*") + "\0"
+          ostr = "\0" * 256
+          wideCharToMultiByte = Win32API.new('kernel32','WideCharToMultiByte',['L','L','P','L','P','L','L','L'],'L')
+          wideCharToMultiByte.Call(0,0,str,-1,ostr,256,0,0)
+          ostr.strip
+      rescue LoadError
+          require 'iconv'
+          Iconv::iconv(@charset,'UTF-8',str)[0]
+      end
+    end
+
+    def strip_tags(str,allowable_tags='')
+      str.gsub(/<[^>]*>/, '')
+    end
+
+    #
+    # return GMailSnapshot
+    # param constant type
+    # param array raw
+    # desc Constructor.
+    #
+    attr_reader :gmail_ver, :quota_mb, :quota_per, :preference
+    attr_reader :std_box_new, :have_invit, :label_list, :label_new
+    attr_reader :box_name, :box_total, :box_pos, :box
+    attr_reader :conv_title, :conv_total, :conv_id, :conv_labels, :conv_starred, :conv
+    attr_reader :contacts
+
+    def initialize(type, raw, charset='UTF-8')
+
+      @charset = charset
+      if (raw.class!=Hash)
+         @created = 0
+         return nil
+      elsif (raw.empty?)
+         @created = 0
+         return nil
+      end
+      if [GM_STANDARD,GM_LABEL,GM_CONVERSATION,GM_QUERY].include?(type)
+         @gmail_ver = raw["v"][1]
+         if raw["qu"]
+           @quota_mb = raw["qu"][1]
+           @quota_per = raw["qu"][3]
+         end
+         if (raw["ds"].class!=Array)
+            @created = 0
+            return nil
+         end
+         @std_box_new = raw["ds"][1..-1]
+         #if (isset(raw["p"])) {
+         #   @owner = raw["p"][5][1]
+         #   @owner_email = raw["p"][6][1]
+         #end
+         @have_invit = raw["i"][1]
+         @label_list = []
+         @label_new = []
+         raw["ct"][1].each {|v|
+             @label_list.push(v[0])
+             @label_new.push(v[1])
+         }
+         if raw["ts"]
+             @view = (GM_STANDARD|GM_LABEL|GM_QUERY)
+             @box_name = raw["ts"][5]
+             @box_total = raw["ts"][3]
+             @box_pos = raw["ts"][1]
+         end
+         @box = []
+         if raw["t"]
+           raw["t"].each {|t|
+               if (t != "t")
+                   b = {
+                      "id"=>t[0],
+                      "is_read"=>(t[1] != 1 ? 1 : 0),
+                      "new?"=>(t[1] == 1),
+                      "is_starred"=>(t[2] == 1 ? 1 : 0),
+                      "star?"=>(t[2] == 1),
+                      "date"=>decode(strip_tags(t[3])),
+                      "sender"=>decode(strip_tags(t[4])),
+                      "flag"=>t[5],
+                      "subject"=>decode(strip_tags(t[6])),
+                      "snippet"=>decode(t[7]),
+                      "labels"=>t[8].empty? ? [] : t[8].map{|tt|decode(tt)},
+                      "attachment"=>t[9].empty? ? []: decode(t[9]).split(","),
+                      "msgid"=>t[10]
+                   }
+                   @box.push(b)
+                end
+           }
+         end
+
+         if (!raw["cs"].nil?)
+           @view = GM_CONVERSATION
+           @conv_title = raw["cs"][2]
+           @conv_total = raw["cs"][8]
+           @conv_id = raw["cs"][1]
+           @conv_labels = raw["cs"][5].empty? ? '' : raw["cs"][5]
+           if !@conv_labels.empty?
+             ij = @conv_labels.index("^i")
+             if !ij.nil?
+                @conv_labels[ij] = "Inbox"
+             end
+             ij = @conv_labels.index("^s")
+             if !ij.nil?
+                @conv_labels[ij] = "Spam"
+             end
+             ij = @conv_labels.index("^k")
+             if !ij.nil?
+                @conv_labels[ij] = "Trash"
+             end
+             ij = @conv_labels.index("^t")
+             if !ij.nil?
+                @conv_labels[ij] = ''   # Starred
+             end
+             ij = @conv_labels.index("^r")
+             if !ij.nil?
+                @conv_labels[ij] = "Drafts"
+             end
+           end
+
+           @conv_starred = false
+
+           @conv = []
+           b = {}
+           raw["mg"].each {|r|
+              if (r[0] == "mb" && !b.empty?)
+                 b["body"] += r[1]
+                 if (r[2] == 0)
+                    @conv.push(b)
+                    b = {}
+                 end
+              elsif (r[0] == "mi")
+                 if !b.empty?
+                    @conv.push(b)
+                    b = {}
+                 end
+                 b = {}
+                 b["index"] = r[2]
+                 b["id"] = r[3]
+                 b["is_star"] = r[4]
+                 if (b["is_star"] == 1)
+                    @conv_starred = true
+                 end
+                 b["sender"] = r[6]
+                 b["sender_email"] = r[8].gsub("\"",'')   # remove annoying d-quotes in address
+                 b["recv"] = r[9]
+                 b["recv_email"] = r[11].to_s.gsub("\"",'')
+                 b["reply_email"] = r[14].to_s.gsub("\"",'')
+                 b["dt_easy"] = r[10]
+                 b["dt"] = r[15]
+                 b["subject"] = r[16]
+                 b["snippet"] = r[17]
+                 b["attachment"] = []
+                 r[18].each {|bb|
+                    b["attachment"].push({"id"=>bb[0],"filename"=>bb[1],"type"=>bb[2],"size"=>bb[3]})
+                 }
+                 b["is_draft"] = false
+                 b["body"] = ''
+              elsif (r[0] == "di")
+                  if !b.empty?
+                     @conv.push(b)
+                     b = {}
+                  end
+                  b = {}
+                  b["index"] = r[2]
+                  b["id"] = r[3]
+                  b["is_star"] = r[4]
+                  @conv_starred =  (b["is_star"] == 1)
+                  b["sender"] = r[6]
+                  b["sender_email"] = r[8].gsub("\"",'')    # remove annoying d-quotes in address
+                  b["recv"] = r[9]
+                  b["recv_email"] = r[11].gsub("\"",'')
+                  b["reply_email"] = r[14].gsub("\"",'')
+                  b["cc_email"] =  r[12].gsub("\"",'')
+                  b["bcc_email"] = r[13].gsub("\"",'')
+                  b["dt_easy"] = r[10]
+                  b["dt"] = r[15]
+                  b["subject"] = r[16]
+                  b["snippet"] = r[17]
+                  b["attachment"] = []
+                  r[18].each {|bb|
+                     b["attachment"].push({"id"=>bb[0],"filename"=>bb[1],"type"=>bb[2],"size"=>bb[3]})
+                  }
+                  b["is_draft"] = true
+                  b["draft_parent"] = r[5]
+                  b["body"] = r[20]
+              end
+           }
+           @conv.push(b) unless b.empty?
+         end
+      elsif type == GM_CONTACT
+         @contacts = []
+         if raw["ce"]
+           raw["ce"].each {|a|
+              b = {
+                 "name"=>a[2],
+                 "email"=>a[4].gsub("\"",'')
+              }
+              if !a[5].empty?
+                 b["notes"] = a[5]
+              end
+              @contacts.push(b)
+           }
+         end
+         @view = GM_CONTACT
+      elsif type == GM_PREFERENCE
+         prefs = {}
+         raw["p"].each_with_index { |v,i|
+             prefs[v[0]] = v[1] if i>0
+         }
+         @preference = {'max_page_size'=>'10',
+                        'keyboard_shortcuts'=>false,
+                        'indicators'=>false,
+                        'display_language'=>'en',
+                        'signature'=>'',
+                        'reply_to'=>'',
+                        'snippets'=>false,
+                        'display_name'=>'',
+                        }
+         prefs.each do |k,v|
+           case k
+            when 'ix_nt'
+              @preference['max_page_size'] = v
+            when 'bx_hs'
+              @preference['keyboard_shortcuts'] = (v == '1')
+            when 'bx_sc'
+              @preference['indicators'] = (v == '1')
+            when 'sx_dl'
+              @preference['display_language'] = v
+            when 'sx_sg'
+              @preference['signature'] = (v == '0') ? '' : v
+            when 'sx_rt'
+              @preference['reply_to'] = v
+            when 'bx_ns'
+              @preference['snippets'] = (v == '0')
+            when 'sx_dn'
+              @preference['display_name'] = v
+           end
+         end
+
+         @label_list = []
+         @label_total = []
+         raw["cta"][1].each { |v|
+             @label_list.push(v[0])
+             @label_total.push(v[1])
+         }
+         @filter = []
+         @filter_rules = []
+         raw["fi"][1].each { |fi|
+            b = {
+               "id" => fi[0],
+               "query" => fi[1],
+               "star" => fi[3],
+               "label" => fi[4],
+               "archive" => fi[5],
+               "trash" => fi[6] #,"forward" => fi[7]
+            }
+            bb = {
+               "from" => fi[2][0],
+               "to" => fi[2][1],
+               "subject" => fi[2][2],
+               "has" => fi[2][3],
+               "hasnot" => fi[2][4],
+               "attach" => fi[2][5]
+            }
+
+            @filter.push(b)
+            @filter_rules.push(bb)
+         }
+         @view = GM_PREFERENCE
+      else
+         @created = 0
+         return nil
+      end
+      @created = 1
+    end
+
+end
+
+
+class Debugger
+     def Debugger.say(str)
+        puts str if $D_ON
+     end
+end
+