Class GmailMessage

Wiadomość w Gmailu

Wiadomość na koncie Gmail użytkownika.

Metody

MetodaZwracany typKrótki opis
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada na wiadomość nadawcy, używając adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego z opcjonalnymi argumentami.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości skierowanej do nadawcy, używając adresu zwrotnego i wszystkich adresatów tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.
forward(recipient)GmailMessagePrzekazuje tę wiadomość do nowych odbiorców.
forward(recipient, options)GmailMessagePowoduje przekazanie tej wiadomości do nowych odbiorców i opcjonalnych argumentów.
getAttachments()GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getAttachments(options)GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getBcc()StringPobiera odbiorców UDW dla tej wiadomości.
getBody()StringPobiera treść HTML treści wiadomości.
getCc()StringPobiera adresatów wiadomości rozdzielonych przecinkami (DW) tej wiadomości.
getDate()DatePobiera datę i godzinę tej wiadomości.
getFrom()StringPobiera nadawcę tej wiadomości.
getHeader(name)StringPobiera wartość nagłówka RFC 2822 po nazwie.
getId()StringPobiera identyfikator tej wiadomości.
getPlainBody()StringPobiera treść tej wiadomości bez formatowania HTML.
getRawContent()StringPobiera nieprzetworzoną treść tej wiadomości.
getReplyTo()StringPobiera adres zwrotny tej wiadomości (zazwyczaj nadawcy).
getSubject()StringPobiera temat tej wiadomości.
getThread()GmailThreadPobiera wątek zawierający tę wiadomość.
getTo()StringPobiera odbiorców wiadomości rozdzielonych przecinkami.
isDraft()BooleanOkreśla, czy wiadomość jest wersją roboczą.
isInChats()BooleanSprawdza, czy ta wiadomość jest czatem.
isInInbox()BooleanSprawdza, czy ta wiadomość jest w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość true, jeśli ta wiadomość znajduje się w folderze Priorytety. W przeciwnym razie zwraca false.
isInTrash()BooleanSprawdza, czy wiadomość jest w koszu.
isStarred()BooleanOkreśla, czy wiadomość jest oznaczona gwiazdką.
isUnread()BooleanOkreśla, czy wiadomość jest nieprzeczytana.
markRead()GmailMessageOznacza wiadomość jako przeczytaną.
markUnread()GmailMessageOznacza wiadomość jako nieprzeczytaną.
moveToTrash()GmailMessagePowoduje przeniesienie wiadomości do kosza.
refresh()GmailMessageWczytuje ponownie tę wiadomość i powiązany stan z Gmaila (na wypadek, gdyby etykiety, stan odczytu itp. uległy zmianie).
reply(body)GmailMessageOdpowiedzi do nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego.
reply(body, options)GmailMessageOdpowiedzi do nadawcy tej wiadomości z adresem zwrotnym i opcjonalnymi argumentami.
replyAll(body)GmailMessageOdpowiedzi do nadawcy przy użyciu adresu zwrotnego i wszystkich odbiorców wiadomości.
replyAll(body, options)GmailMessageOdpowiedzi dla nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.
star()GmailMessageOznaczy wiadomość gwiazdką.
unstar()GmailMessageOznaczenie wiadomości gwiazdką zostanie usunięte.

Szczegółowa dokumentacja

createDraftReply(body)

Tworzy wersję roboczą wiadomości, która odpowiada na wiadomość nadawcy, używając adresu zwrotnego. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

Parametry

NazwaTypOpis
bodyStringTreść e-maila.

Zwróć

GmailDraft – nowo utworzona wersja robocza wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


createDraftReply(body, options)

Tworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego z opcjonalnymi argumentami.

E-mail może zawierać zarówno zwykły tekst, jak i treść HTML. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Parametry

NazwaTypOpis
bodyStringTreść e-maila.
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablica plików do wysłania w wiadomości e-mail
bccStringoddzielona przecinkami lista adresów e-mail w polu UDW.
ccStringoddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez GmailApp.getAliases()
htmlBodyStringjeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, używają go zamiast wymaganego argumentu body. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy do e-maila.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i odwołania do tych obrazów w formacie <img src="cid:imageKey" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika),
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);
subjectStringnowy wiersz tematu e-maila

Zwróć

GmailDraft – nowo utworzona wersja robocza wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


createDraftReplyAll(body)

Tworzy wersję roboczą wiadomości skierowanej do nadawcy, używając adresu zwrotnego i wszystkich adresatów tej wiadomości. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

Parametry

NazwaTypOpis
bodyStringTreść e-maila.

Zwróć

GmailDraft – nowo utworzona wersja robocza wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


createDraftReplyAll(body, options)

Tworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.

E-mail może zawierać zarówno zwykły tekst, jak i treść HTML. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Parametry

