Class GmailAttachment

GmailAttachment

Um anexo do Gmail. Esse é um Blob normal, exceto pelo fato de ter um método getSize() extra que é mais rápido do que chamar getBytes().length e não é contabilizado na cota de leitura do Gmail.

// Logs information about any attachments in the first 100 inbox threads.
var threads = GmailApp.getInboxThreads(0, 100);
var msgs = GmailApp.getMessagesForThreads(threads);
for (var i = 0 ; i < msgs.length; i++) {
  for (var j = 0; j < msgs[i].length; j++) {
    var attachments = msgs[i][j].getAttachments();
    for (var 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)BlobRetorne 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()StringExtrai 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)StringRecebe os dados desse blob como uma string com a codificação especificada.
getHash()StringRecebe o hash de conteúdo SHA1 deste anexo.
getName()StringRecebe o nome desse blob.
getSize()IntegerExtrai o tamanho deste anexo.
isGoogleType()BooleanRetorna indicando 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 nesse 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.

Retorno

Blob: a nova cópia.


getAs(contentType)

Retorne 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, ela pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para ver as cotas diárias de conversões, consulte Cotas para Serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rigorosas.

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 no formato BMP, GIF, JPEG ou PNG, qualquer elemento 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido.

Retorno

Blob: os dados como um blob.


getBytes()

Recebe os dados armazenados neste blob.

Retorno

Byte[] — os bytes armazenados.


getContentType()

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

Retorno

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.

Retorno

String: os dados como uma string.


getDataAsString(charset)

Recebe os dados desse 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 nesse blob como uma string.

Retorno

String: os dados como uma string.


getHash()

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

Retorno

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 desse blob.

Retorno

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


getSize()

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

Retorno

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 indicando se o blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).

Retorno

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


setBytes(data)

Define os dados armazenados neste blob.

Parâmetros

NomeTipoDescrição
dataByte[]Os novos dados.

Retorno

Blob: esse blob para encadeamento.


setContentType(contentType)

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

Parâmetros

NomeTipoDescrição
contentTypeStringO novo contentType.

Retorno

Blob: esse blob para encadeamento.


setContentTypeFromExtension()

Define o tipo de conteúdo dos bytes nesse blob com base na extensão do arquivo. O contentType será null se não for possível deduzir a partir da extensão.

Retorno

Blob: esse 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.

Retorno

Blob: esse 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.

Retorno

Blob: esse blob para encadeamento.


setName(name)

Define o nome desse blob.

Parâmetros

NomeTipoDescrição
nameStringO novo nome.

Retorno

Blob: esse blob para encadeamento.

Métodos obsoletos