mailfolder

package
v0.20240927.1005214 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/me/stable/mailfolder Documentation

The mailfolder SDK allows for interaction with Microsoft Graph me (API Version stable).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/me/stable/mailfolder"

Client Initialization

client := mailfolder.NewMailFolderClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: MailFolderClient.CopyMailFolder

ctx := context.TODO()
id := mailfolder.NewMeMailFolderID("mailFolderId")

payload := mailfolder.CopyMailFolderRequest{
	// ...
}


read, err := client.CopyMailFolder(ctx, id, payload, mailfolder.DefaultCopyMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.CreateMailFolder

ctx := context.TODO()

payload := mailfolder.MailFolder{
	// ...
}


read, err := client.CreateMailFolder(ctx, payload, mailfolder.DefaultCreateMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.DeleteMailFolder

ctx := context.TODO()
id := mailfolder.NewMeMailFolderID("mailFolderId")

read, err := client.DeleteMailFolder(ctx, id, mailfolder.DefaultDeleteMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.GetMailFolder

ctx := context.TODO()
id := mailfolder.NewMeMailFolderID("mailFolderId")

read, err := client.GetMailFolder(ctx, id, mailfolder.DefaultGetMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.GetMailFoldersCount

ctx := context.TODO()


read, err := client.GetMailFoldersCount(ctx, mailfolder.DefaultGetMailFoldersCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.ListMailFolders

ctx := context.TODO()


// alternatively `client.ListMailFolders(ctx, mailfolder.DefaultListMailFoldersOperationOptions())` can be used to do batched pagination
items, err := client.ListMailFoldersComplete(ctx, mailfolder.DefaultListMailFoldersOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: MailFolderClient.MoveMailFolder

ctx := context.TODO()
id := mailfolder.NewMeMailFolderID("mailFolderId")

payload := mailfolder.MoveMailFolderRequest{
	// ...
}


read, err := client.MoveMailFolder(ctx, id, payload, mailfolder.DefaultMoveMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MailFolderClient.UpdateMailFolder

ctx := context.TODO()
id := mailfolder.NewMeMailFolderID("mailFolderId")

payload := mailfolder.MailFolder{
	// ...
}


read, err := client.UpdateMailFolder(ctx, id, payload, mailfolder.DefaultUpdateMailFolderOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CopyMailFolderOperationOptions 

type CopyMailFolderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCopyMailFolderOperationOptions 

func DefaultCopyMailFolderOperationOptions() CopyMailFolderOperationOptions

func (CopyMailFolderOperationOptions) ToHeaders 

func (o CopyMailFolderOperationOptions) ToHeaders() *client.Headers

func (CopyMailFolderOperationOptions) ToOData 

func (o CopyMailFolderOperationOptions) ToOData() *odata.Query

func (CopyMailFolderOperationOptions) ToQuery 

func (o CopyMailFolderOperationOptions) ToQuery() *client.QueryParams

type CopyMailFolderOperationResponse 

type CopyMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.MailFolder
}

type CopyMailFolderRequest 

type CopyMailFolderRequest struct {
	DestinationId *string `json:"DestinationId,omitempty"`
}

type CreateMailFolderOperationOptions 

type CreateMailFolderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateMailFolderOperationOptions 

func DefaultCreateMailFolderOperationOptions() CreateMailFolderOperationOptions

func (CreateMailFolderOperationOptions) ToHeaders 

func (o CreateMailFolderOperationOptions) ToHeaders() *client.Headers

func (CreateMailFolderOperationOptions) ToOData 

func (o CreateMailFolderOperationOptions) ToOData() *odata.Query

func (CreateMailFolderOperationOptions) ToQuery 

func (o CreateMailFolderOperationOptions) ToQuery() *client.QueryParams

type CreateMailFolderOperationResponse 

type CreateMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.MailFolder
}

type DeleteMailFolderOperationOptions 

type DeleteMailFolderOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteMailFolderOperationOptions 

func DefaultDeleteMailFolderOperationOptions() DeleteMailFolderOperationOptions

func (DeleteMailFolderOperationOptions) ToHeaders 

func (o DeleteMailFolderOperationOptions) ToHeaders() *client.Headers

func (DeleteMailFolderOperationOptions) ToOData 

func (o DeleteMailFolderOperationOptions) ToOData() *odata.Query

func (DeleteMailFolderOperationOptions) ToQuery 

func (o DeleteMailFolderOperationOptions) ToQuery() *client.QueryParams

type DeleteMailFolderOperationResponse 

type DeleteMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetMailFolderOperationOptions 

type GetMailFolderOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetMailFolderOperationOptions 

func DefaultGetMailFolderOperationOptions() GetMailFolderOperationOptions

func (GetMailFolderOperationOptions) ToHeaders 

func (o GetMailFolderOperationOptions) ToHeaders() *client.Headers

func (GetMailFolderOperationOptions) ToOData 

func (o GetMailFolderOperationOptions) ToOData() *odata.Query

func (GetMailFolderOperationOptions) ToQuery 

func (o GetMailFolderOperationOptions) ToQuery() *client.QueryParams

type GetMailFolderOperationResponse 

type GetMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.MailFolder
}

type GetMailFoldersCountOperationOptions 

type GetMailFoldersCountOperationOptions struct {
	Filter               *string
	IncludeHiddenFolders *string
	Metadata             *odata.Metadata
	RetryFunc            client.RequestRetryFunc
	Search               *string
}

func DefaultGetMailFoldersCountOperationOptions 

func DefaultGetMailFoldersCountOperationOptions() GetMailFoldersCountOperationOptions

func (GetMailFoldersCountOperationOptions) ToHeaders 

func (o GetMailFoldersCountOperationOptions) ToHeaders() *client.Headers

func (GetMailFoldersCountOperationOptions) ToOData 

func (o GetMailFoldersCountOperationOptions) ToOData() *odata.Query

func (GetMailFoldersCountOperationOptions) ToQuery 

func (o GetMailFoldersCountOperationOptions) ToQuery() *client.QueryParams

type GetMailFoldersCountOperationResponse 

type GetMailFoldersCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListMailFoldersCompleteResult 

type ListMailFoldersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.MailFolder
}

type ListMailFoldersCustomPager 

type ListMailFoldersCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}
func (p *ListMailFoldersCustomPager) NextPageLink() *odata.Link

type ListMailFoldersOperationOptions 

type ListMailFoldersOperationOptions struct {
	Count                *bool
	Expand               *odata.Expand
	Filter               *string
	IncludeHiddenFolders *string
	Metadata             *odata.Metadata
	OrderBy              *odata.OrderBy
	RetryFunc            client.RequestRetryFunc
	Search               *string
	Select               *[]string
	Skip                 *int64
	Top                  *int64
}

func DefaultListMailFoldersOperationOptions 

func DefaultListMailFoldersOperationOptions() ListMailFoldersOperationOptions

func (ListMailFoldersOperationOptions) ToHeaders 

func (o ListMailFoldersOperationOptions) ToHeaders() *client.Headers

func (ListMailFoldersOperationOptions) ToOData 

func (o ListMailFoldersOperationOptions) ToOData() *odata.Query

func (ListMailFoldersOperationOptions) ToQuery 

func (o ListMailFoldersOperationOptions) ToQuery() *client.QueryParams

type ListMailFoldersOperationResponse 

type ListMailFoldersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.MailFolder
}

type MailFolderClient 

type MailFolderClient struct {
	Client *msgraph.Client
}

func NewMailFolderClientWithBaseURI 

func NewMailFolderClientWithBaseURI(sdkApi sdkEnv.Api) (*MailFolderClient, error)

func (MailFolderClient) CopyMailFolder 

func (c MailFolderClient) CopyMailFolder(ctx context.Context, id stable.MeMailFolderId, input CopyMailFolderRequest, options CopyMailFolderOperationOptions) (result CopyMailFolderOperationResponse, err error)

CopyMailFolder - Invoke action copy. Copy a mailfolder and its contents to another mailfolder.

func (MailFolderClient) CreateMailFolder 

func (c MailFolderClient) CreateMailFolder(ctx context.Context, input stable.MailFolder, options CreateMailFolderOperationOptions) (result CreateMailFolderOperationResponse, err error)

CreateMailFolder - Create MailFolder. Use this API to create a new mail folder in the root folder of the user's mailbox. If you intend a new folder to be hidden, you must set the isHidden property to true on creation.

func (MailFolderClient) DeleteMailFolder 

func (c MailFolderClient) DeleteMailFolder(ctx context.Context, id stable.MeMailFolderId, options DeleteMailFolderOperationOptions) (result DeleteMailFolderOperationResponse, err error)

DeleteMailFolder - Delete mailFolder. 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.

func (MailFolderClient) GetMailFolder 

func (c MailFolderClient) GetMailFolder(ctx context.Context, id stable.MeMailFolderId, options GetMailFolderOperationOptions) (result GetMailFolderOperationResponse, err error)

GetMailFolder - Get mailFolder. Retrieve the properties and relationships of a message folder object. The following list shows the two existing scenarios where an app can get another user's mail folder

func (MailFolderClient) GetMailFoldersCount 

func (c MailFolderClient) GetMailFoldersCount(ctx context.Context, options GetMailFoldersCountOperationOptions) (result GetMailFoldersCountOperationResponse, err error)

GetMailFoldersCount - Get the number of the resource

func (MailFolderClient) ListMailFolders 

func (c MailFolderClient) ListMailFolders(ctx context.Context, options ListMailFoldersOperationOptions) (result ListMailFoldersOperationResponse, err error)

ListMailFolders - List mailFolders. Get the mail folder collection directly under the root folder of the signed-in user. The returned collection includes any mail search folders directly under the root. By default, this operation does not return hidden folders. Use a query parameter includeHiddenFolders to include them in the response. This operation does not return all mail folders in a mailbox, only the child folders of the root folder. To return all mail folders in a mailbox, each child folder must be traversed separately.

func (MailFolderClient) ListMailFoldersComplete 

func (c MailFolderClient) ListMailFoldersComplete(ctx context.Context, options ListMailFoldersOperationOptions) (ListMailFoldersCompleteResult, error)

ListMailFoldersComplete retrieves all the results into a single object

func (MailFolderClient) ListMailFoldersCompleteMatchingPredicate 

func (c MailFolderClient) ListMailFoldersCompleteMatchingPredicate(ctx context.Context, options ListMailFoldersOperationOptions, predicate MailFolderOperationPredicate) (result ListMailFoldersCompleteResult, err error)

ListMailFoldersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MailFolderClient) MoveMailFolder 

func (c MailFolderClient) MoveMailFolder(ctx context.Context, id stable.MeMailFolderId, input MoveMailFolderRequest, options MoveMailFolderOperationOptions) (result MoveMailFolderOperationResponse, err error)

MoveMailFolder - Invoke action move. Move a mailfolder and its contents to another mailfolder.

func (MailFolderClient) UpdateMailFolder 

func (c MailFolderClient) UpdateMailFolder(ctx context.Context, id stable.MeMailFolderId, input stable.MailFolder, options UpdateMailFolderOperationOptions) (result UpdateMailFolderOperationResponse, err error)

UpdateMailFolder - Update mailSearchFolder. Update the writable properties of a mailSearchFolder object.

type MailFolderOperationPredicate 

type MailFolderOperationPredicate struct {
}

func (MailFolderOperationPredicate) Matches 

func (p MailFolderOperationPredicate) Matches(input stable.MailFolder) bool

type MoveMailFolderOperationOptions 

type MoveMailFolderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultMoveMailFolderOperationOptions 

func DefaultMoveMailFolderOperationOptions() MoveMailFolderOperationOptions

func (MoveMailFolderOperationOptions) ToHeaders 

func (o MoveMailFolderOperationOptions) ToHeaders() *client.Headers

func (MoveMailFolderOperationOptions) ToOData 

func (o MoveMailFolderOperationOptions) ToOData() *odata.Query

func (MoveMailFolderOperationOptions) ToQuery 

func (o MoveMailFolderOperationOptions) ToQuery() *client.QueryParams

type MoveMailFolderOperationResponse 

type MoveMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.MailFolder
}

type MoveMailFolderRequest 

type MoveMailFolderRequest struct {
	DestinationId *string `json:"DestinationId,omitempty"`
}

type UpdateMailFolderOperationOptions 

type UpdateMailFolderOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdateMailFolderOperationOptions 

func DefaultUpdateMailFolderOperationOptions() UpdateMailFolderOperationOptions

func (UpdateMailFolderOperationOptions) ToHeaders 

func (o UpdateMailFolderOperationOptions) ToHeaders() *client.Headers

func (UpdateMailFolderOperationOptions) ToOData 

func (o UpdateMailFolderOperationOptions) ToOData() *odata.Query

func (UpdateMailFolderOperationOptions) ToQuery 

func (o UpdateMailFolderOperationOptions) ToQuery() *client.QueryParams

type UpdateMailFolderOperationResponse 

type UpdateMailFolderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.