Class ReadWriteMailFolder

TODO

Example

TODO

Hierarchy (View Summary)

OpenMailFolder
- ReadWriteMailFolder

Constructors

constructor

new ReadWriteMailFolder(): ReadWriteMailFolder
Returns ReadWriteMailFolder
Inherited from OpenMailFolder.constructor

Methods

appendMessages

appendMessages(messages: Bluestep.Mail.Message[]): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
Returns void
Inherited from OpenMailFolder.appendMessages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5003

copyMessages

copyMessages(messages: Bluestep.Mail.Message[], otherFolder: MailFolder): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
- otherFolder: MailFolder
Returns void
Inherited from OpenMailFolder.copyMessages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12805

createReadOnly

createReadOnly(): ReadOnlyMailFolder
TODO

Returns ReadOnlyMailFolder
Inherited from OpenMailFolder.createReadOnly
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5008

createReadWriteOnly

createReadWriteOnly(): ReadWriteMailFolder
TODO

Returns ReadWriteMailFolder
Inherited from OpenMailFolder.createReadWriteOnly
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5013

deletedMessageCount

deletedMessageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.deletedMessageCount
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5018

exists

exists(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.exists
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5023

expunge

expunge(): Bluestep.Mail.Message[]
TODO

Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.expunge
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12810

folder

folder(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from OpenMailFolder.folder
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5028

fullName

fullName(): string
TODO

Returns string
Inherited from OpenMailFolder.fullName
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5033

getMessage

getMessage(msgNum: number): Bluestep.Mail.Message
TODO
Parameters
- msgNum: number
Returns Bluestep.Mail.Message
Inherited from OpenMailFolder.getMessage
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12816

getMode

getMode(): number
TODO

Returns number
Inherited from OpenMailFolder.getMode
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12839

hasNewMessages

hasNewMessages(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.hasNewMessages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5038

isOpen

isOpen(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.isOpen
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5043

isSubscribed

isSubscribed(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.isSubscribed
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5048

list

list(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from OpenMailFolder.list
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5053
list(pattern: string): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from OpenMailFolder.list
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5059

listSubscribed

listSubscribed(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from OpenMailFolder.listSubscribed
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5064
listSubscribed(pattern: string): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from OpenMailFolder.listSubscribed
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5070

messageCount

messageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.messageCount
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5075

messages

messages(): Bluestep.Mail.Message[]
TODO

Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12821
messages(msgNums: number[]): Bluestep.Mail.Message[]
TODO
Parameters
- msgNums: number[]
Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12827
messages(start: number, end: number): Bluestep.Mail.Message[]
TODO
Parameters
- start: number
- end: number
Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12834

name

name(): string
TODO

Returns string
Inherited from OpenMailFolder.name
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5080

parent

parent(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from OpenMailFolder.parent
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5085

permanentFlags

permanentFlags(): Flags
TODO

Returns Flags
Inherited from OpenMailFolder.permanentFlags
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5090

separator

separator(): string
TODO

Returns string
Inherited from OpenMailFolder.separator
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5095

setFlags

setFlags(msgNums: number[], flags: Flags, value: boolean): void
TODO
Parameters
- msgNums: number[]
- flags: Flags
- value: boolean
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:13611
setFlags(start: number, end: number, flags: Flags, value: boolean): void
TODO
Parameters
- start: number
- end: number
- flags: Flags
- value: boolean
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:13620
setFlags(
    messages: Bluestep.Mail.Message[],
    end: number,
    flags: Flags,
    value: boolean,
): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
- end: number
- flags: Flags
- value: boolean
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:13629

subscribe(subscribe: boolean): void
TODO
Parameters
- subscribe: boolean
Returns void
Inherited from OpenMailFolder.subscribe
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5101

type

type(): number
TODO

Returns number
Inherited from OpenMailFolder.type
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5106

unreadMessageCount

unreadMessageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.unreadMessageCount
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5111

url

url(): string
TODO

Returns string
Inherited from OpenMailFolder.url
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:5116

Class ReadWriteMailFolder

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns ReadWriteMailFolder

Methods

appendMessages

Parameters

Returns void

copyMessages

Parameters

Returns void

createReadOnly

Returns ReadOnlyMailFolder

createReadWriteOnly

Returns ReadWriteMailFolder

deletedMessageCount

Returns number

exists

Returns boolean

expunge

Returns Bluestep.Mail.Message[]

folder

Returns ClosedMailFolder

fullName

Returns string

getMessage

Parameters

Returns Bluestep.Mail.Message

getMode

Returns number

hasNewMessages

Returns boolean

isOpen

Returns boolean

isSubscribed

Returns boolean

list

Returns ClosedMailFolder[]

Parameters

Returns ClosedMailFolder[]

listSubscribed

Returns ClosedMailFolder[]

Parameters

Returns ClosedMailFolder[]

messageCount

Returns number

messages

Returns Bluestep.Mail.Message[]

Parameters

Returns Bluestep.Mail.Message[]

Parameters

Returns Bluestep.Mail.Message[]

name

Returns string

parent

Returns ClosedMailFolder

permanentFlags

Returns Flags

separator

Returns string

setFlags

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

subscribe

Parameters

Returns void

type

Returns number

unreadMessageCount

Returns number

url