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 contents of GETQUOTA response. This object can also be a response to GETQUOTAROOT. In the syntax specification below, the delimiter used with the "#" construct is a single space (SPACE).

Net:IMAP#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

  • #mailbox (also: #quota_root) rw

    MailboxQuota represents contents of GETQUOTA response.

  • #quota rw

    MailboxQuota represents contents of GETQUOTA response.

  • #quota_root readonly

    Alias for #mailbox.

  • #usage rw

    MailboxQuota represents contents of GETQUOTA response.

Instance Attribute Details

#mailbox (rw) Also known as: #quota_root

MailboxQuota represents contents of GETQUOTA response. This object can also be a response to GETQUOTAROOT. In the syntax specification below, the delimiter used with the "#" construct is a single space (SPACE).

Net:IMAP#getquota returns an array of MailboxQuota objects.

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

Required capability

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

[ GitHub ] 

  


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



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


  








  

    #quota   (rw)
  



  

    
MailboxQuota represents contents of GETQUOTA response.
This object can also be a response to GETQUOTAROOT.  In the syntax
specification below, the delimiter used with the "#" construct is a
single space (SPACE).


Net:IMAP#getquota returns an array of MailboxQuota objects.


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


Required capability


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

  



  [ GitHub ]


  

  


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



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


  








  

    #quota_root   (readonly)
  



  

    
Alias for #mailbox.

  



  [ GitHub ]


  

  


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



alias quota_root mailbox


  








  

    #usage   (rw)
  



  

    
MailboxQuota represents contents of GETQUOTA response.
This object can also be a response to GETQUOTAROOT.  In the syntax
specification below, the delimiter used with the "#" construct is a
single space (SPACE).


Net:IMAP#getquota returns an array of MailboxQuota objects.


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


Required capability


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

  



  [ GitHub ]


  

  


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



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