Articles /

Přehled Gmail API

Gmail API je RESTful API, které lze použít k přístupu k poštovním schránkám Gmailu a k odesílání pošty. Pro většinu webových aplikací (včetně mobilních aplikací) je rozhraní Gmail APInejlepší volbou pro autorizovaný přístup k datům Gmailu uživatele.

Rozhraní Gmail API poskytuje flexibilní, RESTful přístup ke schránce uživatele, s přirozeným rozhraním kThreads,Messages,Labels,Drafts,History a.Settings.Z vybraného moderního jazyka může vaše aplikace pomocí rozhraní API přidávat funkceGmailu, jako např:

  • Čtení zpráv ze služby Gmail
  • Odesílání e-mailových zpráv
  • Úprava štítků použitých na zprávy a vlákna
  • Vyhledávání konkrétních zpráv a vláken
  • Vytváření filtrů pro automatické označování, přeposílat nebo archivovat zprávy

Vše, co potřebujete k používání rozhraní Gmail API, je klientská knihovna pro zvolený jazyk a aplikace, která se umí ověřit jako uživatel Gmailu.

Typické případy použití

Aplikační rozhraní Gmail API lze použít v řadě různých aplikací, mezi něž patří,typicky:

  • Výběr, indexování a zálohování pošty pouze pro čtení
  • Správa štítků (přidávání/odebírání štítků)
  • Automatické nebo programové odesílání zpráv
  • Migrace e-mailových účtů od jiných poskytovatelů
  • Nastavení standardizovaných e-mailových podpisů pro uživatele v doméně

Jak zjistit více?

Pomocí této dokumentace můžete začít vytvářet aplikaci Gmail ještě dnes:

  • Knihovny klienta jsou k dispozici ke stažení vněkolika jazycích a zjednodušují zadávání požadavků API.
  • Témata průvodce pro vývojáře vám pomohou lépe pochopit, jak implementovat konkrétní případy použití.
  • V referenci API najdete podrobnosti o každémzdroji a metodě v rozhraní Gmail API.

Přehled API

Rozhraní Gmail API je webová služba: používá rozhraní RESTful API s užitečným zatížením JSON. tato část poskytuje obecný přehled funkcí API a jejich použití. Podrobné informace o prostředcích a metodách rozhraní API naleznete v referenci GmailAPI.

Klíčové typy prostředků

Api rozhraní Gmail API poskytuje několik typů prostředků:

  • Zprávy
  • Štítky
  • Odkazy
  • Historie
  • Vlákna
  • Nastavení

Zprávy a štítky jsou základní jednotky poštovní schránky. Drafty, historie a vlákna obsahují jednu nebo více zpráv s dalšími metadaty.

Zprávy jsou neměnné: lze je pouze vytvořit a odstranit. Nelze měnit žádné vlastnosti zpráv kromě štítků použitých pro danou zprávu.

Štítky slouží jako hlavní prostředek kategorizace a organizace zpráv a vláken. Štítek je ve vztahu mnoho k mnoha zprávám a vláknům:na jednu zprávu může být aplikováno více štítků a jeden štítek může být aplikován na více zpráv nebo vláken. Štítky také existují ve dvou typech:system a user. Systémové štítky, například INBOX, TRASH nebo SPAM, jsou vytvářeny interně a nelze je vytvářet, odstraňovat ani měnit. Některé systémové štítky, jako například INBOX, však mohou být použity na zprávy a vlákna nebo z nich odstraněny. Uživatelské štítky mohou být přidávány, odstraňovány nebo upravovány uživatelem nebo aplikací.

Drafty představují neodeslané zprávy. Samotné zprávy nelze po vytvoření upravovat, ale zprávu obsaženou v draftu lze nahradit.Odesláním draftu se draft automaticky odstraní a vytvoří se zpráva se systémovým štítkem SENT.

Historie je kolekce nedávno upravených zpráv v chronologickém pořadí.Zatímco historie je určena jako lehká metoda synchronizace klienta,obvykle obsahuje pouze záznamy o změnách za posledních 30 dní. V některých případech, například když klient příliš zastará, by se měl klient synchronizovat ručně.

Vlákna jsou kolekce zpráv, které představují konverzaci. Stejně jako zprávy mohou mít i vlákna přiřazeny štítky. Na rozdíl od zpráv však vlákna nelze vytvářet, pouze mazat. Zprávy však lze do vlákna vkládat.

