Class MimeMessage

Hierarchy (View Summary)

Bluestep.Mail.Message
- MimeMessage

Implements

MimePart

Constructors

constructor

new MimeMessage(): MimeMessage
Returns MimeMessage
Inherited from Message.constructor

Methods

addFrom

addFrom(address: Address[]): void
Parameters
- address: Address[]
Returns void
Inherited from Message.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
Implementation of MimePart.addHeader
Inherited from Message.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
Implementation of MimePart.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 Message.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
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11425

getAllHeaderLines

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

getAllHeaders

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

getAllRecipients

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

getContent

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

getContentID

getContentID(): string
Returns string
Implementation of MimePart.getContentID
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11412

getContentLanguage

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

getContentMD5

getContentMD5(): string
Returns string
Implementation of MimePart.getContentMD5
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11414

getContentType

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

getDataHandler

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

getDescription

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

getDisposition

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

getEncoding

getEncoding(): string
Returns string
Implementation of MimePart.getEncoding
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11415

getFileName

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

getFlags

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

getFrom

getFrom(): Address[]
Returns Address[]
- 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
Implementation of MimePart.getHeader
Overrides Message.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[]
Implementation of MimePart.getHeader
Overrides Message.getHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11424

getInputStream

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

getLineCount

getLineCount(): number
Returns number
Implementation of MimePart.getLineCount
Inherited from Message.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>
Implementation of MimePart.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>
Implementation of MimePart.getMatchingHeaders
Inherited from Message.getMatchingHeaders
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11392

getMessageID

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

getNonMatchingHeaderLines

getNonMatchingHeaderLines(names: string[]): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Implementation of MimePart.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>
Implementation of MimePart.getNonMatchingHeaders
Inherited from Message.getNonMatchingHeaders
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11393

getRawInputStream

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

getReceivedDate

getReceivedDate(): Date
Returns Date
- 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[]
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11432

getReplyTo

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

getSender

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

getSentDate

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

getSize

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

getSubject

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

isMimeType

isMimeType(mimeType: string): boolean
Parameters
- mimeType: string
Returns boolean
Implementation of MimePart.isMimeType
Inherited from Message.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
- 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
Implementation of MimePart.removeHeader
Inherited from Message.removeHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11396

saveChanges

saveChanges(): void
Returns void
- 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
Implementation of MimePart.setContent
Inherited from Message.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
Implementation of MimePart.setContent
Inherited from Message.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
Implementation of MimePart.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
Implementation of MimePart.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
Implementation of MimePart.setDataHandler
Inherited from Message.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
Implementation of MimePart.setDescription
Overrides Message.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
Implementation of MimePart.setDescription
Overrides Message.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
Implementation of MimePart.setDisposition
Inherited from Message.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
Implementation of MimePart.setFileName
Inherited from Message.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
- 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
- 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
Implementation of MimePart.setHeader
Inherited from Message.setHeader
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11403

setRecipients

setRecipients(type: RecipientType, addresses: string | Address[]): void
Parameters
- type: RecipientType
- addresses: string | Address[]
Returns void
- 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
- 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
- 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
- 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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.setText
Overrides Message.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
Implementation of MimePart.writeTo
Overrides Message.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
Implementation of MimePart.writeTo
Overrides Message.writeTo
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11451

Class MimeMessage

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Returns MimeMessage

Methods

addFrom

Parameters

Returns void

addHeader

Parameters

Returns void

addHeaderLine

Parameters

Returns void

addRecipient

Parameters

Returns void

addRecipients

Parameters

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

getLineCount

Returns number

getMatchingHeaderLines

Parameters

Returns Enumeration<string>

getMatchingHeaders

Parameters

Returns Enumeration<string>

getMessageID

Returns string

getNonMatchingHeaderLines

Parameters

Returns Enumeration<string>

getNonMatchingHeaders

Parameters

Returns Enumeration<string>

getRawInputStream

Returns InputStream