Class: Imap::Backup::Account

Inherits:
Object
  • Object
show all
Defined in:
lib/imap/backup/account.rb,
lib/imap/backup/account/backup.rb,
lib/imap/backup/account/folder.rb,
lib/imap/backup/account/restore.rb,
lib/imap/backup/account/folder_backup.rb,
lib/imap/backup/account/backup_folders.rb,
lib/imap/backup/account/client_factory.rb,
lib/imap/backup/account/folder_ensurer.rb,
lib/imap/backup/account/serialized_folders.rb,
lib/imap/backup/account/local_only_folder_deleter.rb

Overview

Contains the attributes relating to an email account.

Defined Under Namespace

Classes: Backup, BackupFolders, ClientFactory, Folder, FolderBackup, FolderEnsurer, LocalOnlyFolderDeleter, Restore, SerializedFolders

Constant Summary collapse

DEFAULT_MULTI_FETCH_SIZE =

By default, the backup process fetches one email at a time

1

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Account

Returns a new instance of Account.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/imap/backup/account.rb', line 62

def initialize(options)
  @username = options[:username]
  @password = options[:password]
  @local_path = options[:local_path]
  @folders = options[:folders]
  @folder_blacklist = options[:folder_blacklist] || false
  @mirror_mode = options[:mirror_mode] || false
  @server = options[:server]
  @connection_options = nil
  @supplied_connection_options = options[:connection_options]
  @download_strategy = options[:download_strategy]
  @multi_fetch_size_orignal = options[:multi_fetch_size]
  @reset_seen_flags_after_fetch = options[:reset_seen_flags_after_fetch]
  @client = nil
  @changes = {}
  @marked_for_deletion = false
end

Instance Attribute Details

#download_strategy ⇒ String

The name of the download strategy to adopt during backups

Returns:

  • (String) 


47
48
49
 
# File 'lib/imap/backup/account.rb', line 47

def download_strategy
  @download_strategy
end

#folder_blacklist ⇒ Boolean

Indicates whether the configured folders are a whitelist or a blacklist. When true, any folders attribute will be taken as a list of folders to skip when running backups. When false, the folders attribute is used as the list of folders to backup. If no folders are configured, all folders on the server are backed up irrespective of the folder_blacklist setting

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/imap/backup/account.rb', line 37

def folder_blacklist
  @folder_blacklist
end

#folders ⇒ Array<String>, void #folders=(value) ⇒ void

Overloads:

  • #folders ⇒ Array<String>, void

    The list of folders that have been configured for the Account

    Returns:

    • (Array<String>, void)

    See Also:

  • #folders=(value) ⇒ void

    This method returns an undefined value.

    Sets the folders attribute and marks it as modified, storing the original value

    Parameters:

    • value (Array<String>) —

      a list of folders



29
30
31
 
# File 'lib/imap/backup/account.rb', line 29

def folders
  @folders
end

#local_path ⇒ String

Returns the path where backups will be saved.

Returns:

  • (String) —

    the path where backups will be saved



20
21
22
 
# File 'lib/imap/backup/account.rb', line 20

def local_path
  @local_path
end

#mirror_mode ⇒ Boolean

Should all emails be backed up progressively, or should emails which are deleted from the server be deleted locally?

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/imap/backup/account.rb', line 41

def mirror_mode
  @mirror_mode
end

#password ⇒ String

Returns password of the Account.

Returns:

  • (String) —

    password of the Account



18
19
20
 
# File 'lib/imap/backup/account.rb', line 18

def password
  @password
end

#reset_seen_flags_after_fetch ⇒ Boolean

Should ‘Seen’ flags be cached before fetchiong emails and rewritten to the server afterwards?

Some IMAP providers, notably Apple Mail, set the ‘Seen’ flag on emails when they are fetched. By setting :reset_seen_flags_after_fetch, a workaround is activated which checks which emails are ‘unseen’ before and after the fetch, and removes the ‘Seen’ flag from those which have changed. As this check is susceptible to ‘race conditions’, i.e. when a different client sets the ‘Seen’ flag while imap-backup is fetching, it is best to only use it when required (i.e. for IMAP providers which always mark messages as ‘Seen’ when accessed).

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/imap/backup/account.rb', line 60

def reset_seen_flags_after_fetch
  @reset_seen_flags_after_fetch
end

#server ⇒ String

The address of the IMAP server

Returns:

  • (String) 


44
45
46
 
# File 'lib/imap/backup/account.rb', line 44

def server
  @server
end

#username ⇒ String

The username of the account (usually the same as the email address)

Returns:

  • (String) 


16
17
18
 
# File 'lib/imap/backup/account.rb', line 16

