Class: Gmail::Client::Base

Inherits:
Object show all
Defined in:
lib/gmail/client/base.rb

Direct Known Subclasses

Plain, XOAuth, XOAuth2

Constant Summary collapse

GMAIL_IMAP_HOST =

Gmail IMAP defaults

'imap.gmail.com'
GMAIL_IMAP_PORT =
993
GMAIL_SMTP_HOST =

Gmail SMTP defaults

"smtp.gmail.com"
GMAIL_SMTP_PORT =
587

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username, options = {}) ⇒ Base

Returns a new instance of Base


17
18
19
20
21
22
# File 'lib/gmail/client/base.rb', line 17

def initialize(username, options = {})
  defaults       = {}
  @username      = fill_username(username)
  @options       = defaults.merge(options)
  @mailbox_mutex = Mutex.new
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options


15
16
17
# File 'lib/gmail/client/base.rb', line 15

def options
  @options
end

#usernameObject (readonly)

Returns the value of attribute username


14
15
16
# File 'lib/gmail/client/base.rb', line 14

def username
  @username
end

Instance Method Details

#compose(mail = nil, &block) ⇒ Object Also known as: message

Compose new e-mail.

Examples

mail = gmail.compose
mail.from "[email protected]"
mail.to "[email protected]"

… or block style:

mail = gmail.compose do
  from "[email protected]"
  to "[email protected]"
  subject "Hello!"
  body "Hello my friend! long time..."
end

Now you can deliver your mail:

gmail.deliver(mail)

103
104
105
106
107
108
109
110
111
112
113
# File 'lib/gmail/client/base.rb', line 103

def compose(mail = nil, &block)
  if block_given?
    mail = Mail.new(&block)
  elsif !mail
    mail = Mail.new
  end

  mail.delivery_method(*smtp_settings)
  mail.from = username unless mail.from
  mail
end

#connect(raise_errors = false) ⇒ Object

Connect to gmail service.


25
26
27
28
29
30
31
# File 'lib/gmail/client/base.rb', line 25

def connect(raise_errors = false)
  @imap = Net::IMAP.new(GMAIL_IMAP_HOST, GMAIL_IMAP_PORT, true, nil, false)
  Gmail::ImapExtensions.patch_net_imap_response_parser
  @imap
rescue SocketError
  raise_errors and raise ConnectionError, "Couldn't establish connection with Gmail IMAP service"
end

#connect!Object

This version of connect will raise error on failure…


34
35
36
# File 'lib/gmail/client/base.rb', line 34

def connect!
  connect(true)
end

#connectionObject Also known as: conn

Return current connection. Log in automaticaly to specified account if it is necessary.


40
41
42
43
# File 'lib/gmail/client/base.rb', line 40

def connection
   and at_exit { logout } unless logged_in?
  @imap
end

#deliver(mail = nil, raise_errors = false, &block) ⇒ Object

Compose (optionaly) and send given email.

Examples

gmail.deliver do
  to "[email protected]"
  subject "Hello friend!"
  body "Hi! How are you?"
end

… or with already created message:

mail = Mail.new { ... }
gmail.deliver(mail)

mail = gmail.compose { ... }
gmail.deliver(mail)

133
134
135
136
137
138
# File 'lib/gmail/client/base.rb', line 133

def deliver(mail = nil, raise_errors = false, &block)
  mail = compose(mail, &block)
  mail.deliver!
rescue Object => ex
  raise_errors and raise DeliveryError, "Couldn't deliver email: #{ex.to_s}"
end

#deliver!(mail = nil, &block) ⇒ Object

This version of deliver will raise error on failure…


141
142
143
# File 'lib/gmail/client/base.rb', line 141

def deliver!(mail = nil, &block)
  deliver(mail, true, &block)
end

#disconnectObject

Disconnect from Gmail service.


73
74
75
# File 'lib/gmail/client/base.rb', line 73

def disconnect
  @imap && @imap.disconnect
end

#fill_username(username) ⇒ Object


195
196
197
# File 'lib/gmail/client/base.rb', line 195

def fill_username(username)
  username =~ /@/ ? username : "#{username}@gmail.com"
end

#inboxObject

Alias for mailbox("INBOX"). See Gmail::Mailbox for details.


183
184
185
# File 'lib/gmail/client/base.rb', line 183

def inbox
  mailbox("INBOX")
end

#inspectObject


191
192
193
# File 'lib/gmail/client/base.rb', line 191

def inspect
  "#<Gmail::Client#{'0x%04x' % (object_id << 1)} (#{username}) #{'dis' if !logged_in?}connected>"
end

#labelsObject

Return labels object, which helps you with managing your Gmail labels. See Gmail::Labels for details.


79
80
81
# File 'lib/gmail/client/base.rb', line 79

def labels
  @labels ||= Labels.new(conn)
end

#logged_in?Boolean Also known as: signed_in?

Returns true when you are logged in to specified account.

Returns:

  • (Boolean)

59
60
61
# File 'lib/gmail/client/base.rb', line 59

def logged_in?
  !!@logged_in
end

#login(*args) ⇒ Object Also known as: sign_in

Login to specified account.

Raises:

  • (NotImplementedError)

47
48
49
# File 'lib/gmail/client/base.rb', line 47

def (*args)
  raise NotImplementedError, "The `#{self.class.name}#login` method is not implemented."
end

#login!Object Also known as: sign_in!

This version of login will raise error on failure…


53
54
55
# File 'lib/gmail/client/base.rb', line 53

def login!
  (true)
end

#logoutObject Also known as: sign_out

Logout from Gmail service.


65
66
67
68
69
# File 'lib/gmail/client/base.rb', line 65

def logout
  @imap && logged_in? and @imap.logout
ensure
  @logged_in = false
end

#mail_domainObject


199
200
201
# File 'lib/gmail/client/base.rb', line 199

def mail_domain
  username.split('@').last
end

#mailbox(name, &block) ⇒ Object Also known as: in_mailbox, in_label, label

Do something with given mailbox or within it context.

Examples

mailbox = gmail.mailbox("INBOX")
mailbox.emails(:all)
mailbox.count(:unread, :before => Time.now-(20*24*3600))

… or block style:

gmail.label("Work") do |mailbox|
  mailbox.emails(:unread)
  mailbox.count(:all)
  ...
end

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/gmail/client/base.rb', line 160

def mailbox(name, &block)
  @mailbox_mutex.synchronize do
    name = labels.localize(name)
    mailbox = (mailboxes[name] ||= Mailbox.new(self, name))
    switch_to_mailbox(mailbox) if @current_mailbox != mailbox

    if block_given?
      mailbox_stack << @current_mailbox
      result = block.arity == 1 ? block.call(mailbox) : block.call
      mailbox_stack.pop
      switch_to_mailbox(mailbox_stack.last)
      return result
    end

    return mailbox
  end
end

#mailboxesObject


187
188
189
# File 'lib/gmail/client/base.rb', line 187

def mailboxes
  @mailboxes ||= {}
end