Class: Google::Apis::GmailV1::ImapSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/gmail_v1/classes.rb,
generated/google/apis/gmail_v1/representations.rb,
generated/google/apis/gmail_v1/representations.rb

Overview

IMAP settings for an account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ImapSettings

Returns a new instance of ImapSettings



471
472
473
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 471

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auto_expunge ⇒ Boolean Also known as: auto_expunge?

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. Corresponds to the JSON property autoExpunge

Returns:

  • (Boolean) 


449
450
451
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 449

def auto_expunge
  @auto_expunge
end

#enabled ⇒ Boolean Also known as: enabled?

Whether IMAP is enabled for the account. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


455
456
457
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 455

def enabled
  @enabled
end

#expunge_behavior ⇒ String

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder. Corresponds to the JSON property expungeBehavior

Returns:

  • (String) 


462
463
464
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 462

def expunge_behavior
  @expunge_behavior
end

#max_folder_size ⇒ Fixnum

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. Corresponds to the JSON property maxFolderSize

Returns:

  • (Fixnum) 


469
470
471
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 469

def max_folder_size
  @max_folder_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



476
477
478
479
480
481
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 476

def update!(**args)
  @auto_expunge = args[:auto_expunge] if args.key?(:auto_expunge)
  @enabled = args[:enabled] if args.key?(:enabled)
  @expunge_behavior = args[:expunge_behavior] if args.key?(:expunge_behavior)
  @max_folder_size = args[:max_folder_size] if args.key?(:max_folder_size)
end