mailbox

package
v0.0.0-...-7cd2dfd Latest Latest
Warning

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

Go to latest
Published: May 30, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2018 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Copyright 2022 The go-exactonline AUTHORS. All rights reserved.

Use of this source code is governed by a MIT license that can be found in the LICENSE file. Code generated by gen-services.go; DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DefaultMailbox

type DefaultMailbox struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID: Primary key
	ID *types.GUID `json:"ID,omitempty"`

	// Created: Creation date
	Created *types.Date `json:"Created,omitempty"`

	// Creator: User ID of creator
	Creator *types.GUID `json:"Creator,omitempty"`

	// Description: Extra description of the mailbox
	Description *string `json:"Description,omitempty"`

	// ForDivision: Only used when this mailbox is used for one specific administration, for example invoices to this mailbox will only be booked in this administration
	ForDivision *int `json:"ForDivision,omitempty"`

	// IsScanServiceMailbox: Indicates whether this service is used for messages returned by the scanning service
	IsScanServiceMailbox *bool `json:"IsScanServiceMailbox,omitempty"`

	// Mailbox: E-mail address-like format, for example johndoe@exactonline.nl
	Mailbox *string `json:"Mailbox,omitempty"`

	// Modified: Last modified date
	Modified *types.Date `json:"Modified,omitempty"`

	// Modifier: User ID of modifier
	Modifier *types.GUID `json:"Modifier,omitempty"`

	// ValidFrom: Date that this mailbox became valid
	ValidFrom *types.Date `json:"ValidFrom,omitempty"`

	// ValidTo: Date that this mailbox will not be valid anymore
	ValidTo *types.Date `json:"ValidTo,omitempty"`
}

DefaultMailbox: Service: Mailbox Entity: DefaultMailbox URL: /api/v1/{division}/read/mailbox/DefaultMailbox HasWebhook: false IsInBeta: false Methods: GET Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=ReadMailboxDefaultMailbox

func (*DefaultMailbox) GetPrimary

func (e *DefaultMailbox) GetPrimary() *types.GUID

type DefaultMailboxEndpoint

type DefaultMailboxEndpoint service

DefaultMailboxEndpoint is responsible for communicating with the DefaultMailbox endpoint of the Mailbox service.

func (*DefaultMailboxEndpoint) Get

func (s *DefaultMailboxEndpoint) Get(ctx context.Context, division int, id *types.GUID) (*DefaultMailbox, error)

Get the DefaultMailbox entitiy in the provided division.

func (*DefaultMailboxEndpoint) List

func (s *DefaultMailboxEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*DefaultMailbox, error)

List the DefaultMailbox entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*DefaultMailboxEndpoint) UserHasRights

func (s *DefaultMailboxEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type MailMessageAttachments

type MailMessageAttachments struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID:
	ID *types.GUID `json:"ID,omitempty"`

	// Attachment:
	Attachment *[]byte `json:"Attachment,omitempty"`

	// AttachmentFileExtension:
	AttachmentFileExtension *string `json:"AttachmentFileExtension,omitempty"`

	// AttachmentFileName:
	AttachmentFileName *string `json:"AttachmentFileName,omitempty"`

	// FileSize:
	FileSize *int64 `json:"FileSize,omitempty"`

	// MailMessageID:
	MailMessageID *types.GUID `json:"MailMessageID,omitempty"`

	// MailMessageOrigin:
	MailMessageOrigin *int `json:"MailMessageOrigin,omitempty"`

	// RecipientAccount:
	RecipientAccount *types.GUID `json:"RecipientAccount,omitempty"`

	// SenderAccount:
	SenderAccount *types.GUID `json:"SenderAccount,omitempty"`

	// Type:
	Type *int `json:"Type,omitempty"`

	// TypeDescription:
	TypeDescription *string `json:"TypeDescription,omitempty"`

	// Url:
	Url *string `json:"Url,omitempty"`
}

MailMessageAttachments: Service: Mailbox Entity: MailMessageAttachments URL: /api/v1/{division}/mailbox/MailMessageAttachments HasWebhook: true IsInBeta: false Methods: GET POST Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=MailboxMailMessageAttachments

