Class MessageSync

Hierarchy

UrlSection
- MessageSync

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageSync(prv: PathSegment, id?: string, service?: any): MessageSync

Overrides UrlSection.constructor
- Defined in paths/MessageSync.ts:5
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns MessageSync

Methods

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<GetMessageSyncResponse>

- Defined in paths/MessageSync.ts:13
Since 1.0.4 (Release 5.13)
Provides facilities to synchronize mailbox content stored externally with server state.
Required Permissions
Permission Description
ReadMessages Viewing user messages
Usage Plan Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<GetMessageSyncResponse>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc