module Gmail

Constants

VERSION

Public Class Methods

connect(*args, &block)

Alias for: new

connect!(*args, &block)

Alias for: new!

new(*args, &block) click to toggle source

Creates new Gmail connection using given authorization options.

Examples¶ ↑

Gmail.new(:plain, "foo@gmail.com", "password")
Gmail.new(:xoauth, "foo@gmail.com",
  :consumer_key => "",
  :consumer_secret => "",
  :token => "",
  :secret => "")

To use plain authentication method you can also call:

Gmail.new("foo@gmail.com", "password")

You can also use block-style call:

Gmail.new("foo@gmail.com", "password") do |client|
  # ...
end

# 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.login

  check_with_block(client, &block)
end

Also aliased as: connect

new!(*args, &block) click to toggle source

# 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

Also aliased as: connect!

Private Class Methods

check_with_block(client) { |client| ... } click to toggle source

# File lib/gmail.rb, line 63
def check_with_block(client, &block)
  if block_given?
    yield client
    client.logout
  end

  client
end