func (*MailMessageAttachments) GetPrimary

func (e *MailMessageAttachments) GetPrimary() *types.GUID

type MailMessageAttachmentsEndpoint

type MailMessageAttachmentsEndpoint service

MailMessageAttachmentsEndpoint is responsible for communicating with the MailMessageAttachments endpoint of the Mailbox service.

func (*MailMessageAttachmentsEndpoint) Create

Create the MailMessageAttachments entity in the provided division.

func (*MailMessageAttachmentsEndpoint) Get

Get the MailMessageAttachments entitiy in the provided division.

func (*MailMessageAttachmentsEndpoint) List

List the MailMessageAttachments entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*MailMessageAttachmentsEndpoint) New

New returns an empty MailMessageAttachments entity

func (*MailMessageAttachmentsEndpoint) UserHasRights

func (s *MailMessageAttachmentsEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type MailMessagesReceived

type MailMessagesReceived struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID:
	ID *types.GUID `json:"ID,omitempty"`

	// Bank:
	Bank *types.GUID `json:"Bank,omitempty"`

	// BankAccount:
	BankAccount *string `json:"BankAccount,omitempty"`

	// Created:
	Created *types.Date `json:"Created,omitempty"`

	// Creator:
	Creator *types.GUID `json:"Creator,omitempty"`

	// CreatorFullName:
	CreatorFullName *string `json:"CreatorFullName,omitempty"`

	// ForDivision:
	ForDivision *int `json:"ForDivision,omitempty"`

	// Modified:
	Modified *types.Date `json:"Modified,omitempty"`

	// Modifier:
	Modifier *types.GUID `json:"Modifier,omitempty"`

	// ModifierFullName:
	ModifierFullName *string `json:"ModifierFullName,omitempty"`

	// Operation:
	Operation *int `json:"Operation,omitempty"`

	// OriginalMessage:
	OriginalMessage *types.GUID `json:"OriginalMessage,omitempty"`

	// OriginalMessageSubject:
	OriginalMessageSubject *string `json:"OriginalMessageSubject,omitempty"`

	// PartnerKey:
	PartnerKey *types.GUID `json:"PartnerKey,omitempty"`

	// Quantity:
	Quantity *float64 `json:"Quantity,omitempty"`

	// RecipientAccount:
	RecipientAccount *types.GUID `json:"RecipientAccount,omitempty"`

	// RecipientDeleted:
	RecipientDeleted *byte `json:"RecipientDeleted,omitempty"`

	// RecipientMailbox:
	RecipientMailbox *string `json:"RecipientMailbox,omitempty"`

	// RecipientMailboxDescription:
	RecipientMailboxDescription *string `json:"RecipientMailboxDescription,omitempty"`

	// RecipientMailboxID:
	RecipientMailboxID *types.GUID `json:"RecipientMailboxID,omitempty"`

	// RecipientStatus:
	RecipientStatus *int `json:"RecipientStatus,omitempty"`

	// RecipientStatusDescription:
	RecipientStatusDescription *string `json:"RecipientStatusDescription,omitempty"`

	// SenderAccount:
	SenderAccount *types.GUID `json:"SenderAccount,omitempty"`

	// SenderDateSent:
	SenderDateSent *types.Date `json:"SenderDateSent,omitempty"`

	// SenderDeleted:
	SenderDeleted *byte `json:"SenderDeleted,omitempty"`

	// SenderIPAddress:
	SenderIPAddress *string `json:"SenderIPAddress,omitempty"`

	// SenderMailbox:
	SenderMailbox *string `json:"SenderMailbox,omitempty"`

	// SenderMailboxDescription:
	SenderMailboxDescription *string `json:"SenderMailboxDescription,omitempty"`

	// SenderMailboxID:
	SenderMailboxID *types.GUID `json:"SenderMailboxID,omitempty"`

	// Subject:
	Subject *string `json:"Subject,omitempty"`

	// SynchronizationCode:
	SynchronizationCode *string `json:"SynchronizationCode,omitempty"`

	// Type:
	Type *int `json:"Type,omitempty"`
}

