import Message from 'magister.js/src/message.js'

public class | source

Message

Extends:

MagisterThing → Message

Constructor Summary

Public Constructor
public	constructor(magister: Magister, raw: Object)

Member Summary

Public Members
public	attachments: File[] This will be `undefined` per default, a fill using fill is required to retrieve the attachments for this Message.
public	begin: Date
public	body: String If creating a message, this will be an empty string per default.
public	end: Date
public	folderId: String
public	id: String
public	isFlagged: Boolean
public	isRead: Boolean
public	recipients: Person[]
public	sendDate: Date
public	sender: Person
public	state: Number
public	subject: String
public	summary: String
public get	type: string

Method Summary

Public Methods
public	addRecipient(recipients: Person \| Person[])
public	createForwardMessage(content: string): *
public	createReplyMessage(content: string): *
public	createReplyToAllMessage(content: string): *
public	fill(fillPersons: boolean): Promise<Message>
public	move(destination: ):
public	remove(): Promise<Error\|undefined>
public	saveChanges(): Promise<undefined> Update the server to reflect the changes made on the properties of this Message instance.
public	send(): Promise<Message>
public	toString(): *

Inherited Summary

From class MagisterThing
public	toJSON(): Object

Public Constructors

public constructor(magister: Magister, raw: Object) source

Params:

Name	Type	Attribute	Description
magister	Magister		The Magister object you want to send this message from.
raw	Object	optional	Not needed, only used internally.

Public Members

public attachments: File[] source

This will be undefined per default, a fill using fill is required to retrieve the attachments for this Message.

public begin: Date source

public body: String source

If creating a message, this will be an empty string per default. When retrieving a message from Magister, this will be undefined per default, you should use fill to get the body.

public end: Date source

public folderId: String source

public id: String source

public isFlagged: Boolean source

public isRead: Boolean source

public recipients: Person[] source

public sendDate: Date source

public sender: Person source

public state: Number source

public subject: String source

public summary: String source

public get type: string source

Public Methods

public addRecipient(recipients: Person | Person[]) source

Params:

Name	Type	Attribute	Description
recipients	Person \| Person[]

public createForwardMessage(content: string): * source

Params:

Name	Type	Attribute	Description
content	string	optional default:

Return:

public createReplyMessage(content: string): * source

Params:

Name	Type	Attribute	Description
content	string	optional default:

Return:

public createReplyToAllMessage(content: string): * source

Params:

Name	Type	Attribute	Description
content	string	optional default:

Return:

public fill(fillPersons: boolean): Promise<Message> source

Params:

Name	Type	Attribute	Description
fillPersons	boolean	optional default: false

Return:

Promise<Message>

public move(destination: ): source

Params:

Name	Type	Attribute	Description
destination	*

Return:

public remove(): Promise<Error|undefined> source

Return:

Promise<Error|undefined>

public saveChanges(): Promise<undefined> source

Update the server to reflect the changes made on the properties of this Message instance.

Message

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(magister: Magister, raw: Object) source

Params:

Public Members

public attachments: File[] source

public begin: Date source

public body: String source

public end: Date source

public folderId: String source

public id: String source

public isFlagged: Boolean source

public isRead: Boolean source

public recipients: Person[] source

public sendDate: Date source

public sender: Person source

public state: Number source

public subject: String source

public summary: String source

public get type: string source

Public Methods

public addRecipient(recipients: Person | Person[]) source

Params:

public createForwardMessage(content: string): * source

Params:

Return:

public createReplyMessage(content: string): * source

Params:

Return:

public createReplyToAllMessage(content: string): * source

Params:

Return:

public fill(fillPersons: boolean): Promise<Message> source

Params:

Return:

public move(destination: *): * source

Params:

Return:

public remove(): Promise<Error|undefined> source

Return:

public saveChanges(): Promise<undefined> source

Return:

public send(): Promise<Message> source

Return:

public toString(): * source

Return:

public move(destination: ): source