Google Apps Script API
Preparing search index...
google-apps-script-events
GoogleAppsScript
Gmail
GmailMessage
Interface GmailMessage
A message in a user's Gmail account.
interface
GmailMessage
{
createDraftReply
(
body
:
string
)
:
GmailDraft
;
createDraftReply
(
body
:
string
,
options
:
GmailReplyOptions
)
:
GmailDraft
;
createDraftReplyAll
(
body
:
string
)
:
GmailDraft
;
createDraftReplyAll
(
body
:
string
,
options
:
GmailReplyOptions
)
:
GmailDraft
;
forward
(
recipient
:
string
)
:
GmailMessage
;
forward
(
recipient
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
;
getAttachments
()
:
GmailAttachment
[]
;
getAttachments
(
options
:
GmailAttachmentOptions
)
:
GmailAttachment
[]
;
getBcc
()
:
string
;
getBody
()
:
string
;
getCc
()
:
string
;
getDate
()
:
GoogleAppsScript
.
Base
.
Date
;
getFrom
()
:
string
;
getHeader
(
name
:
string
)
:
string
;
getId
()
:
string
;
getPlainBody
()
:
string
;
getRawContent
()
:
string
;
getReplyTo
()
:
string
;
getSubject
()
:
string
;
getThread
()
:
GmailThread
;
getTo
()
:
string
;
isDraft
()
:
boolean
;
isInChats
()
:
boolean
;
isInInbox
()
:
boolean
;
isInPriorityInbox
()
:
boolean
;
isInTrash
()
:
boolean
;
isStarred
()
:
boolean
;
isUnread
()
:
boolean
;
markRead
()
:
GmailMessage
;
markUnread
()
:
GmailMessage
;
moveToTrash
()
:
GmailMessage
;
refresh
()
:
GmailMessage
;
reply
(
body
:
string
)
:
GmailMessage
;
reply
(
body
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
;
replyAll
(
body
:
string
)
:
GmailMessage
;
replyAll
(
body
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
;
star
()
:
GmailMessage
;
unstar
()
:
GmailMessage
;
}
Index
Methods
create
Draft
Reply
create
Draft
Reply
All
forward
get
Attachments
get
Bcc
get
Body
get
Cc
get
Date
get
From
get
Header
get
Id
get
Plain
Body
get
Raw
Content
get
Reply
To
get
Subject
get
Thread
get
To
is
Draft
is
In
Chats
is
In
Inbox
is
In
Priority
Inbox
is
In
Trash
is
Starred
is
Unread
mark
Read
mark
Unread
move
To
Trash
refresh
reply
reply
All
star
unstar
Methods
create
Draft
Reply
createDraftReply
(
body
:
string
)
:
GmailDraft
Parameters
body
:
string
Returns
GmailDraft
createDraftReply
(
body
:
string
,
options
:
GmailReplyOptions
)
:
GmailDraft
Parameters
body
:
string
options
:
GmailReplyOptions
Returns
GmailDraft
create
Draft
Reply
All
createDraftReplyAll
(
body
:
string
)
:
GmailDraft
Parameters
body
:
string
Returns
GmailDraft
createDraftReplyAll
(
body
:
string
,
options
:
GmailReplyOptions
)
:
GmailDraft
Parameters
body
:
string
options
:
GmailReplyOptions
Returns
GmailDraft
forward
forward
(
recipient
:
string
)
:
GmailMessage
Parameters
recipient
:
string
Returns
GmailMessage
forward
(
recipient
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
Parameters
recipient
:
string
options
:
GmailAdvancedOptions
Returns
GmailMessage
get
Attachments
getAttachments
()
:
GmailAttachment
[]
Returns
GmailAttachment
[]
getAttachments
(
options
:
GmailAttachmentOptions
)
:
GmailAttachment
[]
Parameters
options
:
GmailAttachmentOptions
Returns
GmailAttachment
[]
get
Bcc
getBcc
()
:
string
Returns
string
get
Body
getBody
()
:
string
Returns
string
get
Cc
getCc
()
:
string
Returns
string
get
Date
getDate
()
:
GoogleAppsScript
.
Base
.
Date
Returns
GoogleAppsScript
.
Base
.
Date
get
From
getFrom
()
:
string
Returns
string
get
Header
getHeader
(
name
:
string
)
:
string
Parameters
name
:
string
Returns
string
get
Id
getId
()
:
string
Returns
string
get
Plain
Body
getPlainBody
()
:
string
Returns
string
get
Raw
Content
getRawContent
()
:
string
Returns
string
get
Reply
To
getReplyTo
()
:
string
Returns
string
get
Subject
getSubject
()
:
string
Returns
string
get
Thread
getThread
()
:
GmailThread
Returns
GmailThread
get
To
getTo
()
:
string
Returns
string
is
Draft
isDraft
()
:
boolean
Returns
boolean
is
In
Chats
isInChats
()
:
boolean
Returns
boolean
is
In
Inbox
isInInbox
()
:
boolean
Returns
boolean
is
In
Priority
Inbox
isInPriorityInbox
()
:
boolean
Returns
boolean
is
In
Trash
isInTrash
()
:
boolean
Returns
boolean
is
Starred
isStarred
()
:
boolean
Returns
boolean
is
Unread
isUnread
()
:
boolean
Returns
boolean
mark
Read
markRead
()
:
GmailMessage
Returns
GmailMessage
mark
Unread
markUnread
()
:
GmailMessage
Returns
GmailMessage
move
To
Trash
moveToTrash
()
:
GmailMessage
Returns
GmailMessage
refresh
refresh
()
:
GmailMessage
Returns
GmailMessage
reply
reply
(
body
:
string
)
:
GmailMessage
Parameters
body
:
string
Returns
GmailMessage
reply
(
body
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
Parameters
body
:
string
options
:
GmailAdvancedOptions
Returns
GmailMessage
reply
All
replyAll
(
body
:
string
)
:
GmailMessage
Parameters
body
:
string
Returns
GmailMessage
replyAll
(
body
:
string
,
options
:
GmailAdvancedOptions
)
:
GmailMessage
Parameters
body
:
string
options
:
GmailAdvancedOptions
Returns
GmailMessage
star
star
()
:
GmailMessage
Returns
GmailMessage
unstar
unstar
()
:
GmailMessage
Returns
GmailMessage
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
create
Draft
Reply
create
Draft
Reply
All
forward
get
Attachments
get
Bcc
get
Body
get
Cc
get
Date
get
From
get
Header
get
Id
get
Plain
Body
get
Raw
Content
get
Reply
To
get
Subject
get
Thread
get
To
is
Draft
is
In
Chats
is
In
Inbox
is
In
Priority
Inbox
is
In
Trash
is
Starred
is
Unread
mark
Read
mark
Unread
move
To
Trash
refresh
reply
reply
All
star
unstar
Google Apps Script API
Loading...
A message in a user's Gmail account.