MailMessagesReceived: Service: Mailbox Entity: MailMessagesReceived URL: /api/v1/{division}/mailbox/MailMessagesReceived HasWebhook: true IsInBeta: false Methods: GET Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=MailboxMailMessagesReceived

func (*MailMessagesReceived) GetPrimary

func (e *MailMessagesReceived) GetPrimary() *types.GUID

type MailMessagesReceivedEndpoint

type MailMessagesReceivedEndpoint service

MailMessagesReceivedEndpoint is responsible for communicating with the MailMessagesReceived endpoint of the Mailbox service.

func (*MailMessagesReceivedEndpoint) Get

Get the MailMessagesReceived entitiy in the provided division.

func (*MailMessagesReceivedEndpoint) List

List the MailMessagesReceived entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*MailMessagesReceivedEndpoint) UserHasRights

func (s *MailMessagesReceivedEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type MailMessagesSent

type MailMessagesSent struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID:
	ID *types.GUID `json:"ID,omitempty"`

	// Bank:
	Bank *types.GUID `json:"Bank,omitempty"`

	// BankAccount:
	BankAccount *string `json:"BankAccount,omitempty"`

	// Country:
	Country *string `json:"Country,omitempty"`

	// Created:
	Created *types.Date `json:"Created,omitempty"`

	// Creator:
	Creator *types.GUID `json:"Creator,omitempty"`

	// CreatorFullName:
	CreatorFullName *string `json:"CreatorFullName,omitempty"`

	// ForDivision:
	ForDivision *int `json:"ForDivision,omitempty"`

	// Modified:
	Modified *types.Date `json:"Modified,omitempty"`

	// Modifier:
	Modifier *types.GUID `json:"Modifier,omitempty"`

	// ModifierFullName:
	ModifierFullName *string `json:"ModifierFullName,omitempty"`

	// Operation:
	Operation *int `json:"Operation,omitempty"`

	// OriginalMessage:
	OriginalMessage *types.GUID `json:"OriginalMessage,omitempty"`

	// OriginalMessageSubject:
	OriginalMessageSubject *string `json:"OriginalMessageSubject,omitempty"`

	// PartnerKey:
	PartnerKey *types.GUID `json:"PartnerKey,omitempty"`

	// Quantity:
	Quantity *float64 `json:"Quantity,omitempty"`

	// RecipientAccount:
	RecipientAccount *types.GUID `json:"RecipientAccount,omitempty"`

	// RecipientDeleted:
	RecipientDeleted *byte `json:"RecipientDeleted,omitempty"`

	// RecipientMailbox:
	RecipientMailbox *string `json:"RecipientMailbox,omitempty"`

	// RecipientMailboxDescription:
	RecipientMailboxDescription *string `json:"RecipientMailboxDescription,omitempty"`

	// RecipientMailboxID:
	RecipientMailboxID *types.GUID `json:"RecipientMailboxID,omitempty"`

	// RecipientStatus:
	RecipientStatus *int `json:"RecipientStatus,omitempty"`

	// RecipientStatusDescription:
	RecipientStatusDescription *string `json:"RecipientStatusDescription,omitempty"`

	// SenderAccount:
	SenderAccount *types.GUID `json:"SenderAccount,omitempty"`

	// SenderDateSent:
	SenderDateSent *types.Date `json:"SenderDateSent,omitempty"`

	// SenderDeleted:
	SenderDeleted *byte `json:"SenderDeleted,omitempty"`

	// SenderIPAddress:
	SenderIPAddress *string `json:"SenderIPAddress,omitempty"`

	// SenderMailbox:
	SenderMailbox *string `json:"SenderMailbox,omitempty"`

	// SenderMailboxDescription:
	SenderMailboxDescription *string `json:"SenderMailboxDescription,omitempty"`

	// SenderMailboxID:
	SenderMailboxID *types.GUID `json:"SenderMailboxID,omitempty"`

	// Subject:
	Subject *string `json:"Subject,omitempty"`

	// SynchronizationCode:
	SynchronizationCode *string `json:"SynchronizationCode,omitempty"`

	// Type:
	Type *int `json:"Type,omitempty"`
}

