Class GmailApp

AppGmail

Fornisce l'accesso a thread, messaggi ed etichette di Gmail.

Metodi

Metodo	Tipo restituito	Breve descrizione
createDraft(recipient, subject, body)	GmailDraft	Crea una bozza di messaggio email.
createDraft(recipient, subject, body, options)	GmailDraft	Crea una bozza di email con argomenti facoltativi.
createLabel(name)	GmailLabel	Crea una nuova etichetta utente con il nome specificato.
deleteLabel(label)	GmailApp	Elimina l'etichetta specificata.
getAliases()	String[]	Recupera un elenco delle email configurate come alias per questo account in Gmail.
getDraft(draftId)	GmailDraft	Recupera la bozza di un messaggio email per ID.
getDraftMessages()	GmailMessage[]	Recupera tutte le bozze dei messaggi.
getDrafts()	GmailDraft[]	Recupera tutte le bozze dei messaggi Gmail.
getInboxThreads()	GmailThread[]	Recupera tutti i thread della posta in arrivo indipendentemente dalle etichette.
getInboxThreads(start, max)	GmailThread[]	Recupera un intervallo di thread della Posta in arrivo indipendentemente dalle etichette.
getInboxUnreadCount()	Integer	Restituisce il numero di thread non letti nella posta in arrivo.
getMessageById(id)	GmailMessage	Recupera un messaggio per ID.
getMessagesForThread(thread)	GmailMessage[]	Recupera tutti i messaggi nel thread specificato.
getMessagesForThreads(threads)	GmailMessage[][]	Recupera tutti i messaggi nei thread specificati.
getPriorityInboxThreads()	GmailThread[]	Recupera tutti i thread della Posta prioritaria indipendentemente dalle etichette.
getPriorityInboxThreads(start, max)	GmailThread[]	Recupera un intervallo di thread della Posta prioritaria indipendentemente dalle etichette.
getPriorityInboxUnreadCount()	Integer	Restituisce il numero di thread da leggere nella Posta prioritaria.
getSpamThreads()	GmailThread[]	Recupera tutti i thread di spam indipendentemente dalle etichette.
getSpamThreads(start, max)	GmailThread[]	Recupera un intervallo di thread di spam indipendentemente dalle etichette.
getSpamUnreadCount()	Integer	Restituisce il numero di thread da leggere che sono spam.
getStarredThreads()	GmailThread[]	Recupera tutti i thread speciali indipendentemente dalle etichette.
getStarredThreads(start, max)	GmailThread[]	Recupera un intervallo di thread speciali indipendentemente dalle etichette.
getStarredUnreadCount()	Integer	Restituisce il numero di thread da leggere che sono stati aggiunti ai preferiti.
getThreadById(id)	GmailThread|null	Recupera un thread in base all'ID.
getTrashThreads()	GmailThread[]	Recupera tutti i thread del cestino indipendentemente dalle etichette.
getTrashThreads(start, max)	GmailThread[]	Recupera un intervallo di thread del cestino indipendentemente dalle etichette.
getUserLabelByName(name)	GmailLabel	Recupera un'etichetta dato il nome.
getUserLabels()	GmailLabel[]	Recupera un elenco di etichette create dall'utente.
markMessageRead(message)	GmailApp	Contrassegna questo messaggio come letto e ne forza l'aggiornamento.
markMessageUnread(message)	GmailApp	Contrassegna questo messaggio come non letto e ne forza l'aggiornamento.
markMessagesRead(messages)	GmailApp	Contrassegna questi messaggi come letti e li aggiorna.
markMessagesUnread(messages)	GmailApp	Contrassegna questi messaggi come non letti e forza l'aggiornamento dei messaggi.
markThreadImportant(thread)	GmailApp	Contrassegna questo thread come importante e ne forza l'aggiornamento.
markThreadRead(thread)	GmailApp	Contrassegna questo thread come letto e ne forza l'aggiornamento.
markThreadUnimportant(thread)	GmailApp	Contrassegna questo thread come non importante e ne forza l'aggiornamento.
markThreadUnread(thread)	GmailApp	Contrassegna questo thread come da leggere e ne forza l'aggiornamento.
markThreadsImportant(threads)	GmailApp	Contrassegna questi thread come importanti e li aggiorna.
markThreadsRead(threads)	GmailApp	Contrassegna questi thread come letti e li aggiorna.
markThreadsUnimportant(threads)	GmailApp	Contrassegna questi thread come non importanti e li aggiorna.
markThreadsUnread(threads)	GmailApp	Contrassegna questi thread come da leggere e li aggiorna.
moveMessageToTrash(message)	GmailApp	Sposta il messaggio nel cestino e forza l'aggiornamento del messaggio.
moveMessagesToTrash(messages)	GmailApp	Sposta i messaggi specificati nel cestino e forza l'aggiornamento dei messaggi.
moveThreadToArchive(thread)	GmailApp	Sposta questo thread nell'archivio e lo aggiorna.
moveThreadToInbox(thread)	GmailApp	Sposta questo thread nella posta in arrivo e lo aggiorna.
moveThreadToSpam(thread)	GmailApp	Sposta questo thread nella cartella Spam e forza l'aggiornamento del thread.
moveThreadToTrash(thread)	GmailApp	Sposta questo thread nel cestino e ne forza l'aggiornamento.
moveThreadsToArchive(threads)	GmailApp	Sposta questi thread nell'archivio e li aggiorna.
moveThreadsToInbox(threads)	GmailApp	Sposta questi thread nella posta in arrivo e li aggiorna.
moveThreadsToSpam(threads)	GmailApp	Sposta questi thread nello spam e li aggiorna.
moveThreadsToTrash(threads)	GmailApp	Sposta questi thread nel cestino e li aggiorna.
refreshMessage(message)	GmailApp	Ricarica il messaggio e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura, ecc. siano cambiati).
refreshMessages(messages)	GmailApp	Ricarica i messaggi e lo stato associato da Gmail (utile se le etichette, lo stato di lettura, ecc. sono cambiati).
refreshThread(thread)	GmailApp	Ricarica la discussione e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura e così via siano cambiati).
refreshThreads(threads)	GmailApp	Ricarica i thread e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura, ecc. siano cambiati).
search(query)	GmailThread[]	Cerca in Gmail con la query specificata.
search(query, start, max)	GmailThread[]	Cerca in Gmail con la query specificata.
sendEmail(recipient, subject, body)	GmailApp	Invia un messaggio email.
sendEmail(recipient, subject, body, options)	GmailApp	Invia un messaggio email con argomenti facoltativi.
setCurrentMessageAccessToken(accessToken)	void	Imposta il token di accesso del messaggio corrente che consente allo script di accedere alle proprietà GmailMessage correnti.
starMessage(message)	GmailApp	Aggiunge una stella a questo messaggio e ne forza l'aggiornamento.
starMessages(messages)	GmailApp	Aggiunge stelle a questi messaggi e ne forza l'aggiornamento.
unstarMessage(message)	GmailApp	Rimuove la stella da questo messaggio e forza l'aggiornamento del messaggio.
unstarMessages(messages)	GmailApp	Rimuove le stelle da questi messaggi e li aggiorna.

