Class GMailMessage

Hierarchy

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): void
Parameters
- address: Address[]
Returns void
Inherited from IMAPMessage.addFrom
- Defined in B.d.ts:2030

addHeader

addHeader(name, value): void
Parameters
- name: string
- value: string
Returns void
Inherited from IMAPMessage.addHeader
- Defined in B.d.ts:2005

addHeaderLine

addHeaderLine(line): void
Parameters
- line: string
Returns void
Inherited from IMAPMessage.addHeaderLine
- Defined in B.d.ts:2034

addRecipient

addRecipient(type, address): void
Parameters
- type: RecipientType
- address: Address
Returns void
Inherited from IMAPMessage.addRecipient
- Defined in B.d.ts:2031

addRecipients

addRecipients(type, addresses): void
Parameters
- type: RecipientType
- addresses: string | Address[]
Returns void
Inherited from IMAPMessage.addRecipients
- Defined in B.d.ts:2049

clearCachedLabels

clearCachedLabels(): void
Returns void
- Defined in B.d.ts:8151

getAllHeaderLines

getAllHeaderLines(): Enumeration<string>
Returns Enumeration<string>
Inherited from IMAPMessage.getAllHeaderLines
- Defined in B.d.ts:2035

getAllHeaders

getAllHeaders(): Enumeration<string>
Returns Enumeration<string>
Inherited from IMAPMessage.getAllHeaders
- Defined in B.d.ts:2006

getAllRecipients

getAllRecipients(): Address[]
Returns Address[]
Inherited from IMAPMessage.getAllRecipients
- Defined in B.d.ts:2050

getContent

getContent(): any
Returns any
Inherited from IMAPMessage.getContent
- Defined in B.d.ts:2007

getContentID

getContentID(): string
Returns string
Inherited from IMAPMessage.getContentID
- Defined in B.d.ts:2036

getContentLanguage

getContentLanguage(): string[]
Returns string[]
Inherited from IMAPMessage.getContentLanguage
- Defined in B.d.ts:2037

getContentMD5

getContentMD5(): string
Returns string
Inherited from IMAPMessage.getContentMD5
- Defined in B.d.ts:2038

getContentType

getContentType(): string
Returns string
Inherited from IMAPMessage.getContentType
- Defined in B.d.ts:2009

getDataHandler

getDataHandler(): DataHandler
Returns DataHandler
Inherited from IMAPMessage.getDataHandler
- Defined in B.d.ts:2008

getDescription

getDescription(): string
Returns string
Inherited from IMAPMessage.getDescription
- Defined in B.d.ts:2010

getDisposition

getDisposition(): string
Returns string
Inherited from IMAPMessage.getDisposition
- Defined in B.d.ts:2011

getEncoding

getEncoding(): string
Returns string
Inherited from IMAPMessage.getEncoding
- Defined in B.d.ts:2039

getFileName

getFileName(): string
Returns string
Inherited from IMAPMessage.getFileName
- Defined in B.d.ts:2012

getFlags

getFlags(): Flags
Returns Flags
Inherited from IMAPMessage.getFlags
- Defined in B.d.ts:2051

getFrom

getFrom(): Address[]
Returns Address[]
Inherited from IMAPMessage.getFrom
- Defined in B.d.ts:2052

getHeader

getHeader(name, delimiter): string
Parameters
- name: string
- delimiter: string
Returns string
Inherited from IMAPMessage.getHeader
- Defined in B.d.ts:2040
getHeader(name): string[]
Parameters
- name: string
Returns string[]
Inherited from IMAPMessage.getHeader
- Defined in B.d.ts:2048

getInputStream

getInputStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getInputStream
- Defined in B.d.ts:2014

getLabels

getLabels(): string[]
Returns string[]
- Defined in B.d.ts:8152

getLineCount

getLineCount(): number
Returns number
Inherited from IMAPMessage.getLineCount
- Defined in B.d.ts:2015

getMatchingHeaderLines

getMatchingHeaderLines(names): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getMatchingHeaderLines
- Defined in B.d.ts:2041

getMatchingHeaders

getMatchingHeaders(names): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getMatchingHeaders
- Defined in B.d.ts:2016

getMessageID

getMessageID(): string
Returns string
Inherited from IMAPMessage.getMessageID
- Defined in B.d.ts:2053

getMimeStream

getMimeStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getMimeStream
- Defined in B.d.ts:8144

getModSeq

getModSeq(): number
Returns number
Inherited from IMAPMessage.getModSeq
- Defined in B.d.ts:8145

getMsgId

getMsgId(): number
Returns number
- Defined in B.d.ts:8153

getNonMatchingHeaderLines

getNonMatchingHeaderLines(names): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getNonMatchingHeaderLines
- Defined in B.d.ts:2042

getNonMatchingHeaders

getNonMatchingHeaders(names): Enumeration<string>
Parameters
- names: string[]
Returns Enumeration<string>
Inherited from IMAPMessage.getNonMatchingHeaders
- Defined in B.d.ts:2017

getPeek

getPeek(): boolean
Returns boolean
Inherited from IMAPMessage.getPeek
- Defined in B.d.ts:8146

getRawInputStream

getRawInputStream(): InputStream
Returns InputStream
Inherited from IMAPMessage.getRawInputStream
- Defined in B.d.ts:2054

getReceivedDate

getReceivedDate(): Date
Returns Date
Inherited from IMAPMessage.getReceivedDate
- Defined in B.d.ts:2055

getRecipients

getRecipients(type): Address[]
Parameters
- type: RecipientType
Returns Address[]
Inherited from IMAPMessage.getRecipients
- Defined in B.d.ts:2056

