Class GmailAttachment

GmailAttachment

Une pièce jointe provenant de Gmail. Il s'agit d'un élément Blob standard, sauf qu'il comporte une méthode getSize() supplémentaire plus rapide que l'appel getBytes().length, et n'est pas comptabilisé dans le quota de lecture de 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éthodes

MéthodeType renvoyéBrève description
copyBlob()BlobRenvoie une copie de cet objet blob.
getAs(contentType)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getBytes()Byte[]Récupère les données stockées dans cet objet blob.
getContentType()StringRécupère le type de contenu des octets dans ce blob.
getDataAsString()StringRécupère les données de cet objet blob sous forme de chaîne avec encodage UTF-8.
getDataAsString(charset)StringRécupère les données de cet objet blob sous forme de chaîne avec l'encodage spécifié.
getHash()StringRécupère le hachage du contenu SHA1 de cette pièce jointe.
getName()StringRécupère le nom de cet objet blob.
getSize()IntegerRécupère la taille de cette pièce jointe.
isGoogleType()BooleanIndique si ce blob est un fichier Google Workspace (Sheets, Docs, etc.).
setBytes(data)BlobDéfinit les données stockées dans cet objet blob.
setContentType(contentType)BlobDéfinit le type de contenu des octets de ce blob.
setContentTypeFromExtension()BlobDéfinit le type de contenu des octets dans ce blob en fonction de l'extension du fichier.
setDataFromString(string)BlobDéfinit les données de ce blob à partir d'une chaîne encodée au format UTF-8.
setDataFromString(string, charset)BlobDéfinit les données de cet objet blob à partir d'une chaîne avec l'encodage spécifié.
setName(name)BlobDéfinit le nom de cet objet blob.

Documentation détaillée

copyBlob()

Renvoie une copie de cet objet blob.

Renvois

Blob : nouvelle copie.


getAs(contentType)

Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié. Ce ajoute l'extension appropriée au nom du fichier (par exemple, "myfile.pdf"). Cependant, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une à remplacer. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversion, consultez la page Quotas Services. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des règles des quotas.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' correspond à est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les valeurs 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' le sont également. valide. Pour un document Google Docs, 'text/markdown' est également valide.

Renvois

Blob : données sous forme de blob.


getBytes()

Récupère les données stockées dans cet objet blob.

Renvois

Byte[] : octets stockés.


getContentType()

Récupère le type de contenu des octets dans ce blob.

Renvois

String : type de contenu de ces données, s'il est connu, ou null.


getDataAsString()

Récupère les données de cet objet blob sous forme de chaîne avec encodage UTF-8.

Renvois

String : données sous forme de chaîne.


getDataAsString(charset)

Récupère les données de cet objet blob sous forme de chaîne avec l'encodage spécifié.

Paramètres

NomTypeDescription
charsetStringJeu de caractères à utiliser pour encoder les données de cet objet blob en tant que chaîne.

Renvois

String : données sous forme de chaîne.


getHash()

Récupère le hachage du contenu SHA1 de cette pièce jointe. Cette méthode n'est pas prise en compte le quota de lecture.

Renvois

String : hachage du contenu SHA1, sous forme de chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

getName()

Récupère le nom de cet objet blob.

Renvois

String : nom de ces données, s'il est connu, ou null.


getSize()

Récupère la taille de cette pièce jointe. Cette méthode est plus rapide que l'appel de getBytes().length et n'est pas comptabilisée dans le quota de lecture de Gmail.

Renvois

Integer : taille de la pièce jointe, en octets.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

isGoogleType()

Indique si ce blob est un fichier Google Workspace (Sheets, Docs, etc.).

Renvois

Boolean : true si cet blob est un fichier Google Workspace false si ce n'est pas le cas.


setBytes(data)

Définit les données stockées dans cet objet blob.

Paramètres

NomTypeDescription
dataByte[]Les nouvelles données.

Renvois

Blob : ce blob, utilisé pour le chaînage.


setContentType(contentType)

Définit le type de contenu des octets de ce blob.

Paramètres

NomTypeDescription
contentTypeStringLe nouveau contentType.

Renvois

Blob : ce blob, utilisé pour le chaînage.


setContentTypeFromExtension()

Définit le type de contenu des octets dans ce blob en fonction de l'extension du fichier. La valeur contentType est null s'il ne peut pas être deviné à partir de son extension.

Renvois

Blob : ce blob, utilisé pour le chaînage.


setDataFromString(string)

Définit les données de ce blob à partir d'une chaîne encodée au format UTF-8.

Paramètres

NomTypeDescription
stringStringDonnées de la chaîne.

Renvois

Blob : ce blob, utilisé pour le chaînage.


setDataFromString(string, charset)

Définit les données de cet objet blob à partir d'une chaîne avec l'encodage spécifié.

Paramètres

NomTypeDescription
stringStringDonnées de la chaîne.
charsetStringJeu de caractères à utiliser pour interpréter la chaîne en octets.

Renvois

Blob : ce blob, utilisé pour le chaînage.


setName(name)

Définit le nom de cet objet blob.

Paramètres

NomTypeDescription
nameStringNouveau nom

Renvois

Blob : ce blob, utilisé pour le chaînage.

Méthodes obsolètes