MailMessagesSent: Service: Mailbox Entity: MailMessagesSent URL: /api/v1/{division}/mailbox/MailMessagesSent HasWebhook: true IsInBeta: false Methods: GET POST Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=MailboxMailMessagesSent

func (*MailMessagesSent) GetPrimary

func (e *MailMessagesSent) GetPrimary() *types.GUID

type MailMessagesSentEndpoint

type MailMessagesSentEndpoint service

MailMessagesSentEndpoint is responsible for communicating with the MailMessagesSent endpoint of the Mailbox service.

func (*MailMessagesSentEndpoint) Create

func (s *MailMessagesSentEndpoint) Create(ctx context.Context, division int, entity *MailMessagesSent) (*MailMessagesSent, error)

Create the MailMessagesSent entity in the provided division.

func (*MailMessagesSentEndpoint) Get

Get the MailMessagesSent entitiy in the provided division.

func (*MailMessagesSentEndpoint) List

func (s *MailMessagesSentEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*MailMessagesSent, error)

List the MailMessagesSent entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*MailMessagesSentEndpoint) New

New returns an empty MailMessagesSent entity

func (*MailMessagesSentEndpoint) UserHasRights

func (s *MailMessagesSentEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type MailboxService

type MailboxService struct {

	// Endpoints available under this service
	DefaultMailbox         *DefaultMailboxEndpoint
	Mailboxes              *MailboxesEndpoint
	MailMessageAttachments *MailMessageAttachmentsEndpoint
	MailMessagesSent       *MailMessagesSentEndpoint
	PreferredMailbox       *PreferredMailboxEndpoint
	// contains filtered or unexported fields
}

MailboxService is responsible for communication with the Mailbox endpoints of the Exact Online API.

func NewMailboxService

func NewMailboxService(apiClient *api.Client) *MailboxService

NewMailboxService creates a new initialized instance of the MailboxService.

type Mailboxes

type Mailboxes struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID: Primary key
	ID *types.GUID `json:"ID,omitempty"`

	// Account: The account this mailbox belongs to. Can be empty if the owner of the mailbox isn't an Exact Online customer yet
	Account *types.GUID `json:"Account,omitempty"`

	// AccountName: Name of Account
	AccountName *string `json:"AccountName,omitempty"`

	// Created: Creation date
	Created *types.Date `json:"Created,omitempty"`

	// Creator: User ID of creator
	Creator *types.GUID `json:"Creator,omitempty"`

	// CreatorFullName: Name of creator
	CreatorFullName *string `json:"CreatorFullName,omitempty"`

	// Description: Extra description of the mailbox
	Description *string `json:"Description,omitempty"`

	// ForDivision: Only used when this mailbox is used for one specific administration, for example invoices to this mailbox will only be booked in this administration
	ForDivision *int `json:"ForDivision,omitempty"`

	// ForDivisionDescription: Description of ForDivision
	ForDivisionDescription *string `json:"ForDivisionDescription,omitempty"`

	// Mailbox: E-mail address-like format, for example johndoe@exactonline.nl
	Mailbox *string `json:"Mailbox,omitempty"`

	// Modified: Last modified date
	Modified *types.Date `json:"Modified,omitempty"`

	// Modifier: User ID of modifier
	Modifier *types.GUID `json:"Modifier,omitempty"`

	// ModifierFullName: Name of modifier
	ModifierFullName *string `json:"ModifierFullName,omitempty"`

	// Publish: Customers can decide if they want this mailbox to be visible by all. i.e. some other customer can see this in address maintenance for digital postbox of type Exact
	Publish *byte `json:"Publish,omitempty"`

	// Type: Type of mailbox: 0-Unknown, 1-Exact, 2-Government, 3-Manual input
	Type *int `json:"Type,omitempty"`

	// ValidFrom: Date that this mailbox became valid
	ValidFrom *types.Date `json:"ValidFrom,omitempty"`

	// ValidTo: Date that this mailbox will not be valid anymore
	ValidTo *types.Date `json:"ValidTo,omitempty"`
}

Mailboxes: Service: Mailbox Entity: Mailboxes URL: /api/v1/{division}/mailbox/Mailboxes HasWebhook: false IsInBeta: false Methods: GET POST PUT DELETE Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=MailboxMailboxes

