Class GmailAttachment

GmailAttachment

Es un archivo adjunto de Gmail. Este es un Blob normal, excepto que tiene un método getSize() adicional que es más rápido que llamar a getBytes().length y no se incluye en la cuota de lectura de 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 datos que se devuelveDescripción breve
copyBlob()BlobDevuelve una copia de este BLOB.
getAs(contentType)BlobDevuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getBytes()Byte[]Obtiene los datos almacenados en este blob.
getContentType()String|nullObtiene el tipo de contenido de los bytes en este BLOB.
getDataAsString()StringObtiene los datos de este BLOB como una cadena con codificación UTF-8.
getDataAsString(charset)StringObtiene los datos de este BLOB como una cadena con la codificación especificada.
getHash()StringObtiene el hash de contenido SHA1 de este adjunto.
getName()String|nullObtiene el nombre de este blob.
getSize()IntegerObtiene el tamaño de este adjunto.
isGoogleType()BooleanDevuelve si este BLOB es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).
setBytes(data)BlobEstablece los datos almacenados en este blob.
setContentType(contentType)BlobEstablece el tipo de contenido de los bytes en este BLOB.
setContentTypeFromExtension()BlobEstablece el tipo de contenido de los bytes en este blob según la extensión del archivo.
setDataFromString(string)BlobEstablece los datos de este BLOB a partir de una cadena con codificación UTF-8.
setDataFromString(string, charset)BlobEstablece los datos de este blob a partir de una cadena con la codificación especificada.
setName(name)BlobEstablece el nombre de este blob.

Documentación detallada

copyBlob()

Devuelve una copia de este BLOB.

Volver

Blob: Es la copia nueva.


getAs(contentType)

Devuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, supone que la parte del nombre de archivo que sigue al último punto (si lo hay) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas para los servicios de Google. Es posible que los dominios de Google Workspace creados recientemente estén sujetos temporalmente a cuotas más estrictas.

Parámetros

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se convertirá el archivo. Para la mayoría de los BLOBs, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. En el caso de un documento de Documentos de Google, 'text/markdown' también es un valor válido.

Volver

Blob: Son los datos como un BLOB.


getBytes()

Obtiene los datos almacenados en este blob.

Volver

Byte[]: Son los bytes almacenados.


getContentType()

Obtiene el tipo de contenido de los bytes en este BLOB.

Volver

String|null: Es el tipo de contenido de estos datos, si se conoce, o null.


getDataAsString()

Obtiene los datos de este BLOB como una cadena con codificación UTF-8.

Volver

String: Los datos como una cadena.


getDataAsString(charset)

Obtiene los datos de este BLOB como una cadena con la codificación especificada.

Parámetros

NombreTipoDescripción
charsetStringEs el conjunto de caracteres que se usará para codificar los datos de este BLOB como una cadena.

Volver

String: Los datos como una cadena.


getHash()

Obtiene el hash de contenido SHA1 de este adjunto. Este método no se incluye en la cuota de lectura de Gmail.

Volver

String: Es el hash de contenido SHA1, como una cadena.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

  • https://mail.google.com/

getName()

Obtiene el nombre de este blob.

Volver

String|null: Es el nombre de estos datos, si se conoce, o null.


getSize()

Obtiene el tamaño de este adjunto. Este método es más rápido que llamar a getBytes().length y no se incluye en la cuota de lectura de Gmail.

Volver

Integer: Es el tamaño del adjunto, en bytes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

  • https://mail.google.com/

isGoogleType()

Devuelve si este BLOB es un archivo de Google Workspace (Hojas de cálculo, Documentos, etcétera).

Volver

Boolean: true si este blob es un archivo de Google Workspace; false si no lo es.


setBytes(data)

Establece los datos almacenados en este blob.

Parámetros

NombreTipoDescripción
dataByte[]Son los datos nuevos.

Volver

Blob: Este BLOB, para encadenar.


setContentType(contentType)

Establece el tipo de contenido de los bytes en este BLOB.

Parámetros

NombreTipoDescripción
contentTypeStringEs el nuevo valor de contentType.

Volver

Blob: Este BLOB, para encadenar.


setContentTypeFromExtension()

Establece el tipo de contenido de los bytes en este blob según la extensión del archivo. El valor de contentType es null si no se puede inferir a partir de su extensión.

Volver

Blob: Este BLOB, para encadenar.


setDataFromString(string)

Establece los datos de este BLOB a partir de una cadena con codificación UTF-8.

Parámetros

NombreTipoDescripción
stringStringSon los datos de cadena.

Volver

Blob: Este BLOB, para encadenar.


setDataFromString(string, charset)

Establece los datos de este blob a partir de una cadena con la codificación especificada.

Parámetros

NombreTipoDescripción
stringStringSon los datos de cadena.
charsetStringEs el conjunto de caracteres que se usará para interpretar la cadena como bytes.

Volver

Blob: Este BLOB, para encadenar.


setName(name)

Establece el nombre de este blob.

Parámetros

NombreTipoDescripción
nameStringEs el nombre nuevo.

Volver

Blob: Este BLOB, para encadenar.

Métodos obsoletos