Metodi ritirati

Metodo	Tipo restituito	Breve descrizione
getChatThreads()	GmailThread[]	Recupera tutti i thread della versione classica di Google Hangouts e di Google Chat fino a quando Google non eseguirà la transizione di tutti gli utenti della versione classica di Hangouts a Chat entro la fine dell'anno.
getChatThreads(start, max)	GmailThread[]	Riceve una serie di thread della versione classica di Google Hangouts e di Google Chat finché Google non trasferirà tutti gli utenti della versione classica di Hangouts a Chat entro la fine dell'anno.

Documentazione dettagliata

createDraft(recipient, subject, body)

Crea una bozza di messaggio email. Le dimensioni dell'email (incluse le intestazioni) sono limitate dalla quota.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parametri

Nome	Tipo	Descrizione
recipient	String	Elenco di indirizzi email separati da virgole
subject	String	oggetto dell'email
body	String	corpo dell'email

Indietro

GmailDraft: la bozza di Gmail appena creata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

Crea una bozza di email con argomenti facoltativi. L'email può contenere testo normale o un corpo HTML. Le dimensioni dell'email (incluse le intestazioni, ma esclusi gli allegati) sono limitate dalla quota.

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    '[e-mail]',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parametri

Nome	Tipo	Descrizione
recipient	String	gli indirizzi del destinatario
subject	String	la riga dell'oggetto
body	String	il corpo dell'email
options	Object	Un oggetto JavaScript che specifica i parametri avanzati, come elencati di seguito

