Class: Gmail::Client
Defined Under Namespace
Classes: AuthorizationError, ConnectionError, DeliveryError
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
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#password ⇒ Object
readonly
Returns the value of attribute password.
-
#username ⇒ Object
readonly
Returns the value of attribute username.
Instance Method Summary collapse
-
#compose(mail = nil, &block) ⇒ Object
(also: #message)
Compose new e-mail.
-
#connect(raise_errors = false) ⇒ Object
Connect to gmail service.
-
#connect! ⇒ Object
This version of connect will raise error on failure…
-
#connection ⇒ Object
(also: #conn)
Return current connection.
-
#deliver(mail = nil, raise_errors = false, &block) ⇒ Object
Compose (optionaly) and send given email.
-
#deliver!(mail = nil, &block) ⇒ Object
This version of deliver will raise error on failure…
- #fill_username(username) ⇒ Object
-
#inbox ⇒ Object
Alias for
mailbox("INBOX")
. -
#initialize(username, password, options = {}) ⇒ Client
constructor
A new instance of Client.
- #inspect ⇒ Object
-
#labels ⇒ Object
Return labels object, which helps you with managing your GMail labels.
-
#logged_in? ⇒ Boolean
(also: #signed_in?)
Returns
true
when you are logged in to specified account. -
#login(raise_errors = false) ⇒ Object
(also: #sign_in)
Login to specified account.
-
#login! ⇒ Object
(also: #sign_in!)
This version of login will raise error on failure…
-
#logout ⇒ Object
(also: #sign_out)
Logout from GMail service.
- #mail_domain ⇒ Object
-
#mailbox(name, &block) ⇒ Object
(also: #in_mailbox, #in_label, #label)
Do something with given mailbox or within it context.
- #mailboxes ⇒ Object
Constructor Details
#initialize(username, password, options = {}) ⇒ Client
Returns a new instance of Client.
22 23 24 25 26 27 |
# File 'lib/gmail/client.rb', line 22 def initialize(username, password, ={}) defaults = {} @username = fill_username(username) @password = password @options = defaults.merge() end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
20 21 22 |
# File 'lib/gmail/client.rb', line 20 def @options end |
#password ⇒ Object (readonly)
Returns the value of attribute password.
19 20 21 |
# File 'lib/gmail/client.rb', line 19 def password @password end |
#username ⇒ Object (readonly)
Returns the value of attribute username.
18 19 20 |
# File 'lib/gmail/client.rb', line 18 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 |
# File 'lib/gmail/client.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.
30 31 32 33 34 |
# File 'lib/gmail/client.rb', line 30 def connect(raise_errors=false) @imap = Net::IMAP.new(GMAIL_IMAP_HOST, GMAIL_IMAP_PORT, true, nil, false) 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…
37 38 39 |
# File 'lib/gmail/client.rb', line 37 def connect! connect(true) end |
#connection ⇒ Object Also known as: conn
Return current connection. Log in automaticaly to specified account if it is necessary.
43 44 45 46 |
# File 'lib/gmail/client.rb', line 43 def connection login 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)
132 133 134 135 136 137 |
# File 'lib/gmail/client.rb', line 132 def deliver(mail=nil, raise_errors=false, &block) mail = compose(mail, &block) if block_given? 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…
140 141 142 |
# File 'lib/gmail/client.rb', line 140 def deliver!(mail=nil, &block) deliver(mail, true, &block) end |
#fill_username(username) ⇒ Object
190 191 192 |
# File 'lib/gmail/client.rb', line 190 def fill_username(username) username =~ /@/ ? username : "#{username}@gmail.com" end |
#inbox ⇒ Object
Alias for mailbox("INBOX")
. See Gmail::Client#mailbox
for details.
178 179 180 |
# File 'lib/gmail/client.rb', line 178 def inbox mailbox("INBOX") end |
#inspect ⇒ Object
186 187 188 |
# File 'lib/gmail/client.rb', line 186 def inspect "#<Gmail::Client#{'0x%04x' % (object_id << 1)} (#{username}) #{'dis' if !logged_in?}connected>" end |
#labels ⇒ Object
Return labels object, which helps you with managing your GMail labels. See Gmail::Labels
for details.
79 80 81 |
# File 'lib/gmail/client.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.
64 65 66 |
# File 'lib/gmail/client.rb', line 64 def logged_in? !!@logged_in end |
#login(raise_errors = false) ⇒ Object Also known as: sign_in
Login to specified account.
50 51 52 53 54 |
# File 'lib/gmail/client.rb', line 50 def login(raise_errors=false) @imap and @logged_in = (login = @imap.login(username, password)) && login.name == 'OK' rescue Net::IMAP::NoResponseError raise_errors and raise AuthorizationError, "Couldn't login to given GMail account: #{username}" end |
#login! ⇒ Object Also known as: sign_in!
This version of login will raise error on failure…
58 59 60 |
# File 'lib/gmail/client.rb', line 58 def login! login(true) end |
#logout ⇒ Object Also known as: sign_out
Logout from GMail service.
70 71 72 73 74 |
# File 'lib/gmail/client.rb', line 70 def logout @imap && logged_in? and @imap.logout ensure @logged_in = false end |
#mail_domain ⇒ Object
194 195 196 |
# File 'lib/gmail/client.rb', line 194 def mail_domain username.split('@')[0] 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
159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/gmail/client.rb', line 159 def mailbox(name, &block) name = name.to_s mailbox = (mailboxes[name] ||= Mailbox.new(self, name)) switch_to_mailbox(name) if @current_mailbox != name 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 mailbox end |
#mailboxes ⇒ Object
182 183 184 |
# File 'lib/gmail/client.rb', line 182 def mailboxes @mailboxes ||= {} end |