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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

Note:

When making an API call, you may pass FolderConfiguration data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Returns:

  • (String)


1107
1108
1109
1110
1111
1112
1113
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1107

class FolderConfiguration < Struct.new(
  :name,
  :action,
  :period)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The folder name.

Returns:

  • (String)


1107
1108
1109
1110
1111
1112
1113
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1107

class FolderConfiguration < Struct.new(
  :name,
  :action,
  :period)
  SENSITIVE = []
  include Aws::Structure
end

#periodInteger

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

Returns:

  • (Integer)


1107
1108
1109
1110
1111
1112
1113
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1107

class FolderConfiguration < Struct.new(
  :name,
  :action,
  :period)
  SENSITIVE = []
  include Aws::Structure
end