Gmail API áttekintés

A Gmail API egy RESTful API, amely a Gmail postafiókok elérésére és levelek küldésére használható. A legtöbb webes alkalmazás (beleértve a mobilalkalmazásokat is) számára a Gmail API a legjobb választás a felhasználó Gmail adataihoz való engedélyezett hozzáféréshez.

A Gmail API rugalmas, RESTful hozzáférést biztosít a felhasználó postaládájához, természetes interfésszelThreads,Messages,Labels,Drafts,History, és.Settings.Az Ön által választott modern nyelvből az alkalmazás az API segítségével olyanGmail funkciókat adhat hozzá, mint:

• Üzenetek olvasása a Gmailből
• E-mail üzenetek küldése
• Üzenetekre és szálakra alkalmazott címkék módosítása
• Specifikus üzenetek és szálak keresése
• Szűrők létrehozása automatikus címkézéshez, továbbítani vagy archiválni az üzeneteket

A Gmail API használatához mindössze a választott nyelv klienskönyvtárára és egy olyan alkalmazásra van szükség, amely képes Gmail felhasználóként hitelesíteni magát.

Típusos felhasználási esetek

A Gmail API számos különböző alkalmazásban használható, többek között jellemzően:

• Csak olvasható levelek kinyerése, indexelése és mentése
• Címkek kezelése (címkék hozzáadása/eltávolítása)
• Automatizált vagy programozott üzenetküldés
• E-mail fiókok migrálása más szolgáltatóktól
• Egy tartomány felhasználóinak szabványos e-mail aláírások beállítása

Hogyan tudhatok meg többet?

A dokumentáció segítségével még ma elkezdheti egy Gmail-alkalmazás létrehozását:

• A klienskönyvtárak több nyelven is letölthetők, és leegyszerűsítik az API-kéréseket.
• A fejlesztői útmutató témái segítenek jobban megérteni az egyes felhasználási esetek megvalósítását.
• Az API-hivatkozás részletesen ismerteti a Gmail API minden forrását és módszerét.

API áttekintés

A Gmail API egy webszolgáltatás: RESTful API-t használ JSON hasznos teherrel.Ez a szakasz általános áttekintést nyújt az API funkcióiról és azok használatáról. Az API erőforrásaival és módszereivel kapcsolatos részletes információkért olvassa el a GmailAPI-referenciát.

Főbb erőforrástípusok

A Gmail API számos erőforrástípust biztosít:

• Messages
• Labels
• Drafts
• History
• Thistory
• Threads
• Settings

Az üzenetek és a címkék a postafiók alapvető egységei. A vázlatok, a history és athreads egy vagy több üzenetet tartalmaznak további metaadatokkal.

Az üzenetek megváltoztathatatlanok: csak létrehozni és törölni lehet őket. Az üzenetek tulajdonságai nem módosíthatók, kivéve az adott üzenetre alkalmazott címkéket.

A címkék szolgálnak az üzenetek és a szálak kategorizálásának és rendszerezésének elsődleges eszközeként. Egy címke sok-sok viszonyban áll az üzenetekkel és a szálakkal: egyetlen üzenethez több címke is rendelhető, és egyetlen címke több üzenethez vagy szálhoz is rendelhető. A címkéknek két típusa van:system és user. A rendszercímkék, mint például a INBOX, TRASH vagy SPAM, belsőleg jönnek létre, és nem hozhatók létre, törölhetők vagy módosíthatók. Néhány rendszercímke azonban, mint például a INBOX, alkalmazható üzenetekre és futamokra, illetve eltávolítható azokból. A felhasználói címkéket a felhasználó vagy egy alkalmazás adhatja hozzá, törölheti vagy módosíthatja.

A vázlatok el nem küldött üzeneteket jelentenek. Maguk az üzenetek a létrehozás után nem módosíthatók, de a vázlatban szereplő üzenet kicserélhető.A vázlat elküldése automatikusan törli a vázlatot, és létrehoz egy üzenetet a SENT rendszercímkével.

A history a nemrég módosított üzenetek gyűjteménye időrendi sorrendben.Bár a history az ügyfél szinkronizálásának könnyített módszerére szolgál, általában csak az elmúlt 30 napban történt változásokat tartalmazza. Bizonyos esetekben, például amikor egy ügyfél túlságosan elavul, az ügyfélnek manuálisan kell szinkronizálnia.

A szálak üzenetek gyűjteményei, amelyek egy beszélgetést képviselnek. Az üzenetekhez hasonlóan a szálak is kaphatnak címkéket. Az üzenetekkel ellentétben azonban a szálakat nem lehet létrehozni, csak törölni. Üzeneteket azonban be lehet illeszteni egy szálba.