Parametri avanzati

Nome	Tipo	Descrizione
attachments	BlobSource[]	un array di file da inviare con l'email
bcc	String	un elenco di indirizzi email separati da virgole da inserire in Ccn
cc	String	un elenco di indirizzi email separati da virgole da inserire in Cc
from	String	l'indirizzo da cui deve essere inviata l'email, che deve essere uno dei valori restituiti da getAliases()
htmlBody	String	Se impostato, i dispositivi in grado di eseguire il rendering di HTML lo utilizzeranno al posto dell'argomento body obbligatorio. Puoi aggiungere un campo inlineImages facoltativo nel corpo HTML se hai incorporato immagini per la tua email
inlineImages	Object	un oggetto JavaScript contenente una mappatura dalla chiave dell'immagine (String) ai dati dell'immagine (BlobSource); ciò presuppone che il parametro htmlBody venga utilizzato e contenga riferimenti a queste immagini nel formato <img src="cid:imageKey" />
name	String	Il nome del mittente dell'email (impostazione predefinita: il nome dell'utente)
replyTo	String	un indirizzo email da utilizzare come indirizzo predefinito per le risposte (impostazione predefinita: l'indirizzo email dell'utente)

Indietro

GmailDraft: la bozza di Gmail appena creata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• createDraft(recipient, subject, body)

---

createLabel(name)

Crea una nuova etichetta utente con il nome specificato.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parametri

Nome	Tipo	Descrizione
name	String	il nome della nuova etichetta

Indietro

GmailLabel: l'etichetta appena creata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• deleteLabel(label)

---

deleteLabel(label)

Elimina l'etichetta specificata.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Parametri

Nome	Tipo	Descrizione
label	GmailLabel	l'etichetta da eliminare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• createLabel(name)

---

getAliases()

Recupera un elenco delle email configurate come alias per questo account in Gmail.

Puoi inviare un messaggio da uno qualsiasi di questi alias utilizzando l'argomento facoltativo "Da".

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Indietro

String[]: un array di alias per questo account

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

Recupera la bozza di un messaggio email per ID.

Utilizzalo insieme a getId() nelle bozze di Gmail.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Parametri

Nome	Tipo	Descrizione
draftId	String	l'ID della bozza da recuperare

Indietro

GmailDraft: la bozza con l'ID specificato

Genera

Error: se non è possibile trovare alcuna bozza con l'ID specificato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getDraftMessages()

Recupera tutte le bozze dei messaggi.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Indietro

GmailMessage[]: un array di bozze di messaggi Gmail

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getDrafts()

Recupera tutte le bozze dei messaggi Gmail.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Indietro

GmailDraft[]: un array di bozze di messaggi Gmail

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getInboxThreads()

Recupera tutti i thread della posta in arrivo indipendentemente dalle etichette.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Indietro

GmailThread[]: un array di thread di Gmail nella Posta in arrivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getInboxThreads(start, max)

Recupera un intervallo di thread della Posta in arrivo indipendentemente dalle etichette.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread di Gmail nella Posta in arrivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getInboxUnreadCount()

Restituisce il numero di thread non letti nella posta in arrivo.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Indietro

Integer: il numero di thread nella posta in arrivo che contengono messaggi da leggere

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getMessageById(id)

Recupera un messaggio per ID.

Utilizzalo in combinazione con getId() nei messaggi Gmail.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

Parametri

Nome	Tipo	Descrizione
id	String	l'ID del messaggio da recuperare

Indietro

GmailMessage: il messaggio con l'ID specificato

Genera

Error: se non viene trovato alcun messaggio con l'ID specificato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• getThreadById(id)

---

getMessagesForThread(thread)

Recupera tutti i messaggi nel thread specificato.

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread di messaggi da recuperare

Indietro

GmailMessage[]: array di messaggi corrispondenti a questo thread

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Recupera tutti i messaggi nei thread specificati.

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	le conversazioni da recuperare

