Class GmailAttachment

GmailZałącznik

Załącznik z Gmaila. Jest to zwykła funkcja Blob, ale ma dodatkową metodę getSize(), która jest szybsza niż wywołanie getBytes().length i nie jest wliczana do limitu odczytu Gmaila. 

// Logs information about any attachments in the first 100 inbox threads.
const threads = GmailApp.getInboxThreads(0, 100);
const msgs = GmailApp.getMessagesForThreads(threads);
for (let i = 0; i < msgs.length; i++) {
  for (let j = 0; j < msgs[i].length; j++) {
    const attachments = msgs[i][j].getAttachments();
    for (let 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(),
      );
    }
  }
}

Metody

MetodaZwracany typKrótki opis
copyBlob()BlobZwraca kopię tego bloba.
getAs(contentType)BlobZwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści.
getBytes()Byte[]Pobiera dane zapisane w tym pliku blob.
getContentType()StringPobiera typ danych bajtów w tym pliku blob.
getDataAsString()StringPobiera dane tego bloba jako ciąg znaków w formacie UTF-8.
getDataAsString(charset)StringPobiera dane tego bloba jako ciąg znaków z określonym kodowaniem.
getHash()StringPobiera identyfikator SHA1 treści tego załącznika.
getName()StringPobiera nazwę tego bloba.
getSize()IntegerPobiera rozmiar załącznika.
isGoogleType()BooleanZwraca informację, czy ten blob jest plikiem Google Workspace (Arkusze, Dokumenty itp.).
setBytes(data)BlobUstawia dane przechowywane w tym pliku blob.
setContentType(contentType)BlobOkreśla typ treści bajtów w tym blobie.
setContentTypeFromExtension()BlobUstawia typ danych bajtów w tym blobie na podstawie rozszerzenia pliku.
setDataFromString(string)BlobUstawia dane tego bloba na podstawie ciągu znaków zakodowanego w formacie UTF-8.
setDataFromString(string, charset)BlobUstawia dane tego bloba na podstawie ciągu o określonym kodowaniu.
setName(name)BlobUstawia nazwę tego pliku blob.

Szczegółowa dokumentacja

copyBlob()

Zwraca kopię tego bloba.

Powrót

Blob – nowa kopia.

getAs(contentType)

Zwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści. Ta metoda dodaje odpowiednie rozszerzenie do nazwy pliku, np. „mójplik.pdf”. Zakłada ona jednak, że część nazwy pliku, która następuje po ostatnim okresie (jeśli w ogóle występuje), to istniejące rozszerzenie, które należy zastąpić. W rezultacie plik „ShoppingList.12.25.2014” staje się „ShoppingList.12.25.pdf”.

Informacje o limitach dziennych konwersji znajdziesz w artykule Limity dotyczące usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma nastąpić konwersja. W przypadku większości blobów opcja 'application/pdf' jest jedyną prawidłową opcją. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowe są również wartości 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'. W przypadku dokumentu w Dokumentach Google możesz też użyć 'text/markdown'.

Powrót

Blob – dane w postaci bloba.

getBytes()

Pobiera dane zapisane w tym pliku blob.

Powrót

Byte[] – zapisane bajty.

getContentType()

Pobiera typ danych bajtów w tym pliku blob.

Powrót

String – typ treści tych danych (jeśli jest znany) lub null.

getDataAsString()

Pobiera dane tego bloba jako ciąg znaków w formacie UTF-8.

Powrót

String – dane w postaci ciągu znaków.

getDataAsString(charset)

Pobiera dane tego bloba jako ciąg znaków z określonym kodowaniem.

Parametry

NazwaTypOpis
charsetStringZbiór znaków, którego należy użyć do zakodowania danych w tym pliku blob jako ciągu znaków.

Powrót

String – dane w postaci ciągu znaków.

getHash()

Pobiera identyfikator SHA1 treści tego załącznika. Ta metoda nie wlicza się do limitu odczytu w Gmailu.

Powrót

String – identyfikator SHA1 treści jako ciąg znaków.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

getName()

Pobiera nazwę tego bloba.

Powrót

String – nazwa tych danych (jeśli jest znana) lub null.

getSize()

Pobiera rozmiar załącznika. Ta metoda jest szybsza niż wywołanie funkcji getBytes().length i nie wlicza się do limitu odczytu Gmaila.

Powrót

Integer – rozmiar załącznika w bajtach.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

isGoogleType()

Zwraca informację, czy ten blob jest plikiem Google Workspace (Arkusze, Dokumenty itp.).

Powrót

Boolean – true, jeśli ten blob jest plikiem Google Workspace, false w przeciwnym razie.

setBytes(data)

Ustawia dane przechowywane w tym pliku blob.

Parametry

NazwaTypOpis
dataByte[]nowe dane;

Powrót

Blob – ten blob do łańcucha.

setContentType(contentType)

Określa typ zawartości bajtów w tym blobie.

Parametry

NazwaTypOpis
contentTypeStringNowy typ treści.

Powrót

Blob – ten blob do łańcucha.

setContentTypeFromExtension()

Ustawia typ danych bajtów w tym blobie na podstawie rozszerzenia pliku. Wartość contentType to null, jeśli nie można jej określić na podstawie rozszerzenia.

Powrót

Blob – ten blob do łańcucha.

setDataFromString(string)

Ustawia dane tego bloba na podstawie ciągu znaków zakodowanego w formacie UTF-8.

Parametry

NazwaTypOpis
stringStringDane ciągu znaków.

Powrót

Blob – ten blob do łańcucha.

setDataFromString(string, charset)

Ustawia dane tego bloba na podstawie ciągu o określonym kodowaniu.

Parametry

NazwaTypOpis
stringStringDane ciągu znaków.
charsetStringZestaw znaków używany do interpretowania ciągu jako bajtów.

Powrót

Blob – ten blob do łańcucha.

setName(name)

Ustawia nazwę tego pliku blob.

Parametry

NazwaTypOpis
nameStringNowa nazwa.

Powrót

Blob – ten blob do łańcucha.

Wycofane metody