func (*Mailboxes) GetPrimary

func (e *Mailboxes) GetPrimary() *types.GUID

type MailboxesEndpoint

type MailboxesEndpoint service

MailboxesEndpoint is responsible for communicating with the Mailboxes endpoint of the Mailbox service.

func (*MailboxesEndpoint) Create

func (s *MailboxesEndpoint) Create(ctx context.Context, division int, entity *Mailboxes) (*Mailboxes, error)

Create the Mailboxes entity in the provided division.

func (*MailboxesEndpoint) Delete

func (s *MailboxesEndpoint) Delete(ctx context.Context, division int, id *types.GUID) error

Delete the Mailboxes entity in the provided division.

func (*MailboxesEndpoint) Get

func (s *MailboxesEndpoint) Get(ctx context.Context, division int, id *types.GUID) (*Mailboxes, error)

Get the Mailboxes entitiy in the provided division.

func (*MailboxesEndpoint) List

func (s *MailboxesEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*Mailboxes, error)

List the Mailboxes entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*MailboxesEndpoint) New

func (s *MailboxesEndpoint) New() *Mailboxes

New returns an empty Mailboxes entity

func (*MailboxesEndpoint) Update

func (s *MailboxesEndpoint) Update(ctx context.Context, division int, entity *Mailboxes) (*Mailboxes, error)

Update the Mailboxes entity in the provided division.

func (*MailboxesEndpoint) UserHasRights

func (s *MailboxesEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

type PreferredMailbox

type PreferredMailbox struct {
	MetaData *api.MetaData `json:"__metadata,omitempty"`
	// ID: Primary key
	ID *types.GUID `json:"ID,omitempty"`

	// Created: Creation date
	Created *types.Date `json:"Created,omitempty"`

	// Creator: User ID of creator
	Creator *types.GUID `json:"Creator,omitempty"`

	// Description: Extra description of the mailbox
	Description *string `json:"Description,omitempty"`

	// ForDivision: Only used when this mailbox is used for one specific administration, for example invoices to this mailbox will only be booked in this administration
	ForDivision *int `json:"ForDivision,omitempty"`

	// IsScanServiceMailbox: Indicates whether this service is used for messages returned by the scanning service
	IsScanServiceMailbox *bool `json:"IsScanServiceMailbox,omitempty"`

	// Mailbox: E-mail address-like format, for example johndoe@exactonline.nl
	Mailbox *string `json:"Mailbox,omitempty"`

	// Modified: Last modified date
	Modified *types.Date `json:"Modified,omitempty"`

	// Modifier: User ID of modifier
	Modifier *types.GUID `json:"Modifier,omitempty"`

	// ValidFrom: Date that this mailbox became valid
	ValidFrom *types.Date `json:"ValidFrom,omitempty"`

	// ValidTo: Date that this mailbox will not be valid anymore
	ValidTo *types.Date `json:"ValidTo,omitempty"`
}

PreferredMailbox: Service: Mailbox Entity: PreferredMailbox URL: /api/v1/{division}/read/mailbox/PreferredMailbox HasWebhook: false IsInBeta: false Methods: GET Endpoint docs: https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=ReadMailboxPreferredMailbox

func (*PreferredMailbox) GetPrimary

func (e *PreferredMailbox) GetPrimary() *types.GUID

type PreferredMailboxEndpoint

type PreferredMailboxEndpoint service

PreferredMailboxEndpoint is responsible for communicating with the PreferredMailbox endpoint of the Mailbox service.

func (*PreferredMailboxEndpoint) Get

Get the PreferredMailbox entitiy in the provided division.

func (*PreferredMailboxEndpoint) List

func (s *PreferredMailboxEndpoint) List(ctx context.Context, division int, all bool, o *api.ListOptions) ([]*PreferredMailbox, error)

List the PreferredMailbox entities in the provided division. If all is true, all the paginated results are fetched; if false, list the first page.

func (*PreferredMailboxEndpoint) UserHasRights

func (s *PreferredMailboxEndpoint) UserHasRights(ctx context.Context, division int, method string) (bool, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL