Class GMailMessage

Hierarchy (View Summary)

IMAPMessage
- GMailMessage

Index

Constructors

Methods

addFrom addHeader addHeaderLine addRecipient addRecipients clearCachedLabels getAllHeaderLines getAllHeaders getAllRecipients getContent getContentID getContentLanguage getContentMD5 getContentType getDataHandler getDescription getDisposition getEncoding getFileName getFlags getFrom getHeader getInputStream getLabels getLineCount getMatchingHeaderLines getMatchingHeaders getMessageID getMimeStream getModSeq getMsgId getNonMatchingHeaderLines getNonMatchingHeaders getPeek getRawInputStream getReceivedDate getRecipients getReplyTo getSender getSentDate getSize getSizeLong getSubject getThrId isMimeType isSet removeHeader saveChanges setContent setContentLanguage setContentMD5 setDataHandler setDescription setDisposition setFileName setFlags setFrom setHeader setLabels setPeek setRecipients setSendDate setSender setSubject setText writeTo

Constructors

constructor

new GMailMessage(): GMailMessage
Returns GMailMessage
Inherited from IMAPMessage.constructor

Methods

addFrom

addFrom(address: Address[]): void
Parameters
- address: Address[]
Returns void
Inherited from IMAPMessage.addFrom
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11406

addHeader

