Class GmailAttachment

GmailВложение

Вложение из Gmail. Это обычный Blob за исключением того, что у него есть дополнительный метод getSize() , который работает быстрее, чем вызов getBytes() .length , и не учитывается в квоте чтения Gmail.

// 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(),
      );
    }
  }
}

Методы

Метод Тип возвращаемого значения Краткое описание
copy Blob() Blob Возвращает копию этого объекта.
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Bytes() Byte[] Получает данные, хранящиеся в этом блоке.
get Content Type() String|null Получает тип содержимого байтов в этом блоке данных.
get Data As String() String Получает данные этого объекта в виде строки с кодировкой UTF-8.
get Data As String(charset) String Получает данные этого объекта в виде строки с указанной кодировкой.
get Hash() String Получает хеш содержимого SHA1 для этого вложения.
get Name() String|null Получает имя этого объекта.
get Size() Integer Определяет размер этого вложения.
is Google Type() Boolean Возвращает значение, указывающее, является ли данный объект файлом Google Workspace (Sheets, Docs и т. д.).
set Bytes(data) Blob Задает параметры данных, хранящихся в этом блоке.
set Content Type(contentType) Blob Задает тип содержимого байтов в этом блоке.
set Content Type From Extension() Blob Устанавливает тип содержимого байтов в этом блоке данных на основе расширения файла.
set Data From String(string) Blob Задает данные для этого объекта типа BLOB из строки с кодировкой UTF-8.
set Data From String(string, charset) Blob Задает данные для этого объекта типа BLOB из строки с указанной кодировкой.
set Name(name) Blob Задает имя этого объекта.

Подробная документация

copyBlob()

Возвращает копию этого объекта.

Возвращаться

Blob — новая копия.


getAs(contentType)

Возвращает данные из этого объекта в виде двоичных данных (blob), преобразованных в указанный тип содержимого. Этот метод добавляет соответствующее расширение к имени файла — например, "myfile.pdf". Однако он предполагает, что часть имени файла, следующая за последней точкой (если таковая имеется), является существующим расширением, которое следует заменить. Следовательно, "ShoppingList.12.25.2014" становится "ShoppingList.12.25.pdf".

Чтобы просмотреть ежедневные квоты на конверсии, см. раздел «Квоты для сервисов Google» . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя Тип Описание
content Type String MIME-тип для преобразования. Для большинства файлов .blob единственным допустимым вариантом является 'application/pdf' . Для изображений в форматах BMP, GIF, JPEG или PNG также допустимы любые из 'image/bmp' , 'image/gif' , 'image/jpeg' или 'image/png' . Для документа Google Docs также допустим 'text/markdown' .

Возвращаться

Blob — Данные в виде двоичных данных (blob).


getBytes()

Получает данные, хранящиеся в этом блоке.

Возвращаться

Byte[] — Сохраненные байты.


getContentType()

Получает тип содержимого байтов в этом блоке данных.

Возвращаться

String|null — Тип содержимого этих данных, если известен, или null .


getDataAsString()

Получает данные этого объекта в виде строки с кодировкой UTF-8.

Возвращаться

String — данные в виде строки.


getDataAsString(charset)

Получает данные этого объекта в виде строки с указанной кодировкой.

Параметры

Имя Тип Описание
charset String Кодировка, используемая для кодирования данных в этом блоке в виде строки.

Возвращаться

String — данные в виде строки.


getHash()

Получает хеш SHA1 содержимого этого вложения. Этот метод не учитывается в квоте чтения Gmail.

Возвращаться

String — хеш содержимого SHA1 в виде строки.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getName()

Получает имя этого объекта.

Возвращаться

String|null — Название этих данных, если известно, или null .


getSize()

Получает размер вложения. Этот метод быстрее, чем вызов getBytes() .length , и не учитывается в квоте на чтение Gmail.

Возвращаться

Integer — размер вложенного файла в байтах.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

isGoogleType()

Возвращает значение, указывающее, является ли данный объект файлом Google Workspace (Sheets, Docs и т. д.).

Возвращаться

Booleantrue если этот объект является файлом Google Workspace; false если нет.


setBytes(data)

Задает параметры данных, хранящихся в этом блоке.

Параметры

Имя Тип Описание
data Byte[] Новые данные.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.


setContentType(contentType)

Задает тип содержимого байтов в этом блоке.

Параметры

Имя Тип Описание
content Type String Новый тип контента.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.


setContentTypeFromExtension()

Устанавливает тип содержимого байтов в этом блоке на основе расширения файла. Тип содержимого равен null , если его невозможно определить по расширению файла.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.


setDataFromString(string)

Задает данные для этого объекта типа BLOB из строки с кодировкой UTF-8.

Параметры

Имя Тип Описание
string String Строковые данные.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.


setDataFromString(string, charset)

Задает данные для этого объекта типа BLOB из строки с указанной кодировкой.

Параметры

Имя Тип Описание
string String Строковые данные.
charset String Кодировка, используемая для интерпретации строки как байтов.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.


setName(name)

Задает имя этого объекта.

Параметры

Имя Тип Описание
name String Новое название.

Возвращаться

Blob — Этот сгусток используется для создания цепочек.

Устаревшие методы