Module: Gmail

Defined in:
lib/gmail.rb,
lib/gmail/client.rb,
lib/gmail/labels.rb,
lib/gmail/mailbox.rb,
lib/gmail/message.rb,
lib/gmail/version.rb,
lib/gmail/client/base.rb,
lib/gmail/client/plain.rb,
lib/gmail/client/xoauth.rb,
lib/gmail/client/xoauth2.rb,
lib/gmail/imap_extensions.rb

Defined Under Namespace

Modules: Client, ImapExtensions Classes: Labels, Mailbox, Message

Constant Summary collapse

VERSION = 
"0.7.1".freeze

Class Method Summary collapse

Class Method Details

.new(*args, &block) ⇒ Object Also known as: connect

Creates new Gmail connection using given authorization options.

Examples

Gmail.new(:plain, "[email protected]", "password")
Gmail.new(:xoauth, "[email protected]",
  :consumer_key => "",
  :consumer_secret => "",
  :token => "",
  :secret => "")

To use plain authentication method you can also call:

Gmail.new("[email protected]", "password")

You can also use block-style call:

Gmail.new("[email protected]", "password") do |client|
  # ...
end



41
42
43
44
45
46
47
48
 
# File 'lib/gmail.rb', line 41

def new(*args, &block)
  args.unshift(:plain) unless args.first.is_a?(Symbol)
  client = Gmail::Client.new(*args)
  client.connect
  client.

  check_with_block(client, &block)
end

.new!(*args, &block) ⇒ Object Also known as: connect! 



51
52
53
54
55
56
57
58
 
# File 'lib/gmail.rb', line 51

def new!(*args, &block)
  args.unshift(:plain) unless args.first.is_a?(Symbol)
  client = Gmail::Client.new(*args)
  client.connect!
  client.login!

  check_with_block(client, &block)
end