Indietro

GmailMessage[][]: un array di array di messaggi, in cui ogni elemento dell'array esterno corrisponde a un thread e l'array interno contiene i messaggi di quel thread

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Recupera tutti i thread della Posta prioritaria indipendentemente dalle etichette.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Indietro

GmailThread[]: un array di thread di Gmail nella Posta prioritaria

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getPriorityInboxThreads(start, max)

Recupera un intervallo di thread della Posta prioritaria indipendentemente dalle etichette.

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread di Gmail nella Posta prioritaria

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getPriorityInboxUnreadCount()

Restituisce il numero di thread da leggere nella Posta prioritaria.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Indietro

Integer: il numero di thread nella posta prioritaria che contengono messaggi da leggere

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getSpamThreads()

Recupera tutti i thread di spam indipendentemente dalle etichette.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

Indietro

GmailThread[]: un array di thread Gmail nella cartella Spam

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getSpamThreads(start, max)

Recupera un intervallo di thread di spam indipendentemente dalle etichette.

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread Gmail nella cartella Spam

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getSpamUnreadCount()

Restituisce il numero di thread da leggere che sono spam.

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

Indietro

Integer: il numero di thread di spam che contengono messaggi da leggere

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getStarredThreads()

Recupera tutti i thread speciali indipendentemente dalle etichette.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Indietro

GmailThread[]: un array di thread di Gmail aggiunti a Speciali

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getStarredThreads(start, max)

Recupera un intervallo di thread speciali indipendentemente dalle etichette.

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread di Gmail aggiunti a Speciali

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getStarredUnreadCount()

Restituisce il numero di thread da leggere che sono stati aggiunti ai preferiti.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Indietro

Integer: il numero di thread speciali con messaggi non letti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getThreadById(id)

Recupera un thread in base all'ID.

Utilizzalo insieme a getId() nei thread di Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

Parametri

Nome	Tipo	Descrizione
id	String	L'ID del thread da recuperare.

Indietro

GmailThread|null: il thread con l'ID specificato o null se non trovato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• getMessageById(id)

---

getTrashThreads()

Recupera tutti i thread del cestino indipendentemente dalle etichette.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

Indietro

GmailThread[]: un array di thread Gmail nel cestino

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getTrashThreads(start, max)

Recupera un intervallo di thread del cestino indipendentemente dalle etichette.

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread Gmail nel cestino

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getUserLabelByName(name)

Recupera un'etichetta dato il nome.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parametri

Nome	Tipo	Descrizione
name	String	il nome dell'etichetta da recuperare

Indietro

GmailLabel: l'etichetta Gmail con il nome specificato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getUserLabels()

Recupera un elenco di etichette create dall'utente.

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

Indietro

GmailLabel[]: array di etichette create dall'utente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

markMessageRead(message)

Contrassegna questo messaggio come letto e ne forza l'aggiornamento.

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da contrassegnare come letto

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markMessageUnread(message)

---

markMessageUnread(message)

Contrassegna questo messaggio come non letto e ne forza l'aggiornamento.

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da contrassegnare come da leggere

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markMessageRead(message)

---

markMessagesRead(messages)

Contrassegna questi messaggi come letti e li aggiorna.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	un array di messaggi da contrassegnare come letti

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

Contrassegna questi messaggi come non letti e forza l'aggiornamento dei messaggi.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	un array di messaggi da contrassegnare come da leggere

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markMessagesRead(messages)

---

markThreadImportant(thread)

Contrassegna questo thread come importante e ne forza l'aggiornamento.

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da contrassegnare come importante

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadUnimportant(thread)

---

markThreadRead(thread)

Contrassegna questo thread come letto e ne forza l'aggiornamento.

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da contrassegnare come letto

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

Contrassegna questo thread come non importante e ne forza l'aggiornamento.

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da contrassegnare come non importante

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadImportant(thread)

---

markThreadUnread(thread)

Contrassegna questo thread come da leggere e ne forza l'aggiornamento.

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da contrassegnare come da leggere

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadRead(thread)

---

markThreadsImportant(threads)

Contrassegna questi thread come importanti e li aggiorna.

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	un array di thread da contrassegnare come importanti

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

