Class: MicrosoftGraph::Users::Item::MailFolders::Item::MailFolderItemRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb

Overview

Provides operations to manage the mailFolders property of the microsoft.graph.user entity.

Defined Under Namespace

Classes: MailFolderItemRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new MailFolderItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



55
56
57
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 55

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/users/{user%2Did}/mailFolders/{mailFolder%2Did}{?includeHiddenFolders*,%24select,%24expand}")
end

Instance Method Details

#child_folders ⇒ Object

Provides operations to manage the childFolders property of the microsoft.graph.mailFolder entity.



26
27
28
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 26

def child_folders()
    return MicrosoftGraph::Users::Item::MailFolders::Item::ChildFolders::ChildFoldersRequestBuilder.new(@path_parameters, @request_adapter)
end

#copy ⇒ Object

Provides operations to call the copy method.



31
32
33
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 31

def copy()
    return MicrosoftGraph::Users::Item::MailFolders::Item::Copy::CopyRequestBuilder.new(@path_parameters, @request_adapter)
end

#delete(request_configuration = nil) ⇒ Object

Delete the specified mailFolder. The folder can be a mailSearchFolder. You can specify a mail folder by its folder ID, or by its well-known folder name, if one exists.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of void



63
64
65
66
67
68
69
70
71
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 63

def delete(request_configuration=nil)
    request_info = self.to_delete_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, nil, error_mapping)
end

#get(request_configuration = nil) ⇒ Object

The user’s mail folders. Read-only. Nullable.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of mail_folder



77
78
79
80
81
82
83
84
85
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 77

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::MailFolder.create_from_discriminator_value(pn) }, error_mapping)
end

#message_rules ⇒ Object

Provides operations to manage the messageRules property of the microsoft.graph.mailFolder entity.



36
37
38
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 36

def message_rules()
    return MicrosoftGraph::Users::Item::MailFolders::Item::MessageRules::MessageRulesRequestBuilder.new(@path_parameters, @request_adapter)
end

#messages ⇒ Object

Provides operations to manage the messages property of the microsoft.graph.mailFolder entity.



41
42
43
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 41

def messages()
    return MicrosoftGraph::Users::Item::MailFolders::Item::Messages::MessagesRequestBuilder.new(@path_parameters, @request_adapter)
end

#move ⇒ Object

Provides operations to call the move method.



46
47
48
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 46

def move()
    return MicrosoftGraph::Users::Item::MailFolders::Item::Move::MoveRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Update the writable properties of a mailSearchFolder object.

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of mail_folder

Raises:

  • (StandardError) 


92
93
94
95
96
97
98
99
100
101
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 92

def patch(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_patch_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::MailFolder.create_from_discriminator_value(pn) }, error_mapping)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Delete the specified mailFolder. The folder can be a mailSearchFolder. You can specify a mail folder by its folder ID, or by its well-known folder name, if one exists.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 107

def to_delete_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :DELETE
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_get_request_information(request_configuration = nil) ⇒ Object

The user’s mail folders. Read-only. Nullable.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 123

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_patch_request_information(body, request_configuration = nil) ⇒ Object

Update the writable properties of a mailSearchFolder object.

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information

Raises:

  • (StandardError) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/users/item/mail_folders/item/mail_folder_item_request_builder.rb', line 142

def to_patch_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :PATCH
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.set_content_from_parsable(@request_adapter, "application/json", body)
    return request_info
end