AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkMail::Types::FolderConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FolderConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
  action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
  period: 1,
}

The configuration applied to an organization's folders by its retention policy.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to take on the folder contents at the end of the folder configuration period.

Possible values:

  • NONE
  • DELETE
  • PERMANENTLY_DELETE

Returns:

  • (String)

    The action to take on the folder contents at the end of the folder configuration period.

#nameString

The folder name.

Possible values:

  • INBOX
  • DELETED_ITEMS
  • SENT_ITEMS
  • DRAFTS
  • JUNK_EMAIL

Returns:

  • (String)

    The folder name.

#periodInteger

The period of time at which the folder configuration action is applied.

Returns:

  • (Integer)

    The period of time at which the folder configuration action is applied.