Class ReadOnlyMailFolder

TODO

Example

TODO

Hierarchy

OpenMailFolder
- ReadOnlyMailFolder

Constructors

constructor

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

Methods

appendMessages

appendMessages(messages): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
Returns void
Inherited from OpenMailFolder.appendMessages
- Defined in B.d.ts:6957

copyMessages

copyMessages(messages, otherFolder): void
TODO
Parameters
- messages: Bluestep.Mail.Message[]
- otherFolder: MailFolder
Returns void
Inherited from OpenMailFolder.copyMessages
- Defined in B.d.ts:1565

createReadOnly

createReadOnly(): ReadOnlyMailFolder
TODO

Returns ReadOnlyMailFolder
Inherited from OpenMailFolder.createReadOnly
- Defined in B.d.ts:6962

createReadWriteOnly

createReadWriteOnly(): ReadWriteMailFolder
TODO

Returns ReadWriteMailFolder
Inherited from OpenMailFolder.createReadWriteOnly
- Defined in B.d.ts:6967

deletedMessageCount

deletedMessageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.deletedMessageCount
- Defined in B.d.ts:6972

exists

exists(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.exists
- Defined in B.d.ts:6977

expunge

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

Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.expunge
- Defined in B.d.ts:1570

folder

folder(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from OpenMailFolder.folder
- Defined in B.d.ts:6982

fullName

fullName(): string
TODO

Returns string
Inherited from OpenMailFolder.fullName
- Defined in B.d.ts:6987

getMessage

getMessage(msgNum): Bluestep.Mail.Message
TODO
Parameters
- msgNum: number
Returns Bluestep.Mail.Message
Inherited from OpenMailFolder.getMessage
- Defined in B.d.ts:1576

getMode

getMode(): number
TODO

Returns number
Inherited from OpenMailFolder.getMode
- Defined in B.d.ts:1599

hasNewMessages

hasNewMessages(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.hasNewMessages
- Defined in B.d.ts:6992

isOpen

isOpen(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.isOpen
- Defined in B.d.ts:6997

isSubscribed

isSubscribed(): boolean
TODO

Returns boolean
Inherited from OpenMailFolder.isSubscribed
- Defined in B.d.ts:7002

list

list(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from OpenMailFolder.list
- Defined in B.d.ts:7007
list(pattern): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from OpenMailFolder.list
- Defined in B.d.ts:7013

listSubscribed

listSubscribed(): ClosedMailFolder[]
TODO

Returns ClosedMailFolder[]
Inherited from OpenMailFolder.listSubscribed
- Defined in B.d.ts:7018
listSubscribed(pattern): ClosedMailFolder[]
TODO
Parameters
- pattern: string
Returns ClosedMailFolder[]
Inherited from OpenMailFolder.listSubscribed
- Defined in B.d.ts:7024

messageCount

messageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.messageCount
- Defined in B.d.ts:7029

messages

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

Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in B.d.ts:1581
messages(msgNums): Bluestep.Mail.Message[]
TODO
Parameters
- msgNums: number[]
Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in B.d.ts:1587
messages(start, end): Bluestep.Mail.Message[]
TODO
Parameters
- start: number
- end: number
Returns Bluestep.Mail.Message[]
Inherited from OpenMailFolder.messages
- Defined in B.d.ts:1594

name

name(): string
TODO

Returns string
Inherited from OpenMailFolder.name
- Defined in B.d.ts:7034

parent

parent(): ClosedMailFolder
TODO

Returns ClosedMailFolder
Inherited from OpenMailFolder.parent
- Defined in B.d.ts:7039

permanentFlags

permanentFlags(): Flags
TODO

Returns Flags
Inherited from OpenMailFolder.permanentFlags
- Defined in B.d.ts:7044

separator

separator(): string
TODO

Returns string
Inherited from OpenMailFolder.separator
- Defined in B.d.ts:7049

subscribe(subscribe): void
TODO
Parameters
- subscribe: boolean
Returns void
Inherited from OpenMailFolder.subscribe
- Defined in B.d.ts:7055

type

type(): number
TODO

Returns number
Inherited from OpenMailFolder.type
- Defined in B.d.ts:7060

unreadMessageCount

unreadMessageCount(): number
TODO

Returns number
Inherited from OpenMailFolder.unreadMessageCount
- Defined in B.d.ts:7065

url

url(): string
TODO

Returns string
Inherited from OpenMailFolder.url
- Defined in B.d.ts:7070

Class ReadOnlyMailFolder

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns ReadOnlyMailFolder

Methods

appendMessages

Parameters

messages: Bluestep.Mail.Message[]

Returns void

copyMessages

Parameters

messages: Bluestep.Mail.Message[]

otherFolder: MailFolder

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

msgNum: number

Returns Bluestep.Mail.Message

getMode

Returns number

hasNewMessages

Returns boolean

isOpen

Returns boolean

isSubscribed

Returns boolean

list

Returns ClosedMailFolder[]

Parameters

pattern: string

Returns ClosedMailFolder[]

listSubscribed

Returns ClosedMailFolder[]

Parameters

pattern: string

Returns ClosedMailFolder[]

messageCount

Returns number

messages

Returns Bluestep.Mail.Message[]

Parameters

msgNums: number[]

Returns Bluestep.Mail.Message[]

Parameters

start: number

end: number

Returns Bluestep.Mail.Message[]

name

Returns string

parent

Returns ClosedMailFolder

permanentFlags

Returns Flags

separator

Returns string

subscribe

Parameters

subscribe: boolean

Returns void

type

Returns number