NazwaTypOpis
bodyStringTreść e-maila.
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablica plików do wysłania w wiadomości e-mail
bccStringoddzielona przecinkami lista adresów e-mail w polu UDW.
ccStringoddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez GmailApp.getAliases()
htmlBodyStringjeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, używają go zamiast wymaganego argumentu body. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy do e-maila.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i odwołania do tych obrazów w formacie <img src="cid:imageKey" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika),
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);
subjectStringnowy wiersz tematu e-maila

Zwróć

GmailDraft – nowo utworzona wersja robocza wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


forward(recipient)

Przekazuje tę wiadomość do nowych odbiorców. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

Parametry

NazwaTypOpis
recipientStringLista adresów e-mail rozdzielonych przecinkami.

Zwróć

GmailMessage – ta wiadomość jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


forward(recipient, options)

Powoduje przekazanie tej wiadomości do nowych odbiorców i opcjonalnych argumentów.

E-mail może zawierać zarówno zwykły tekst, jak i treść HTML. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

Parametry

NazwaTypOpis
recipientStringLista adresów e-mail rozdzielonych przecinkami.
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablica plików do wysłania w wiadomości e-mail
bccStringoddzielona przecinkami lista adresów e-mail w polu UDW.
ccStringoddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez GmailApp.getAliases()
htmlBodyStringjeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, używają go zamiast wymaganego argumentu body. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy do e-maila.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i odwołania do tych obrazów w formacie <img src="cid:imageKey" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika),
noReplyBooleantrue, jeśli chcesz, by e-maile były wysyłane z ogólnego adresu e-mail, który ma zniechęcać odbiorców do odpowiadania na e-maile. Ta opcja jest dostępna tylko na kontach Google Workspace, a nie na kontach Gmail.
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);
subjectStringnowy wiersz tematu e-maila

Zwróć

GmailMessage – ta wiadomość jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getAttachments()

Pobiera wszystkie załączniki do tej wiadomości.

Zwróć

GmailAttachment[] – tablica załączników Blob tej wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getAttachments(options)

Pobiera wszystkie załączniki do tej wiadomości.

Parametry

NazwaTypOpis
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
includeInlineImagesBooleantrue, jeśli zwrócona tablica załączników Blob powinna zawierać obrazy w tekście (domyślnie true).
includeAttachmentsBooleantrue, jeśli zwrócona tablica załączników Blob powinna zawierać zwykłe załączniki (nie wbudowane) (domyślnie true).

Zwróć

GmailAttachment[] – tablica załączników Blob tej wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getBcc()

Pobiera odbiorców UDW dla tej wiadomości.

To pole jest puste w przypadku wszystkich odebranych wiadomości (według definicji).

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

Zwróć

