mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
e3bf063217
This method was publicly launched a few days ago. As of this writing, the docs have not yet been updated, but this method is visible from the script editor's autocomplete.
310 lines
12 KiB
TypeScript
310 lines
12 KiB
TypeScript
// Type definitions for Google Apps Script 2018-12-26
|
|
// Project: https://developers.google.com/apps-script/
|
|
// Definitions by: motemen <https://github.com/motemen/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference path="google-apps-script.types.d.ts" />
|
|
/// <reference path="google-apps-script.base.d.ts" />
|
|
|
|
declare namespace GoogleAppsScript {
|
|
export module Gmail {
|
|
/**
|
|
* Provides access to Gmail threads, messages, and labels.
|
|
*/
|
|
export interface GmailApp {
|
|
createDraft(recipient: string, subject: string, body: string): GmailDraft;
|
|
createDraft(recipient: string, subject: string, body: string, options: Object): GmailDraft;
|
|
createLabel(name: string): GmailLabel;
|
|
deleteLabel(label: GmailLabel): GmailApp;
|
|
getAliases(): string[];
|
|
getChatThreads(): GmailThread[];
|
|
getChatThreads(start: Integer, max: Integer): GmailThread[];
|
|
getDraft(draftId: string): GmailDraft;
|
|
getDraftMessages(): GmailMessage[];
|
|
getDrafts(): GmailDraft[];
|
|
getInboxThreads(): GmailThread[];
|
|
getInboxThreads(start: Integer, max: Integer): GmailThread[];
|
|
getInboxUnreadCount(): Integer;
|
|
getMessageById(id: string): GmailMessage;
|
|
getMessagesForThread(thread: GmailThread): GmailMessage[];
|
|
getMessagesForThreads(threads: GmailThread[]): GmailMessage[][];
|
|
getPriorityInboxThreads(): GmailThread[];
|
|
getPriorityInboxThreads(start: Integer, max: Integer): GmailThread[];
|
|
getPriorityInboxUnreadCount(): Integer;
|
|
getSpamThreads(): GmailThread[];
|
|
getSpamThreads(start: Integer, max: Integer): GmailThread[];
|
|
getSpamUnreadCount(): Integer;
|
|
getStarredThreads(): GmailThread[];
|
|
getStarredThreads(start: Integer, max: Integer): GmailThread[];
|
|
getStarredUnreadCount(): Integer;
|
|
getThreadById(id: string): GmailThread;
|
|
getTrashThreads(): GmailThread[];
|
|
getTrashThreads(start: Integer, max: Integer): GmailThread[];
|
|
getUserLabelByName(name: string): GmailLabel;
|
|
getUserLabels(): GmailLabel[];
|
|
markMessageRead(message: GmailMessage): GmailApp;
|
|
markMessageUnread(message: GmailMessage): GmailApp;
|
|
markMessagesRead(messages: GmailMessage[]): GmailApp;
|
|
markMessagesUnread(messages: GmailMessage[]): GmailApp;
|
|
markThreadImportant(thread: GmailThread): GmailApp;
|
|
markThreadRead(thread: GmailThread): GmailApp;
|
|
markThreadUnimportant(thread: GmailThread): GmailApp;
|
|
markThreadUnread(thread: GmailThread): GmailApp;
|
|
markThreadsImportant(threads: GmailThread[]): GmailApp;
|
|
markThreadsRead(threads: GmailThread[]): GmailApp;
|
|
markThreadsUnimportant(threads: GmailThread[]): GmailApp;
|
|
markThreadsUnread(threads: GmailThread[]): GmailApp;
|
|
moveMessageToTrash(message: GmailMessage): GmailApp;
|
|
moveMessagesToTrash(messages: GmailMessage[]): GmailApp;
|
|
moveThreadToArchive(thread: GmailThread): GmailApp;
|
|
moveThreadToInbox(thread: GmailThread): GmailApp;
|
|
moveThreadToSpam(thread: GmailThread): GmailApp;
|
|
moveThreadToTrash(thread: GmailThread): GmailApp;
|
|
moveThreadsToArchive(threads: GmailThread[]): GmailApp;
|
|
moveThreadsToInbox(threads: GmailThread[]): GmailApp;
|
|
moveThreadsToSpam(threads: GmailThread[]): GmailApp;
|
|
moveThreadsToTrash(threads: GmailThread[]): GmailApp;
|
|
refreshMessage(message: GmailMessage): GmailApp;
|
|
refreshMessages(messages: GmailMessage[]): GmailApp;
|
|
refreshThread(thread: GmailThread): GmailApp;
|
|
refreshThreads(threads: GmailThread[]): GmailApp;
|
|
search(query: string): GmailThread[];
|
|
search(query: string, start: Integer, max: Integer): GmailThread[];
|
|
sendEmail(recipient: string, subject: string, body: string): GmailApp;
|
|
sendEmail(recipient: string, subject: string, body: string, options: Object): GmailApp;
|
|
setCurrentMessageAccessToken(accessToken: string): void;
|
|
starMessage(message: GmailMessage): GmailApp;
|
|
starMessages(messages: GmailMessage[]): GmailApp;
|
|
unstarMessage(message: GmailMessage): GmailApp;
|
|
unstarMessages(messages: GmailMessage[]): GmailApp;
|
|
}
|
|
|
|
/**
|
|
* An attachment from Gmail. This is a regular Blob except that it has an extra getSize() method that is faster than calling
|
|
* getBytes().length and does not count against the Gmail read quota.
|
|
*
|
|
* // Logs information about any attachments in the first 100 inbox threads.
|
|
* var threads = GmailApp.getInboxThreads(0, 100);
|
|
* var msgs = GmailApp.getMessagesForThreads(threads);
|
|
* for (var i = 0 ; i < msgs.length; i++) {
|
|
* for (var j = 0; j < msgs[i].length; j++) {
|
|
* var attachments = msgs[i][j].getAttachments();
|
|
* for (var k = 0; k < attachments.length; k++) {
|
|
* Logger.log('Message "%s" contains the attachment "%s" (%s bytes)',
|
|
* msgs[i][j].getSubject(), attachments[k].getName(), attachments[k].getSize());
|
|
* }
|
|
* }
|
|
* }
|
|
*/
|
|
export interface GmailAttachment {
|
|
copyBlob(): Base.Blob;
|
|
getAs(contentType: string): Base.Blob;
|
|
getBytes(): Byte[];
|
|
getContentType(): string;
|
|
getDataAsString(): string;
|
|
getDataAsString(charset: string): string;
|
|
getHash(): string;
|
|
getName(): string;
|
|
getSize(): Integer;
|
|
isGoogleType(): boolean;
|
|
setBytes(data: Byte[]): Base.Blob;
|
|
setContentType(contentType: string): Base.Blob;
|
|
setContentTypeFromExtension(): Base.Blob;
|
|
setDataFromString(string: string): Base.Blob;
|
|
setDataFromString(string: string, charset: string): Base.Blob;
|
|
setName(name: string): Base.Blob;
|
|
getAllBlobs(): Base.Blob[];
|
|
}
|
|
|
|
/**
|
|
* A user-created draft message in a user's Gmail account.
|
|
*/
|
|
export interface GmailDraft {
|
|
/**
|
|
* Deletes this draft message.
|
|
*/
|
|
deleteDraft(): void;
|
|
/**
|
|
* Gets the ID of this draft message.
|
|
*/
|
|
getId(): string;
|
|
/**
|
|
* Returns a GmailMessage representing this draft.
|
|
*/
|
|
getMessage(): GmailMessage;
|
|
/**
|
|
* Returns the ID of the `GmailMessage` representing this draft.
|
|
*/
|
|
getMessageId(): string;
|
|
/**
|
|
* Sends this draft email message.
|
|
*/
|
|
send(): GmailMessage;
|
|
/**
|
|
* Replaces the contents of this draft message.
|
|
*/
|
|
update(recipient: string, subject: string, body: string): GmailDraft;
|
|
/**
|
|
* Replaces the contents of this draft message using optional arguments.
|
|
*/
|
|
update(recipient: string, subject: string, body: string, options: GmailDraftOptions): GmailDraft;
|
|
}
|
|
|
|
/**
|
|
* Options for a Gmail draft.
|
|
*/
|
|
export type GmailDraftOptions = {
|
|
/**
|
|
* An array of files to send with the email.
|
|
*/
|
|
attachments?: Base.BlobSource[];
|
|
/**
|
|
* A comma-separated list of email addresses to BCC.
|
|
*/
|
|
bcc?: string;
|
|
/**
|
|
* A comma-separated list of email addresses to CC.
|
|
*/
|
|
cc?: string;
|
|
/**
|
|
* The address that the email should be sent from, which must be one of the values returned by `GmailApp.getAliases()`.
|
|
*/
|
|
from?: string;
|
|
/**
|
|
* If set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional `inlineImages` field in HTML body if you have inlined images for your email.
|
|
*/
|
|
htmlBody?: string;
|
|
/**
|
|
* A JavaScript object containing a mapping from image key (`String`) to image data (`BlobSource`) ; this assumes that the `htmlBody` parameter is used and contains references to these images in the format `<img src="cid:imageKey" />`.
|
|
*/
|
|
inlineImages?: { [imageKey: string]: Base.BlobSource };
|
|
/**
|
|
* The name of the sender of the email (default: the user's name).
|
|
*/
|
|
name?: string;
|
|
/**
|
|
* An email address to use as the default reply-to address (default: the user's email address).
|
|
*/
|
|
replyTo?: string;
|
|
}
|
|
|
|
/**
|
|
* Options for a Gmail Attachments.
|
|
*/
|
|
export type GmailAttachmentOptions = {
|
|
/**
|
|
* If the returned array of Blob attachments should include inline images.
|
|
*/
|
|
includeInlineImages?: boolean;
|
|
/**
|
|
* If the returned array of Blob attachments should include regular (non-inline) attachments.
|
|
*/
|
|
includeAttachments?: boolean;
|
|
/**
|
|
* A comma-separated list of email addresses to BCC.
|
|
*/
|
|
}
|
|
|
|
/**
|
|
* A user-created label in a user's Gmail account.
|
|
*/
|
|
export interface GmailLabel {
|
|
addToThread(thread: GmailThread): GmailLabel;
|
|
addToThreads(threads: GmailThread[]): GmailLabel;
|
|
deleteLabel(): void;
|
|
getName(): string;
|
|
getThreads(): GmailThread[];
|
|
getThreads(start: Integer, max: Integer): GmailThread[];
|
|
getUnreadCount(): Integer;
|
|
removeFromThread(thread: GmailThread): GmailLabel;
|
|
removeFromThreads(threads: GmailThread[]): GmailLabel;
|
|
}
|
|
|
|
/**
|
|
* A message in a user's Gmail account.
|
|
*/
|
|
export interface GmailMessage {
|
|
createDraftReply(body: string): GmailDraft;
|
|
createDraftReply(body: string, options: GmailDraftOptions): GmailDraft;
|
|
createDraftReplyAll(body: string): GmailDraft;
|
|
createDraftReplyAll(body: string, options: GmailDraftOptions): GmailDraft;
|
|
forward(recipient: string): GmailMessage;
|
|
forward(recipient: string, options: GmailDraftOptions): GmailMessage;
|
|
getAttachments(): GmailAttachment[];
|
|
getAttachments(options: GmailAttachmentOptions): GmailAttachment[];
|
|
getBcc(): string;
|
|
getBody(): string;
|
|
getCc(): string;
|
|
getDate(): 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: GmailDraftOptions): GmailMessage;
|
|
replyAll(body: string): GmailMessage;
|
|
replyAll(body: string, options: GmailDraftOptions): GmailMessage;
|
|
star(): GmailMessage;
|
|
unstar(): GmailMessage;
|
|
}
|
|
|
|
/**
|
|
* A thread in a user's Gmail account.
|
|
*/
|
|
export interface GmailThread {
|
|
addLabel(label: GmailLabel): GmailThread;
|
|
createDraftReply(body: string): GmailDraft;
|
|
createDraftReply(body: string, options: GmailDraftOptions): GmailDraft;
|
|
createDraftReplyAll(body: string): GmailDraft;
|
|
createDraftReplyAll(body: string, options: GmailDraftOptions): GmailDraft;
|
|
getFirstMessageSubject(): string;
|
|
getId(): string;
|
|
getLabels(): GmailLabel[];
|
|
getLastMessageDate(): Date;
|
|
getMessageCount(): Integer;
|
|
getMessages(): GmailMessage[];
|
|
getPermalink(): string;
|
|
hasStarredMessages(): boolean;
|
|
isImportant(): boolean;
|
|
isInChats(): boolean;
|
|
isInInbox(): boolean;
|
|
isInPriorityInbox(): boolean;
|
|
isInSpam(): boolean;
|
|
isInTrash(): boolean;
|
|
isUnread(): boolean;
|
|
markImportant(): GmailThread;
|
|
markRead(): GmailThread;
|
|
markUnimportant(): GmailThread;
|
|
markUnread(): GmailThread;
|
|
moveToArchive(): GmailThread;
|
|
moveToInbox(): GmailThread;
|
|
moveToSpam(): GmailThread;
|
|
moveToTrash(): GmailThread;
|
|
refresh(): GmailThread;
|
|
removeLabel(label: GmailLabel): GmailThread;
|
|
reply(body: string): GmailThread;
|
|
reply(body: string, options: GmailDraftOptions): GmailThread;
|
|
replyAll(body: string): GmailThread;
|
|
replyAll(body: string, options: GmailDraftOptions): GmailThread;
|
|
}
|
|
}
|
|
}
|
|
|
|
declare var GmailApp: GoogleAppsScript.Gmail.GmailApp;
|