A beállítások szabályozzák, hogy a Gmail funkciói hogyan viselkedjenek a felhasználó számára. A beállítások elérhetők a POP és IMAP hozzáféréshez, az e-mail továbbításhoz, a szűrőkhöz, a nyaralás automatikus válaszához, a küldési aliasokhoz, az aláírásokhoz, a delegáltakhoz és a nyelvhez.

Auth és a Gmail API

A többi Google REST API-hoz hasonlóan a Gmail API is azOAuth 2.0-t használja a hitelesítés és engedélyezés kezelésére. Az alkalmazás egy vagy több scope-t ad meg: olyan karakterláncokat, amelyek azonosítják azokat az erőforrásokat, amelyekhez hozzá kell férnie. Ezeket a hatóköröket egy token-készlettel együtt használják, hogy biztosítsák a felhasználó hozzáférését az erőforrásokhoz.A hatókör például egy erőforráshoz vagy erőforráscsoporthoz való hozzáférés egy bizonyos formáját jelenti:

• Elolvas egy üzenetet a Gmailből (https://www.googleapis.com/auth/gmail.readonly)
• Egy szálra vagy üzenetre alkalmazott címkék módosítása(https://www.googleapis.com/auth/gmail.modify)
• Üzenet küldése egy felhasználó nevében(https://www.googleapis.com/auth/gmail.compose)

Noha a webszolgáltatás engedélyezési hívásait explicit módon is kódolhatja, az alkalmazást általában a számos programozási nyelven elérhető Google API ügyfélkönyvtárak használatával kell egyszerűsítenie.

Az auth használatáról a Gmail API-val bővebben aAz alkalmazás engedélyezése a Gmail-lel című fejezetben olvashat.

Scopes

A Gmail API számos finomra szabott engedélyezési tartományt támogat, hogy csak a szükséges szintű hozzáférést engedélyezze. A minimálisan szükséges szintű hozzáférés kérésével a felhasználók nagyobb biztonságban érzik magukat, ha hozzáférést biztosítanak a postafiókjukhoz.

Példa használati eset

Gondoljunk a következő használati esetre: az aktuálisan hitelesített felhasználóhoz tartozó szálak egy oldalának kinyomtatása (például a legutóbbi üzenetek panelen).Ennek eléréséhez az alkalmazás a következő lépéseket hajtaná végre:

1. Hitelesítse magát felhasználóként, ahttps://www.googleapis.com/auth/gmail.readonly hatókör használatával.
2. Hívja meg az API metódust.GET https://www.googleapis.com/gmail/v1/users/<userId>/threads
3. Feldolgozza a visszaadott szálak listáját az alkalmazásban.

A tényleges példakódot a választott nyelv gyorsindításában találja.

Gyakori felhasználások

Ez a szakasz nagyon magas szintű áttekintést nyújt néhány gyakori felhasználási eset megvalósításáról. További részletekért lásd a fejlesztői útmutatókat.

Gmail üzenetek küldése

Az e-mailek küldése base64url kódolt karakterláncokként történik az üzenet rawtulajdonságán belül. Egy üzenet létrehozásához és elküldéséhez:

1. Elkészíti az e-mail tartalmát valamilyen kényelmes módon, ami függhet az Ön által használt programozási nyelvtől.
2. Elkészíti a tartalom base64url kódolású string reprezentációját.
3. Hozzon létre egy új üzenetforrást, és állítsa annak raw tulajdonságát az imént létrehozott base64url stringre.
4. Hívja a messages.sendet az üzenet elküldéséhez.

Vett e-mailek lekérése

Egy e-mail azonosítóját megadva, a Users.messages erőforrás getmódszerével lekérheti annak tartalmát.

Az üzenet lekérdezésekor megadhatja a válasz payload formátumát.FULL (alapértelmezett) formátum a teljes elemzett üzenetet adja vissza a payload mezőben.MINIMAL formátum csak a metaadatokat, például az azonosítókat és címkéket adja vissza.RAW formátum az adatokat base64url kódolt karakterláncként adja vissza a raw tulajdonságban.

A levelek változásainak előzményei

Az üzenetváltozásokat aHistory objects jelöli. Astart_history_id tulajdonság segítségével beállíthatja, hogy mikortól szeretné visszakapni a változásokat. Egyes változások egynél több üzenetet is érinthetnek, így az adott változást reprezentáló előzmények több üzenetet is tartalmazni fognak.

Címkek kezelése

A szálra alkalmazott címkék a szálon belüli összes üzenetre is vonatkoznak.Ha egy címkét törölnek, az eltávolításra kerül az összes szálról és üzenetről, amelyre alkalmazták. A messageListVisibility tulajdonság határozza meg, hogy az ezzel a címkével ellátott üzenetek megjelennek-e az üzenetek listájában. Hasonlóképpen, alabelListVisibility tulajdonság annak meghatározására szolgál, hogy a címke megjelenik-e a címkék listájában. Azmessages.modify vagythreads.modify módszerrel megváltoztathatja az üzenetekre vagy a szálakra alkalmazott címkéket.