Contrassegna questi thread come letti e li aggiorna.

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	Un array di thread da contrassegnare come letti

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

Contrassegna questi thread come non importanti e li aggiorna.

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	Un array di thread da contrassegnare come non importanti

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

Contrassegna questi thread come da leggere e li aggiorna.

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	un array di thread da contrassegnare come da leggere

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• markThreadsRead(threads)

---

moveMessageToTrash(message)

Sposta il messaggio nel cestino e forza l'aggiornamento del messaggio.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da cestinare

Indietro

GmailApp: il servizio Gmail (utile per il concatenamento)

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveMessagesToTrash(messages)

---

moveMessagesToTrash(messages)

Sposta i messaggi specificati nel cestino e forza l'aggiornamento dei messaggi.

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	i messaggi da cestinare

Indietro

GmailApp: il servizio Gmail (utile per il concatenamento)

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

Sposta questo thread nell'archivio e lo aggiorna.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da archiviare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

Sposta questo thread nella posta in arrivo e lo aggiorna.

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da spostare nella posta in arrivo

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

Sposta questo thread nella cartella Spam e forza l'aggiornamento del thread.

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da spostare nello spam

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

Sposta questo thread nel cestino e ne forza l'aggiornamento.

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da cestinare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

Sposta questi thread nell'archivio e li aggiorna.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	un array di thread da archiviare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

Sposta questi thread nella posta in arrivo e li aggiorna.

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	Un array di thread da spostare nella posta in arrivo

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

Sposta questi thread nello spam e li aggiorna.

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	un array di thread da spostare nella cartella Spam

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

Sposta questi thread nel cestino e li aggiorna.

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	un array di thread da cestinare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

Ricarica il messaggio e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura, ecc. siano cambiati).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da aggiornare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• refreshMessages(messages)

---

refreshMessages(messages)

Ricarica i messaggi e lo stato associato da Gmail (utile se le etichette, lo stato di lettura, ecc. sono cambiati).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	i messaggi da aggiornare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• refreshMessage(message)

---

refreshThread(thread)

Ricarica la discussione e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura e così via siano cambiati).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parametri

Nome	Tipo	Descrizione
thread	GmailThread	il thread da aggiornare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• refreshThreads(threads)

---

refreshThreads(threads)

Ricarica i thread e lo stato associato da Gmail (utile nel caso in cui le etichette, lo stato di lettura, ecc. siano cambiati).

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parametri

Nome	Tipo	Descrizione
threads	GmailThread[]	i thread da aggiornare

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• refreshThread(thread)

---

search(query)

Cerca in Gmail con la query specificata.

Questa chiamata non andrà a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parametri

Nome	Tipo	Descrizione
query	String	la query di ricerca, così come la digiteresti in Gmail

Indietro

GmailThread[]: un array di thread di Gmail corrispondenti a questa query

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

search(query, start, max)

Cerca in Gmail con la query specificata.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parametri

Nome	Tipo	Descrizione
query	String	la query di ricerca, così come la digiteresti in Gmail
start	Integer	l'indice del thread iniziale
max	Integer	il numero massimo di thread da restituire

Indietro

GmailThread[]: un array di thread di Gmail corrispondenti a questa query

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

sendEmail(recipient, subject, body)

Invia un messaggio email. Le dimensioni dell'email (incluse le intestazioni) sono limitate dalla quota.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parametri

Nome	Tipo	Descrizione
recipient	String	Elenco di indirizzi email separati da virgole
subject	String	oggetto dell'email (massimo 250 caratteri)
body	String	corpo dell'email

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

Invia un messaggio email con argomenti facoltativi. L'email può contenere testo normale o un corpo HTML. Le dimensioni dell'email (incluse le intestazioni, ma esclusi gli allegati) sono limitate dalla quota.

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    '[e-mail]',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parametri

Nome	Tipo	Descrizione
recipient	String	gli indirizzi del destinatario
subject	String	la riga dell'oggetto (massimo 250 caratteri)
body	String	il corpo dell'email
options	Object	Un oggetto JavaScript che specifica i parametri avanzati, come elencati di seguito

Parametri avanzati

