Cette page a été traduite par l'API Cloud Translation.

Class GmailAttachment

Pièce jointe Gmail. Il s'agit d'un Blob standard, à l'exception d'une méthode getSize() supplémentaire qui est plus rapide que d'appeler getBytes().length et qui n'est pas comptabilisée dans le quota de lecture 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éthodes

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

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getAllBlobs()`	`Blob[]`	Récupère tous les blobs contenus dans ce blob (éventuellement composite).

Documentation détaillée

`copyBlob()`

Renvoie une copie de ce blob.

Renvois

Blob : nouvelle copie.

`getAs(contentType)`

Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "monfichier.pdf"). Toutefois, il suppose 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 afficher les quotas quotidiens pour les conversions, consultez la section Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

Nom	Type	Description
`contentType`	`String`	Type 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, les valeurs `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` sont également valides. 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 ce blob.

Renvois

Byte[] : octets stockés.

`getContentType()`

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

Renvois

String : type de contenu de ces données, le cas échéant, ou null.

`getDataAsString()`

Récupère les données de ce blob sous la forme d'une chaîne encodée en UTF-8.

Renvois

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

`getDataAsString(charset)`

Récupère les données de ce blob sous la forme d'une chaîne avec l'encodage spécifié.

Paramètres

Nom	Type	Description
`charset`	`String`	Encodage de caractères à utiliser pour encoder les données de ce blob sous forme de chaîne.

Renvois

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

`getHash()`

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

Renvois

String : hachage SHA-1 du contenu, sous forme de chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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, le cas échéant, ou null.

`getSize()`

Récupère la taille de cette pièce jointe. Cette méthode est plus rapide que d'appeler getBytes().length et n'est pas prise en compte dans le quota de lecture Gmail.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 sinon.

`setBytes(data)`

Définit les données stockées dans ce blob.