String – odbiorcy wiadomości rozdzielonych przecinkami (bcc'd).

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getBody()

Pobiera treść HTML treści wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

Zwróć

String – treść wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getCc()

Pobiera adresatów wiadomości rozdzielonych przecinkami (DW) tej wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

Zwróć

String – odbiorcy wiadomości rozdzielone przecinkami (DW) tej wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getDate()

Pobiera datę i godzinę tej wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

Zwróć

Date – data i godzina przesłania wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getFrom()

Pobiera nadawcę tej wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

Zwróć

String – adres e-mail nadawcy wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getHeader(name)

Pobiera wartość nagłówka RFC 2822 po nazwie.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

Parametry

NazwaTypOpis
nameStringNazwa nagłówka RFC bez dwukropku oddzielającego go od wartości.

Zwróć

String – wartość nagłówka lub pusty ciąg tekstowy, jeśli nagłówek nie istnieje w wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getId()

Pobiera identyfikator tej wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

Zwróć

String – identyfikator wiadomości;


getPlainBody()

Pobiera treść tej wiadomości bez formatowania HTML. To bardziej złożone niżgetBody() i trwa dłużej.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

Zwróć

String – zwykły tekst wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getRawContent()

Pobiera nieprzetworzoną treść tej wiadomości. Odpowiednik funkcji „Pokaż oryginał” w interfejsie Gmaila.

Zwróć

String – nieprzetworzona treść tej wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getReplyTo()

Pobiera adres zwrotny tej wiadomości (zazwyczaj nadawcy).

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

Zwróć

String – adres e-mail do odpowiedzi.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getSubject()

Pobiera temat tej wiadomości.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

Zwróć

String – temat wiadomości;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


getThread()

Pobiera wątek zawierający tę wiadomość.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

Zwróć

GmailThread – wątek Gmaila zawierający tę wiadomość.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

getTo()

Pobiera odbiorców wiadomości rozdzielonych przecinkami.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

Zwróć

String – odbiorcy wiadomości rozdzielone przecinkami;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


isDraft()

Określa, czy wiadomość jest wersją roboczą.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

Zwróć

Boolean – wskazuje, czy ta wiadomość jest wersją roboczą.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

isInChats()

Sprawdza, czy ta wiadomość jest czatem.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

Zwróć

Boolean – określa, czy ta wiadomość jest czatem.


isInInbox()

Sprawdza, czy ta wiadomość jest w skrzynce odbiorczej.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

Zwróć

Boolean – informacja o tym, czy ta wiadomość znajduje się w Odebranych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

isInPriorityInbox()

Zwraca wartość true, jeśli ta wiadomość znajduje się w folderze Priorytety. W przeciwnym razie zwraca false.

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

Zwróć

Boolean – informacja o tym, czy ta wiadomość znajduje się w folderze Priorytety.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

isInTrash()

Sprawdza, czy wiadomość jest w koszu.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

Zwróć

Boolean – informacja, czy wiadomość jest w koszu;


isStarred()

Określa, czy wiadomość jest oznaczona gwiazdką.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

Zwróć

Boolean – informacja, czy wiadomość jest oznaczona gwiazdką;


isUnread()

Określa, czy wiadomość jest nieprzeczytana.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

Zwróć

Boolean – stan nieprzeczytanej wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

markRead()

Oznacza wiadomość jako przeczytaną.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

Zwróć

GmailMessage – ta wiadomość z Gmaila jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


markUnread()

Oznacza wiadomość jako nieprzeczytaną.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

Zwróć

GmailMessage – ta wiadomość z Gmaila jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


moveToTrash()

Powoduje przeniesienie wiadomości do kosza.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

Zwróć

GmailMessage – ta wiadomość z Gmaila jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


refresh()

Wczytuje ponownie tę wiadomość i powiązany stan z Gmaila (na wypadek, gdyby etykiety, stan odczytu itp. uległy zmianie).

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

Zwróć

GmailMessage – ten komunikat jest powiązany z łańcuchami.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

reply(body)

Odpowiedzi do nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

Parametry

NazwaTypOpis
bodyStringTreść e-maila.

Zwróć

GmailMessage – ta wiadomość jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


reply(body, options)

Odpowiedzi do nadawcy tej wiadomości z adresem zwrotnym i opcjonalnymi argumentami.

E-mail może zawierać zarówno zwykły tekst, jak i treść HTML. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Parametry

NazwaTypOpis
bodyStringTreść e-maila.
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablica plików do wysłania w wiadomości e-mail
bccStringoddzielona przecinkami lista adresów e-mail w polu UDW.
ccStringoddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez GmailApp.getAliases()
htmlBodyStringjeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, używają go zamiast wymaganego argumentu body. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy do e-maila.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i odwołania do tych obrazów w formacie <img src="cid:imageKey" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika),
noReplyBooleantrue, jeśli chcesz, by e-maile były wysyłane z ogólnego adresu e-mail, który ma zniechęcać odbiorców do odpowiadania na e-maile. Ta opcja jest dostępna tylko na kontach Google Workspace, a nie na kontach Gmail.
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);
subjectStringnowy wiersz tematu e-maila

Zwróć

GmailMessage – ta wiadomość jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


replyAll(body)

Odpowiedzi do nadawcy przy użyciu adresu zwrotnego i wszystkich odbiorców wiadomości. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

Parametry

NazwaTypOpis
bodyStringTreść e-maila.

Zwróć

GmailMessage – ta wiadomość przydaje się do tworzenia łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


replyAll(body, options)

Odpowiedzi dla nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.

E-mail może zawierać zarówno zwykły tekst, jak i treść HTML. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Parametry

NazwaTypOpis
bodyStringTreść e-maila.
optionsObjectObiekt JavaScript określający parametry zaawansowane, jak opisano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablica plików do wysłania w wiadomości e-mail
bccStringoddzielona przecinkami lista adresów e-mail w polu UDW.
ccStringoddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez GmailApp.getAliases()
htmlBodyStringjeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, używają go zamiast wymaganego argumentu body. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy do e-maila.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i odwołania do tych obrazów w formacie <img src="cid:imageKey" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika),
noReplyBooleantrue, jeśli chcesz, by e-maile były wysyłane z ogólnego adresu e-mail, który ma zniechęcać odbiorców do odpowiadania na e-maile. Ta opcja jest dostępna tylko na kontach Google Workspace, a nie na kontach Gmail.
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);
subjectStringnowy wiersz tematu e-maila (maksymalnie 250 znaków),

Zwróć

GmailMessage – ta wiadomość jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


star()

Oznaczy wiadomość gwiazdką.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

Zwróć

GmailMessage – ta wiadomość z Gmaila jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też


unstar()

Oznaczenie wiadomości gwiazdką zostanie usunięte.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

Zwróć

GmailMessage – ta wiadomość z Gmaila jest przydatna w przypadku łańcuchów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

  • https://mail.google.com/

Zobacz też