getReplyTo

getReplyTo(): Address[]
Returns Address[]
Inherited from IMAPMessage.getReplyTo
- Defined in B.d.ts:2057

getSender

getSender(): Address
Returns Address
Inherited from IMAPMessage.getSender
- Defined in B.d.ts:2058

getSentDate

getSentDate(): Date
Returns Date
Inherited from IMAPMessage.getSentDate
- Defined in B.d.ts:2059

getSize

getSize(): number
Returns number
Inherited from IMAPMessage.getSize
- Defined in B.d.ts:2018

getSizeLong

getSizeLong(): number
Returns number
Inherited from IMAPMessage.getSizeLong
- Defined in B.d.ts:8147

getSubject

getSubject(): string
Returns string
Inherited from IMAPMessage.getSubject
- Defined in B.d.ts:2060

getThrId

getThrId(): number
Returns number
- Defined in B.d.ts:8154

isMimeType

isMimeType(mimeType): boolean
Parameters
- mimeType: string
Returns boolean
Inherited from IMAPMessage.isMimeType
- Defined in B.d.ts:2019

isSet

isSet(flag): boolean
Parameters
- flag: FlagsFlag
Returns boolean
Inherited from IMAPMessage.isSet
- Defined in B.d.ts:2061

removeHeader

removeHeader(name): void
Parameters
- name: string
Returns void
Inherited from IMAPMessage.removeHeader
- Defined in B.d.ts:2020

saveChanges

saveChanges(): void
Returns void
Inherited from IMAPMessage.saveChanges
- Defined in B.d.ts:2062

setContent

setContent(mp): void
Parameters
- mp: Multipart
Returns void
Inherited from IMAPMessage.setContent
- Defined in B.d.ts:2021
setContent(obj, type): void
Parameters
- obj: any
- type: string
Returns void
Inherited from IMAPMessage.setContent
- Defined in B.d.ts:2022

setContentLanguage

setContentLanguage(languages): void
Parameters
- languages: string[]
Returns void
Inherited from IMAPMessage.setContentLanguage
- Defined in B.d.ts:2043

setContentMD5

setContentMD5(md5): void
Parameters
- md5: string
Returns void
Inherited from IMAPMessage.setContentMD5
- Defined in B.d.ts:2044

setDataHandler

setDataHandler(handler): void
Parameters
- handler: DataHandler
Returns void
Inherited from IMAPMessage.setDataHandler
- Defined in B.d.ts:2023

setDescription

setDescription(description): void
Parameters
- description: string
Returns void
Inherited from IMAPMessage.setDescription
- Defined in B.d.ts:2063
setDescription(description, charset): void
Parameters
- description: string
- charset: string
Returns void
Inherited from IMAPMessage.setDescription
- Defined in B.d.ts:2064

setDisposition

setDisposition(disposition): void
Parameters
- disposition: string
Returns void
Inherited from IMAPMessage.setDisposition
- Defined in B.d.ts:2025

setFileName

setFileName(filename): void
Parameters
- filename: string
Returns void
Inherited from IMAPMessage.setFileName
- Defined in B.d.ts:2026

setFlags

setFlags(flag, set): void
Parameters
- flag: Flags
- set: boolean
Returns void
Inherited from IMAPMessage.setFlags
- Defined in B.d.ts:2065

setFrom

setFrom(address?): void
Parameters
- Optional address: string | Address
Returns void
Inherited from IMAPMessage.setFrom
- Defined in B.d.ts:2066

setHeader

setHeader(name, value): void
Parameters
- name: string
- value: string
Returns void
Inherited from IMAPMessage.setHeader
- Defined in B.d.ts:2027

setLabels

setLabels(labels, set): void
Parameters
- labels: string
- set: boolean
Returns void
- Defined in B.d.ts:8155

setPeek

setPeek(peek): void
Parameters
- peek: boolean
Returns void
Inherited from IMAPMessage.setPeek
- Defined in B.d.ts:8148

setRecipients

setRecipients(type, addresses): void
Parameters
- type: RecipientType
- addresses: string | Address[]
Returns void
Inherited from IMAPMessage.setRecipients
- Defined in B.d.ts:2067

setSendDate

setSendDate(date): void
Parameters
- date: Date
Returns void
Inherited from IMAPMessage.setSendDate
- Defined in B.d.ts:2069

setSender

setSender(address): void
Parameters
- address: Address
Returns void
Inherited from IMAPMessage.setSender
- Defined in B.d.ts:2068

setSubject

setSubject(subject, charset?): void
Parameters
- subject: string
- Optional charset: string
Returns void
Inherited from IMAPMessage.setSubject
- Defined in B.d.ts:2070

setText

setText(text): void
Parameters
- text: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2045
setText(text, charset): void
Parameters
- text: string
- charset: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2046
setText(text, charset, subtype): void
Parameters
- text: string
- charset: string
- subtype: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2047
setText(text): void
Parameters
- text: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2071
setText(text, charset): void
Parameters
- text: string
- charset: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2072
setText(text, charset, subtype): void
Parameters
- text: string
- charset: string
- subtype: string
Returns void
Inherited from IMAPMessage.setText
- Defined in B.d.ts:2073

writeTo

writeTo(os): void
Parameters
- os: OutputStream
Returns void
Inherited from IMAPMessage.writeTo
- Defined in B.d.ts:2074
writeTo(os, ignoreList): void
Parameters
- os: OutputStream
- ignoreList: string[]
Returns void
Inherited from IMAPMessage.writeTo
- Defined in B.d.ts:2075

Generated using TypeDoc