123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::MailboxQuota

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Struct
Instance Chain:
self, Struct
Inherits: Struct
  • Object
Defined in: lib/net/imap/response_data.rb

Overview

MailboxQuota represents the data of an untagged QUOTA response.

#getquota returns an array of MailboxQuota objects.

#getquotaroot returns an array containing both MailboxQuotaRoot and MailboxQuota objects.

Required capability

Requires QUOTA [RFC2087] or QUOTA=RES-STORAGE [RFC9208] capability.

Instance Attribute Summary

Instance Attribute Details

#mailbox ⇒ String (rw) Also known as: #quota_root

The quota root with the associated quota.

NOTE: this was mistakenly named "mailbox". But the quota root's name may differ from the mailbox. A single quota root may cover multiple mailboxes, and a single mailbox may be governed by multiple quota roots.

[ GitHub ] 

  


# File 'lib/net/imap/response_data.rb', line 478



class MailboxQuota < Struct.new(:mailbox, :usage, :quota)


  








  

    #quota  ⇒ Integer  (rw)  



  

    
Storage limit imposed on the mailbox.

  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 478



class MailboxQuota < Struct.new(:mailbox, :usage, :quota)


  








  

    #quota_root   (readonly)
  



  

    
Alias for #mailbox.

  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 490



alias quota_root mailbox


  








  

    #usage  ⇒ Integer  (rw)  



  

    
Current storage usage of the mailbox.

  



  [ GitHub ]


  

  


# File 'lib/net/imap/response_data.rb', line 478



class MailboxQuota < Struct.new(:mailbox, :usage, :quota)