Class OpenMailFolder

TODO

Example

TODO

Hierarchy (View Summary)

MailFolder
- OpenMailFolder
  - ReadWriteMailFolder
  - ReadOnlyMailFolder

Constructors

constructor

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

Methods

appendMessages

appendMessages(messages: Bluestep.Mail.Message[]): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
Returns void
Inherited from MailFolder.appendMessages
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7147

copyMessages

copyMessages(messages: Bluestep.Mail.Message[], otherFolder: MailFolder): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
- otherFolder: MailFolder
Returns void
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1570

createReadOnly

createReadOnly(): ReadOnlyMailFolder
TODO

Returns ReadOnlyMailFolder
Inherited from MailFolder.createReadOnly
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7152

createReadWriteOnly

createReadWriteOnly(): ReadWriteMailFolder
TODO

Returns ReadWriteMailFolder
Inherited from MailFolder.createReadWriteOnly
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7157

deletedMessageCount

deletedMessageCount(): number
TODO

Returns number
Inherited from MailFolder.deletedMessageCount
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7162

exists

exists(): boolean
TODO

Returns boolean
Inherited from MailFolder.exists
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7167

expunge

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

Returns Bluestep.Mail.Message[]
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1575

folder

folder(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from MailFolder.folder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7172

fullName

fullName(): string
TODO

Returns string
Inherited from MailFolder.fullName
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7177

getMessage

getMessage(msgNum: number): Bluestep.Mail.Message
TODO
Parameters
- msgNum: number
Returns Bluestep.Mail.Message
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1581

getMode

getMode(): number
TODO

Returns number
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1604

hasNewMessages

hasNewMessages(): boolean
TODO

Returns boolean
Inherited from MailFolder.hasNewMessages
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7182

isOpen

isOpen(): boolean
TODO

Returns boolean
Inherited from MailFolder.isOpen
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7187

isSubscribed

isSubscribed(): boolean
TODO

Returns boolean
Inherited from MailFolder.isSubscribed
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7192

list

list(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from MailFolder.list
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7197
list(pattern: string): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from MailFolder.list
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7203

listSubscribed

listSubscribed(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from MailFolder.listSubscribed
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7208
listSubscribed(pattern: string): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from MailFolder.listSubscribed
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7214

messageCount

messageCount(): number
TODO

Returns number
Inherited from MailFolder.messageCount
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7219

messages

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

Returns Bluestep.Mail.Message[]
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1586
messages(msgNums: number[]): Bluestep.Mail.Message[]
TODO
Parameters
- msgNums: number[]
Returns Bluestep.Mail.Message[]
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1592
messages(start: number, end: number): Bluestep.Mail.Message[]
TODO
Parameters
- start: number
- end: number
Returns Bluestep.Mail.Message[]
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1599

name

name(): string
TODO

Returns string
Inherited from MailFolder.name
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7224

parent

parent(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from MailFolder.parent
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7229

permanentFlags

permanentFlags(): Flags
TODO

Returns Flags
Inherited from MailFolder.permanentFlags
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7234

separator

separator(): string
TODO

Returns string
Inherited from MailFolder.separator
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7239

subscribe(subscribe: boolean): void
TODO
Parameters
- subscribe: boolean
Returns void
Inherited from MailFolder.subscribe
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7245

type

type(): number
TODO

Returns number
Inherited from MailFolder.type
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7250

unreadMessageCount

unreadMessageCount(): number
TODO

Returns number
Inherited from MailFolder.unreadMessageCount
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7255

url

url(): string
TODO

Returns string
Inherited from MailFolder.url
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:7260

Class OpenMailFolder

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns OpenMailFolder

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

subscribe

Parameters

Returns void

type

Returns number

unreadMessageCount

Returns number

url

Returns string

Settings

On This Page