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 para a 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 desse blob.
getAs(contentType)BlobRetorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()Byte[]Consegue os dados armazenados neste blob.
getContentType()StringRecebe o tipo de conteúdo dos bytes neste blob.
getDataAsString()StringRecebe os dados desse blob como uma string com codificação UTF-8.
getDataAsString(charset)StringConsegue os dados desse blob como uma string com a codificação especificada.
getHash()StringExtrai o hash de conteúdo SHA1 para este anexo.
getName()StringExtrai o nome desse blob.
getSize()IntegerExtrai o tamanho do anexo.
isGoogleType()BooleanRetorna se o 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 de uma string com codificação UTF-8.
setDataFromString(string, charset)BlobDefine os dados desse blob de uma string com a codificação especificada.
setName(name)BlobDefine o nome desse blob.

Documentação detalhada

copyBlob()

Retorna uma cópia desse blob.

Retornar

Blob: a nova cópia.


getAs(contentType)

Retorna os dados dentro deste 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, "myfile.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 dos Serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rígidas.

Parâmetros

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

Retornar

Blob: os dados como um blob.


getBytes()

Consegue os dados armazenados neste blob.

Retornar

Byte[]: os bytes armazenados.


getContentType()

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

Retornar

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


getDataAsString()

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

Retornar

String: os dados como uma string.


getDataAsString(charset)

Consegue os dados desse blob como uma string com a codificação especificada.

Parâmetros

NomeTipoDescrição
charsetStringO conjunto de caracteres a ser usado para codificar os dados neste blob como uma string.

Retornar

String: os dados como uma string.


getHash()

Extrai 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 adequados da API REST relacionada:

  • https://mail.google.com/

getName()

Extrai o nome desse blob.

Retornar

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


getSize()

Extrai o tamanho do anexo. Esse método é mais rápido do que chamar getBytes().length e não conta para a 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 adequados da API REST relacionada:

  • https://mail.google.com/

isGoogleType()

Retorna se o 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 puder ser adivinhado pela extensão.

Retornar

Blob: este blob, para encadeamento.


setDataFromString(string)

Define os dados desse blob de uma string com codificação UTF-8.

Parâmetros

NomeTipoDescrição
stringStringOs dados da string.

Retornar

Blob: este blob, para encadeamento.


setDataFromString(string, charset)

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

Parâmetros

NomeTipoDescrição
stringStringOs dados da string.
charsetStringO conjunto de caracteres a ser usado na interpretação da string como bytes.

Retornar

Blob: este blob, para encadeamento.


setName(name)

Define o nome desse blob.

Parâmetros

NomeTipoDescrição
nameStringO novo nome.

Retornar

Blob: este blob, para encadeamento.

Métodos obsoletos