Nastavení řídí, jak se funkce Gmailu chovají pro uživatele. Nastavení jsou k dispozici pro přístup POP a IMAP, přeposílání e-mailů, filtry,automatickou odpověď na dovolenou, aliasy pro odesílání, podpisy, delegáty a jazyk.

Auth a rozhraní Gmail API

Stejně jako ostatní rozhraní Google REST API používá rozhraní Gmail APIOAuth 2.0pro zpracování ověřování a autorizace. Vaše aplikace zadá jednu nebo víceoblastí: řetězce, které identifikují prostředky, k nimž potřebuje získat přístup. Tyto obory se používají společně se sadou tokenů k zabezpečení přístupu uživatele ke zdrojům.Obor představuje určitou formu přístupu k jednomu prostředku nebo například ke skupině prostředků:

  • Čtení zprávy ze služby Gmail (https://www.googleapis.com/auth/gmail.readonly)
  • Změna štítků použitých na vlákno nebo zprávu(https://www.googleapis.com/auth/gmail.modify)
  • Odeslání zprávy jménem uživatele(https://www.googleapis.com/auth/gmail.compose)

Ačkoli můžete volání autorizace webové služby explicitně kódovat, obvykle byste měli aplikaci zjednodušit použitím klientských knihoven Google APIdostupných pro mnoho programovacích jazyků.

Další informace o používání autorizace s rozhraním API služby Gmail naleznete v částiAutorizace aplikace pomocí služby Gmail.

Oblasti

Rozhraní API služby Gmail podporuje řadu jemných rozsahů autorizace, které umožňují pouze požadovanou úroveň přístupu. Tím, že si uživatelé vyžádají přístup na minimální požadované úrovni, mají větší jistotu při udělování přístupu ke své poštovní schránce.

Příklad případu použití

Považujte následující případ použití: vypsání stránky s vlákny pro aktuálně ověřeného uživatele (například v panelu posledních zpráv). abyste toho dosáhli, vaše aplikace by provedla následující kroky:

  1. Ověřte se jako uživatel pomocí rozsahuhttps://www.googleapis.com/auth/gmail.readonly.
  2. Volání metody API.GET https://www.googleapis.com/gmail/v1/users/<userId>/threads
  3. Zpracování vráceného seznamu vláken ve vaší aplikaci.

Skutečný ukázkový kód naleznete v příručce Quickstart pro zvolený jazyk.

Obvyklá použití

Tato část poskytuje velmi vysoký pohled na to, jak lze realizovat některé běžné případy použití. Podrobnější informace naleznete v příručkách pro vývojáře.

Odesílání zpráv Gmailu

Emaily jsou odesílány jako řetězce kódované base64url v rámci rawvlastnosti zprávy. Vytvoření a odeslání zprávy:

  1. Vytvořte obsah e-mailu nějakým vhodným způsobem, který může záviset na použitém programovacím jazyce.
  2. Vytvořte řetězcovou reprezentaci tohoto obsahu v kódování base64url.
  3. Vytvořte nový zdroj zpráv a nastavte jeho vlastnost raw na právě vytvořený řetězec base64url.
  4. Vyvolejte messages.sendpro odeslání zprávy.

Získání přijatých e-mailů

Při zadání ID e-mailu můžete získat jeho obsah pomocígetmetody zdroje Users.messages.

Při načítání zprávy můžete určit formát užitečného zatížení odpovědi.FULL (výchozí) formát vrací celou rozebranou zprávu v poli payload.MINIMAL formát vrací pouze metadata, jako jsou identifikátory a štítky.RAW formát vrací data jako řetězec kódovaný base64url v rámci vlastnosti raw.

Historie změn pošty

Změny zpráv jsou reprezentovány pomocíHistory objects. Vlastnoststart_history_id umožňuje nastavit, od kterého okamžiku chcetezměny vrátit. Některé změny mohou ovlivnit více než jednu zprávu a historie reprezentující tuto změnu bude obsahovat více zpráv.

Správa štítků

Štítky aplikované na vlákno se aplikují také na všechny zprávy v rámci vlákna. pokud je štítek odstraněn, je odstraněn ze všech vláken a zpráv, na které byl aplikován. Vlastnost messageListVisibility slouží k určení, zda se zprávy s tímto štítkem zobrazí v seznamu zpráv. Podobně se vlastnostlabelListVisibility používá k určení, zda se štítek objeví v seznamu štítků. Ke změně štítků aplikovaných na zprávy, respektive na vlákna, můžete použít metodumessages.modify nebothreads.modify.

.

Leave a Reply