Nome	Tipo	Descrizione
attachments	BlobSource[]	un array di file da inviare con l'email
bcc	String	un elenco di indirizzi email separati da virgole da inserire in Ccn
cc	String	un elenco di indirizzi email separati da virgole da inserire in Cc
from	String	l'indirizzo da cui deve essere inviata l'email, che deve essere uno dei valori restituiti da getAliases()
htmlBody	String	Se impostato, i dispositivi in grado di eseguire il rendering di HTML lo utilizzeranno al posto dell'argomento body obbligatorio. Puoi aggiungere un campo inlineImages facoltativo nel corpo HTML se hai incorporato immagini per la tua email
inlineImages	Object	un oggetto JavaScript contenente una mappatura dalla chiave dell'immagine (String) ai dati dell'immagine (BlobSource); ciò presuppone che il parametro htmlBody venga utilizzato e contenga riferimenti a queste immagini nel formato <img src="cid:imageKey" />
name	String	Il nome del mittente dell'email (impostazione predefinita: il nome dell'utente)
noReply	Boolean	true se l'email deve essere inviata da un indirizzo email generico no-reply per scoraggiare i destinatari a rispondere alle email; questa opzione è possibile solo per gli account Google Workspace, non per gli utenti Gmail
replyTo	String	un indirizzo email da utilizzare come indirizzo predefinito per le risposte (impostazione predefinita: l'indirizzo email dell'utente)

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

Imposta il token di accesso del messaggio corrente che consente allo script di accedere alle proprietà GmailMessage correnti.

Solo i progetti di componenti aggiuntivi di Google Workspace che utilizzano gli ambiti dei messaggi attuali di Gmail richiedono questo metodo.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

Parametri

Nome	Tipo	Descrizione
accessToken	String	il token di accesso temporaneo ottenuto da un oggetto evento azione di un componente aggiuntivo Gmail.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

starMessage(message)

Aggiunge una stella a questo messaggio e ne forza l'aggiornamento.

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da aggiungere a Speciali

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• starMessages(messages)

---

starMessages(messages)

Aggiunge stelle a questi messaggi e ne forza l'aggiornamento.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	Un array di messaggi da aggiungere a Speciali

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• starMessage(message)

---

unstarMessage(message)

Rimuove la stella da questo messaggio e forza l'aggiornamento del messaggio.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parametri

Nome	Tipo	Descrizione
message	GmailMessage	il messaggio da rimuovere da Speciali

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• unstarMessages(messages)

---

unstarMessages(messages)

Rimuove le stelle da questi messaggi e li aggiorna.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parametri

Nome	Tipo	Descrizione
messages	GmailMessage[]	un array di messaggi da rimuovere da Speciali

Indietro

GmailApp: il servizio Gmail, utile per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

Vedi anche

• unstarMessage(message)

Metodi ritirati

getChatThreads()

Deprecato. Questa funzione è obsoleta e non deve essere utilizzata nei nuovi script.

Recupera tutti i thread della versione classica di Google Hangouts e di Google Chat finché Google non esegue la transizione di tutti gli utenti della versione classica di Hangouts a Chat entro la fine dell'anno. Per saperne di più, consulta Informazioni sul passaggio dalla versione classica di Hangouts a Google Chat.

Questa chiamata non va a buon fine quando la dimensione di tutti i thread è troppo grande per essere gestita dal sistema. Se la dimensione del thread è sconosciuta e potenzialmente molto grande, utilizza la chiamata "impaginata" e specifica gli intervalli dei thread da recuperare in ogni chiamata.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Indietro

GmailThread[]: un array di thread di chat di Gmail.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/

---

getChatThreads(start, max)

Deprecato. Questa funzione è obsoleta e non deve essere utilizzata nei nuovi script.

Riceve una serie di thread della versione classica di Google Hangouts e di Google Chat finché Google non trasferirà tutti gli utenti della versione classica di Hangouts a Chat entro la fine dell'anno. Per saperne di più, consulta Informazioni sul passaggio dalla versione classica di Hangouts a Google Chat.

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Parametri

Nome	Tipo	Descrizione
start	Integer	l'indice del primo thread da recuperare
max	Integer	il numero massimo di thread da recuperare

Indietro

GmailThread[]: un array di thread di Gmail di chat

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti o ambiti appropriati dell'API REST correlata:

• https://mail.google.com/