def username
  @username
end

Instance Method Details

#capabilities ⇒ Array<String>

Returns the capabilites of the IMAP server

Returns:

  • (Array<String>) —

    the capabilities



97
98
99
 
# File 'lib/imap/backup/account.rb', line 97

def capabilities
  client.capability
end

#clear_changes ⇒ void

This method returns an undefined value.

Resets the store of changes, indicating that the current state is the saved state



123
124
125
 
# File 'lib/imap/backup/account.rb', line 123

def clear_changes
  @changes = {}
end

#client ⇒ Account::Client::Default

Initializes a client for the account’s IMAP server

Returns:

  • (Account::Client::Default) —

    the client



83
84
85
 
# File 'lib/imap/backup/account.rb', line 83

def client
  @client ||= ::ClientFactory.new(account: self).run
end

#connection_options ⇒ Hash, void

Extra options to be passed to the IMAP server when connecting

Returns:

  • (Hash, void) 


201
202
203
204
205
206
207
208
209
 
# File 'lib/imap/backup/account.rb', line 201

def connection_options
  @connection_options ||=
    case @supplied_connection_options
    when String
      JSON.parse(@supplied_connection_options, symbolize_names: true)
    else
      @supplied_connection_options
    end
end

#connection_options=(value) ⇒ void

This method returns an undefined value.



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/imap/backup/account.rb', line 212

def connection_options=(value)
  # Ensure we've loaded the connection_options
  connection_options
  parsed =
    if value == ""
      nil
    else
      JSON.parse(value, symbolize_names: true)
    end
  update(:connection_options, parsed)
end

#mark_for_deletion ⇒ void

This method returns an undefined value.

Sets a flag indicating the Account should be excluded from the next save operation



130
131
132
 
# File 'lib/imap/backup/account.rb', line 130

def mark_for_deletion
  @marked_for_deletion = true
end

#marked_for_deletion? ⇒ Boolean

Returns whether the account has been flagged for deletion during setup.

Returns:

  • (Boolean) —

    whether the account has been flagged for deletion during setup



135
136
137
 
# File 'lib/imap/backup/account.rb', line 135

def marked_for_deletion?
  @marked_for_deletion
end

#modified? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/imap/backup/account.rb', line 117

def modified?
  changes.any?
end

#multi_fetch_size ⇒ Integer

The number of emails to fetch from the IMAP server at a time

Returns:

  • (Integer) 


227
228
229
230
231
232
233
234
235
236
 
# File 'lib/imap/backup/account.rb', line 227

def multi_fetch_size
  @multi_fetch_size ||= begin
    int = @multi_fetch_size_orignal.to_i
    if int.positive?
      int
    else
      DEFAULT_MULTI_FETCH_SIZE
    end
  end
end

#multi_fetch_size=(value) ⇒ void

This method returns an undefined value.

Sets the multi_fetch_size attribute and marks it as modified, storing the original value. If the supplied value is not a positive integer, uses DEFAULT_MULTI_FETCH_SIZE



242
243
244
245
246
 
# File 'lib/imap/backup/account.rb', line 242

def multi_fetch_size=(value)
  parsed = value.to_i
  parsed = DEFAULT_MULTI_FETCH_SIZE if !parsed.positive?
  update(:multi_fetch_size, parsed)
end

#namespaces ⇒ Array<String>

Returns the namespaces configured for the account on the IMAP server

Returns:

  • (Array<String>) —

    the namespaces



90
91
92
 
# File 'lib/imap/backup/account.rb', line 90

def namespaces
  client.namespace
end

#restore ⇒ void

This method returns an undefined value.

Restore the local backup to the server



104
105
106
107
 
# File 'lib/imap/backup/account.rb', line 104

def restore
  restore = ::Restore.new(account: self)
  restore.run
end

#to_h ⇒ Hash

Returns all Account data for serialization.

Returns:

  • (Hash) —

    all Account data for serialization



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/imap/backup/account.rb', line 140

def to_h
  h = {username: @username, password: @password}
  h[:local_path] = @local_path if @local_path
  h[:folders] = @folders if @folders
  h[:folder_blacklist] = true if @folder_blacklist
  h[:mirror_mode] = true if @mirror_mode
  h[:server] = @server if @server
  h[:connection_options] = @connection_options if connection_options
  h[:multi_fetch_size] = multi_fetch_size
  if @reset_seen_flags_after_fetch
    h[:reset_seen_flags_after_fetch] = @reset_seen_flags_after_fetch
  end
  h
end

#valid? ⇒ Boolean

Indicates whether the account has been configured, and is ready to be used

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/imap/backup/account.rb', line 113

def valid?
  username && password ? true : false
end