addHeader(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
Inherited from IMAPMessage.addHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11381

addHeaderLine

addHeaderLine(line: string): void
Parameters
- line: string
Returns void
Inherited from IMAPMessage.addHeaderLine
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11410

addRecipient

addRecipient(type: RecipientType, address: Address): void
Parameters
- type: RecipientType
- address: Address
Returns void
Inherited from IMAPMessage.addRecipient
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11407

addRecipients

addRecipients(type: RecipientType, addresses: string | Address[]): void
Parameters
- type: RecipientType
- addresses: string | Address[]
Returns void
Inherited from IMAPMessage.addRecipients
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11425

clearCachedLabels

clearCachedLabels(): void
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8365

getAllHeaderLines

getAllHeaderLines(): Enumeration<string>
Returns Enumeration<string>
Inherited from IMAPMessage.getAllHeaderLines
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11411

getAllHeaders

getAllHeaders(): Enumeration<string>
Returns Enumeration<string>
Inherited from IMAPMessage.getAllHeaders
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11382

getAllRecipients

getAllRecipients(): Address[]
Returns Address[]
Inherited from IMAPMessage.getAllRecipients
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11426

getContent

getContent(): any
Returns any
Inherited from IMAPMessage.getContent
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11383

getContentID

getContentID(): string
Returns string
Inherited from IMAPMessage.getContentID
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11412

getContentLanguage

getContentLanguage(): string[]
Returns string[]
Inherited from IMAPMessage.getContentLanguage
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11413

getContentMD5

getContentMD5(): string
Returns string
Inherited from IMAPMessage.getContentMD5
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11414

getContentType

getContentType(): string
Returns string
Inherited from IMAPMessage.getContentType
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11385

getDataHandler

getDataHandler(): DataHandler
Returns DataHandler
Inherited from IMAPMessage.getDataHandler
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11384

getDescription

getDescription(): string
Returns string
Inherited from IMAPMessage.getDescription
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11386

getDisposition

getDisposition(): string
Returns string
Inherited from IMAPMessage.getDisposition
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11387

getEncoding

getEncoding(): string
Returns string
Inherited from IMAPMessage.getEncoding
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11415

getFileName

getFileName(): string
Returns string
Inherited from IMAPMessage.getFileName
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11388

getFlags

getFlags(): Flags
Returns Flags
Inherited from IMAPMessage.getFlags
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11427

getFrom

getFrom(): Address[]
Returns Address[]
Inherited from IMAPMessage.getFrom
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11428

getHeader

getHeader(name: string, delimiter: string): string
Parameters
- name: string
- delimiter: string
Returns string
Inherited from IMAPMessage.getHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11416
getHeader(name: string): string[]
Parameters
- name: string
Returns string[]
Inherited from IMAPMessage.getHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11424

getInputStream

getInputStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getInputStream
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11390

getLabels

getLabels(): string[]
Returns string[]
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8366

getLineCount

getLineCount(): number
Returns number
Inherited from IMAPMessage.getLineCount
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11391

getMatchingHeaderLines

getMatchingHeaderLines(names: string[]): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getMatchingHeaderLines
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11417

getMatchingHeaders

getMatchingHeaders(names: string[]): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getMatchingHeaders
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11392

getMessageID

getMessageID(): string
Returns string
Inherited from IMAPMessage.getMessageID
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11429

getMimeStream

getMimeStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getMimeStream
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8358

getModSeq

getModSeq(): number
Returns number
Inherited from IMAPMessage.getModSeq
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8359

getMsgId

getMsgId(): number
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8367

getNonMatchingHeaderLines

getNonMatchingHeaderLines(names: string[]): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getNonMatchingHeaderLines
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11418

getNonMatchingHeaders

getNonMatchingHeaders(names: string[]): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getNonMatchingHeaders
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11393

getPeek

getPeek(): boolean
Returns boolean
Inherited from IMAPMessage.getPeek
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8360

getRawInputStream

getRawInputStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getRawInputStream
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11430

getReceivedDate

getReceivedDate(): Date
Returns Date
Inherited from IMAPMessage.getReceivedDate
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11431

getRecipients

getRecipients(type: RecipientType): Address[]
Parameters
- type: RecipientType
Returns Address[]
Inherited from IMAPMessage.getRecipients
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11432

getReplyTo

getReplyTo(): Address[]
Returns Address[]
Inherited from IMAPMessage.getReplyTo
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11433

getSender

getSender(): Address
Returns Address
Inherited from IMAPMessage.getSender
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11434

getSentDate

getSentDate(): Date
Returns Date
Inherited from IMAPMessage.getSentDate
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11435

getSize

getSize(): number
Returns number
Inherited from IMAPMessage.getSize
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11394

getSizeLong

getSizeLong(): number
Returns number
Inherited from IMAPMessage.getSizeLong
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8361

getSubject

getSubject(): string
Returns string
Inherited from IMAPMessage.getSubject
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11436

getThrId

getThrId(): number
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8368

isMimeType

isMimeType(mimeType: string): boolean
Parameters
- mimeType: string
Returns boolean
Inherited from IMAPMessage.isMimeType
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11395

isSet

isSet(flag: FlagsFlag): boolean
Parameters
- flag: FlagsFlag
Returns boolean
Inherited from IMAPMessage.isSet
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11437

removeHeader

removeHeader(name: string): void
Parameters
- name: string
Returns void
Inherited from IMAPMessage.removeHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11396

saveChanges

saveChanges(): void
Returns void
Inherited from IMAPMessage.saveChanges
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11438

setContent

setContent(mp: Multipart): void
Parameters
- mp: Multipart
Returns void
Inherited from IMAPMessage.setContent
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11397
setContent(obj: any, type: string): void
Parameters
- obj: any
- type: string
Returns void
Inherited from IMAPMessage.setContent
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11398

setContentLanguage

setContentLanguage(languages: string[]): void
Parameters
- languages: string[]
Returns void
Inherited from IMAPMessage.setContentLanguage
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11419

setContentMD5

setContentMD5(md5: string): void
Parameters
- md5: string
Returns void
Inherited from IMAPMessage.setContentMD5
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11420

setDataHandler

setDataHandler(handler: DataHandler): void
Parameters
- handler: DataHandler
Returns void
Inherited from IMAPMessage.setDataHandler
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11399

setDescription

setDescription(description: string): void
Parameters
- description: string
Returns void
Inherited from IMAPMessage.setDescription
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11439
setDescription(description: string, charset: string): void
Parameters
- description: string
- charset: string
Returns void
Inherited from IMAPMessage.setDescription
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11440

setDisposition

setDisposition(disposition: string): void
Parameters
- disposition: string
Returns void
Inherited from IMAPMessage.setDisposition
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11401

setFileName

setFileName(filename: string): void
Parameters
- filename: string
Returns void
Inherited from IMAPMessage.setFileName
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11402

setFlags

setFlags(flag: Flags, set: boolean): void
Parameters
- flag: Flags
- set: boolean
Returns void
Inherited from IMAPMessage.setFlags
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11441

setFrom

setFrom(address?: string | Address): void
Parameters
- Optionaladdress: string | Address
Returns void
Inherited from IMAPMessage.setFrom
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11442

setHeader

setHeader(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
Inherited from IMAPMessage.setHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11403

setLabels

setLabels(labels: string, set: boolean): void
Parameters
- labels: string
- set: boolean
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8369

setPeek

setPeek(peek: boolean): void
Parameters
- peek: boolean
Returns void
Inherited from IMAPMessage.setPeek
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:8362

setRecipients

setRecipients(type: RecipientType, addresses: string | Address[]): void
Parameters
- type: RecipientType
- addresses: string | Address[]
Returns void
Inherited from IMAPMessage.setRecipients
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11443

setSendDate

setSendDate(date: Date): void
Parameters
- date: Date
Returns void
Inherited from IMAPMessage.setSendDate
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11445

setSender

setSender(address: Address): void
Parameters
- address: Address
Returns void
Inherited from IMAPMessage.setSender
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11444

setSubject

setSubject(subject: string, charset?: string): void
Parameters
- subject: string
- Optionalcharset: string
Returns void
Inherited from IMAPMessage.setSubject
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11446

setText

setText(text: string): void
Parameters
- text: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11421
setText(text: string, charset: string): void
Parameters
- text: string
- charset: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11422
setText(text: string, charset: string, subtype: string): void
Parameters
- text: string
- charset: string
- subtype: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11423
setText(text: string): void
Parameters
- text: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11447
setText(text: string, charset: string): void
Parameters
- text: string
- charset: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11448
setText(text: string, charset: string, subtype: string): void
Parameters
- text: string
- charset: string
- subtype: string
Returns void
Inherited from IMAPMessage.setText
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11449

writeTo

writeTo(os: OutputStream): void
Parameters
- os: OutputStream
Returns void
Inherited from IMAPMessage.writeTo
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11450
writeTo(os: OutputStream, ignoreList: string[]): void
Parameters
- os: OutputStream
- ignoreList: string[]
Returns void
Inherited from IMAPMessage.writeTo
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11451

Class GMailMessage

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns GMailMessage

Methods

addFrom

Parameters

Returns void

addHeader

Parameters

Returns void

addHeaderLine

Parameters

Returns void

addRecipient

Parameters

Returns void

addRecipients

Parameters

Returns void

clearCachedLabels

Returns void

getAllHeaderLines

Returns Enumeration<string>

getAllHeaders

Returns Enumeration<string>

getAllRecipients

Returns Address[]

getContent

Returns any

getContentID

Returns string

getContentLanguage

Returns string[]

getContentMD5

Returns string

getContentType

Returns string

getDataHandler

Returns DataHandler

getDescription

Returns string

getDisposition

Returns string

getEncoding

Returns string

getFileName

Returns string

getFlags

Returns Flags

getFrom

Returns Address[]

getHeader

Parameters

Returns string

Parameters

Returns string[]

getInputStream

Returns InputStream

getLabels

Returns string[]

getLineCount

Returns number

getMatchingHeaderLines

Parameters

Returns Enumeration<string>

getMatchingHeaders

Parameters

Returns Enumeration<string>

getMessageID

Returns string

getMimeStream

Returns InputStream

getModSeq

Returns number

getMsgId