Class GmailAttachment

GmailAttachment

Une pièce jointe de Gmail Il s'agit d'une Blob standard, mais elle comporte une méthode getSize() supplémentaire plus rapide que l'appel de getBytes().length et n'est pas comptabilisée 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 ce blob.
getAs(contentType)BlobRenvoie les données contenues dans cet objet sous forme d'objet 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 de cet objet blob.
getDataAsString()StringRécupère les données de ce blob sous forme de chaîne avec un 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 de contenu SHA1 pour cette pièce jointe.
getName()StringRécupère le nom de ce blob.
getSize()IntegerRécupère la taille de ce rattachement.
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 dans cet objet blob.
setContentTypeFromExtension()BlobDéfinit le type de contenu des octets de cet blob en fonction de l'extension de fichier.
setDataFromString(string)BlobDéfinit les données de cet objet blob à partir d'une chaîne encodée en 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 ce blob.

Documentation détaillée

copyBlob()

Renvoie une copie de ce blob.

Renvois

Blob : nouvelle copie


getAs(contentType)

Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Cependant, nous supposons que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversions, consultez la page Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides.

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 de cet objet blob.

Renvois

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


getDataAsString()

Récupère les données de ce blob sous forme de chaîne avec un 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 sous forme de chaîne.

Renvois

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


getHash()

Récupère le hachage de contenu SHA1 pour cette pièce jointe. Cette méthode n'est pas comptabilisée dans le quota de lecture de Gmail.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ce blob.

Renvois

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


getSize()

Récupère la taille de ce rattachement. 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 du rattachement, en octets.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ce blob est un fichier Google Workspace, false dans le cas contraire.


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 pour le chaînage.


setContentType(contentType)

Définit le type de contenu des octets dans cet objet blob.

Paramètres

NomTypeDescription
contentTypeStringNouveau ContentType.

Renvois

Blob : ce blob pour le chaînage.


setContentTypeFromExtension()

Définit le type de contenu des octets de cet blob en fonction de l'extension de fichier. ContentType est null s'il ne peut pas être deviné à partir de son extension.

Renvois

Blob : ce blob pour le chaînage.


setDataFromString(string)

Définit les données de cet objet blob à partir d'une chaîne encodée en UTF-8.

Paramètres

NomTypeDescription
stringStringDonnées de la chaîne.

Renvois

Blob : ce blob 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 pour le chaînage.


setName(name)

Définit le nom de ce blob.

Paramètres

NomTypeDescription
nameStringNouveau nom

Renvois

Blob : ce blob pour le chaînage.

Méthodes obsolètes