Class: Imap::Backup::Client::Default

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/imap/backup/client/default.rb

Overview

Wraps a Net::IMAP instance Tracks the latest folder selection in order to avoid repeated calls

Instance Method Summary collapse

Constructor Details

#initialize(account) ⇒ Default

Returns a new instance of Default.



21
22
23
24
 
# File 'lib/imap/backup/client/default.rb', line 21

def initialize()
  @account = 
  @state = nil
end

Instance Method Details

#disconnect ⇒ void

This method returns an undefined value.

Disconects from the server



62
63
64
65
 
# File 'lib/imap/backup/client/default.rb', line 62

def disconnect
  imap.disconnect
  self.state = nil
end

#examine(mailbox) ⇒ void

This method returns an undefined value.

Prepares read-only access to a folder



69
70
71
72
73
74
 
# File 'lib/imap/backup/client/default.rb', line 69

def examine(mailbox)
  return if state == [:examine, mailbox]

  imap.examine(mailbox)
  self.state = [:examine, mailbox]
end

#list ⇒ Array<String>

Returns the account folders.

Returns:

  • (Array<String>) —

    the account folders



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/imap/backup/client/default.rb', line 27

def list
  root = provider_root
  Logger.logger.debug "Listing all account folders"
  mailbox_lists = imap.list(root, "*")

  return [] if mailbox_lists.nil?

  ignored_tags = provider.folder_ignore_tags
  mailbox_lists.
    select { |ml| ml.attr & ignored_tags == [] }.
    map { |ml| extract_name(ml) }
end

#login ⇒ void

This method returns an undefined value.

Logs in to the account on the IMAP server



42
43
44
45
46
 
# File 'lib/imap/backup/client/default.rb', line 42

def 
  Logger.logger.debug "Logging in: #{.username}/#{masked_password}"
  imap.(.username, .password)
  Logger.logger.debug "Login complete"
end

#reconnect ⇒ void

This method returns an undefined value.

Logs out and back in to the server



50
51
52
53
 
# File 'lib/imap/backup/client/default.rb', line 50

def reconnect
  disconnect
  
end

#select(mailbox) ⇒ void

This method returns an undefined value.

Prepares read-write access to a folder



78
79
80
81
82
83
 
# File 'lib/imap/backup/client/default.rb', line 78

def select(mailbox)
  return if state == [:select, mailbox]

  imap.select(mailbox)
  self.state = [:select, mailbox]
end

#username ⇒ String

Returns the account username.

Returns:

  • (String) —

    the account username



56
57
58
 
# File 'lib/imap/backup/client/default.rb', line 56

def username
  .username
end