Class GmailAttachment

Anexo do Gmail

Um anexo do Gmail. Esse é um Blob normal, exceto por ter um método getSize() extra que é mais rápido do que chamar getBytes().length e não conta na cota de leitura do 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(),
      );
    }
  }
}

Métodos

MétodoTipo de retornoBreve descrição
copyBlob()BlobRetorna uma cópia deste blob.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()Byte[]Recebe os dados armazenados neste blob.
getContentType()String|nullRecebe o tipo de conteúdo dos bytes neste blob.
getDataAsString()StringRecebe os dados deste blob como uma string com codificação UTF-8.
getDataAsString(charset)StringRecebe os dados deste blob como uma string com a codificação especificada.
getHash()StringRecebe o hash de conteúdo SHA1 para este anexo.
getName()String|nullRecebe o nome deste blob.
getSize()IntegerRecebe o tamanho deste anexo.
isGoogleType()BooleanRetorna se este blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).
setBytes(data)BlobDefine os dados armazenados neste blob.
setContentType(contentType)BlobDefine o tipo de conteúdo dos bytes neste blob.
setContentTypeFromExtension()BlobDefine o tipo de conteúdo dos bytes neste blob com base na extensão do arquivo.
setDataFromString(string)BlobDefine os dados desse blob com uma string codificada em UTF-8.
setDataFromString(string, charset)BlobDefine os dados deste blob de uma string com a codificação especificada.
setName(name)BlobDefine o nome deste blob.

Documentação detalhada

copyBlob()

Retorna uma cópia deste blob.

Retornar

Blob: o novo texto.


getAs(contentType)

Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "meuarquivo.pdf". No entanto, ele pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para conferir as cotas diárias de conversões, consulte Cotas para serviços do Google. Os domínios do Google Workspace criados recentemente podem estar sujeitos temporariamente a cotas mais rígidas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens em formato BMP, GIF, JPEG ou PNG, qualquer uma das opções 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válida. Para um documento do Google Docs, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.


getBytes()

Recebe os dados armazenados neste blob.

Retornar

Byte[]: os bytes armazenados.


getContentType()

Recebe o tipo de conteúdo dos bytes neste blob.

Retornar

String|null: o tipo de conteúdo desses dados, se conhecido, ou null.


getDataAsString()

Recebe os dados deste blob como uma string com codificação UTF-8.

Retornar

String: os dados como uma string.


getDataAsString(charset)

Recebe os dados deste blob como uma string com a codificação especificada.

Parâmetros

NomeTipoDescrição
charsetStringO conjunto de caracteres a ser usado na codificação dos dados neste blob como uma string.

Retornar

String: os dados como uma string.


getHash()

Recebe o hash de conteúdo SHA1 para este anexo. Esse método não é contabilizado na cota de leitura do Gmail.

Retornar

String: o hash de conteúdo SHA1, como uma string.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://mail.google.com/

getName()

Recebe o nome deste blob.

Retornar

String|null: o nome desses dados, se conhecido, ou null.


getSize()

Recebe o tamanho deste anexo. Esse método é mais rápido do que chamar getBytes().length e não é contabilizado na cota de leitura do Gmail.

Retornar

Integer: o tamanho do anexo, em bytes.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://mail.google.com/

isGoogleType()

Retorna se este blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).

Retornar

Boolean: true se o blob for um arquivo do Google Workspace; false caso contrário.


setBytes(data)

Define os dados armazenados neste blob.

Parâmetros

NomeTipoDescrição
dataByte[]Os novos dados.

Retornar

Blob: este blob, para encadeamento.


setContentType(contentType)

Define o tipo de conteúdo dos bytes neste blob.

Parâmetros

NomeTipoDescrição
contentTypeStringO novo contentType.

Retornar

Blob: este blob, para encadeamento.


setContentTypeFromExtension()

Define o tipo de conteúdo dos bytes neste blob com base na extensão do arquivo. O contentType é null se não for possível adivinhar pela extensão.

Retornar

Blob: este blob, para encadeamento.


setDataFromString(string)

Define os dados desse blob com uma string codificada em UTF-8.

Parâmetros

NomeTipoDescrição
stringStringOs dados de string.

Retornar

Blob: este blob, para encadeamento.


setDataFromString(string, charset)

Define os dados deste blob de uma string com a codificação especificada.

Parâmetros

NomeTipoDescrição
stringStringOs dados de string.
charsetStringO conjunto de caracteres a ser usado para interpretar a string como bytes.

Retornar

Blob: este blob, para encadeamento.


setName(name)

Define o nome deste blob.

Parâmetros

NomeTipoDescrição
nameStringO novo nome.

Retornar

Blob: este blob, para encadeamento.

Métodos obsoletos