Gmail je jednou z běžně používaných online aplikací pro odesílání a přijímání e-mailů. Kromě toho umožňuje práci s kalendáři, kontakty, chaty atd. a poskytuje různé další služby spolupráce. Nedávno jsme se v článku zabývali tím, jak importovat kontakty z účtu Gmail. Dnes se naučíte, jak vytvářet, aktualizovat a mazat kontakty v účtu Gmail pomocí Java.
- Java API pro správu kontaktů Gmail
- Vytvořte kontakt na Gmailu
- Aktualizujte kontakt na Gmailu
- Smazat kontakt na Gmailu
Java API pro vytváření, aktualizaci a mazání kontaktů Gmail
K vytváření a manipulaci s kontakty v účtu Gmail použijeme Aspose.Email for Java. Jedná se o funkčně bohaté API, které vám umožní vytvářet a odesílat e-maily a pracovat s oblíbenými e-mailovými klienty. Rozhraní API si můžete buď stáhnout, nebo jej nainstalovat pomocí následujících konfigurací Maven.
úložiště:
<repository>
<id>AsposeJavaAPI</id>
<name>Aspose Java API</name>
<url>http://repository.aspose.com/repo/</url>
</repository>
Závislost:
<dependency>
<groupId>com.aspose</groupId>
<artifactId>aspose-email</artifactId>
<version>22.3</version>
<classifier>jdk16</classifier>
</dependency>
Po instalaci API je potřeba vytvořit projekt na Google Developer Console, který vám umožní komunikovat s Gmailem. Chcete-li jej vytvořit, postupujte podle tohoto průvodce.
Nyní vytvořte pomocnou třídu s názvem GoogleOAuthHelper, která se postará o ověření účtu Gmail. Vytvořte také třídu s názvem OAuthUser pro ukládání informací o uživateli. Následuje kompletní implementace obou tříd.
public class OAuthUser {
String email;
String clientId;
String clientSecret;
String refreshToken;
}
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import javax.xml.bind.DatatypeConverter;
/**
* <p>
* Konzole pro vývojáře https://console.developers.google.com/projectselector/apis/credentials?pli=1
* Dokumentace https://developers.google.com/identity/protocols/OAuth2InstalledApp
* </p>
*/
class GoogleOAuthHelper {
public static final String AUTHORIZATION_URL = "https://accounts.google.com/o/oauth2/v2/auth";
public static final String TOKEN_REQUEST_URL = "https://oauth2.googleapis.com/token";
public static final String REDIRECT_URI = "urn:ietf:wg:oauth:2.0:oob";
public static final String REDIRECT_TYPE = "code";
public static final String SCOPE = "https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fcalendar" // Calendar
+ "+https%3A%2F%2Fwww.google.com%2Fm8%2Ffeeds%2F" // Contacts
+ "+https%3A%2F%2Fmail.google.com%2F"; // IMAP & SMTP
static String createCodeChalange() {
String verifierStr = UUID.randomUUID().toString() + "-" + UUID.randomUUID().toString();
System.out.println("Code Verifier: " + verifierStr);
MessageDigest digest;
try {
digest = MessageDigest.getInstance("SHA-256");
} catch (NoSuchAlgorithmException e) {
throw new IllegalAccessError(e.getMessage());
}
byte[] hash = digest.digest(verifierStr.getBytes(StandardCharsets.UTF_8));
String base64Hash = DatatypeConverter.printBase64Binary(hash);
base64Hash = base64Hash.split("=")[0];
base64Hash = base64Hash.replace('+', '-').replace('/', '_');
return base64Hash;
}
static String getAuthorizationCodeUrl(OAuthUser acc) {
return getAuthorizationCodeUrl(acc, SCOPE, REDIRECT_URI, REDIRECT_TYPE);
}
static String getAuthorizationCodeUrl(OAuthUser acc, String scope, String redirectUri, String responseType) {
System.out.println("---------------------------------------------------------");
System.out.println("------------- OAuth 2.0 AuthorizationCodeUrl -------------");
System.out.println("---------------------------------------------------------");
System.out.println("Login: " + acc.email);
String codeChallenge = createCodeChalange();
String state = urlEncode(UUID.randomUUID().toString());
String approveUrl = AUTHORIZATION_URL + "?client_id=" + acc.clientId + "&redirect_uri=" + redirectUri + "&response_type=" + responseType + "&scope=" + scope
+ "&code_challenge=" + codeChallenge + "&code_challenge_method=S256&state=" + state;
System.out.println("Approve Url: " + approveUrl);
return approveUrl;
}
static String urlEncode(String value) {
try {
return URLEncoder.encode(value, StandardCharsets.UTF_8.toString());
} catch (UnsupportedEncodingException e) {
throw new IllegalAccessError(e.getMessage());
}
}
static String urlDecode(String value) {
try {
return URLDecoder.decode(value, StandardCharsets.UTF_8.toString());
} catch (UnsupportedEncodingException e) {
throw new IllegalAccessError(e.getMessage());
}
}
static String getAccessTokenByAuthCode(String authorizationCode, String codeVerifier, OAuthUser user) {
String encodedParameters = "client_id=" + urlEncode(user.clientId) + "&client_secret=" + urlEncode(user.clientSecret) + "&code=" + urlEncode(authorizationCode)
+ "&code_verifier=" + codeVerifier + "&redirect_uri=" + urlEncode(REDIRECT_URI) + "&grant_type=authorization_code";
System.out.println("---------------------------------------------------------");
System.out.println("------------- OAuth 2.0 AccessTokenByAuthCode -------------");
System.out.println("---------------------------------------------------------");
System.out.println("Authorization code: " + authorizationCode);
String result = "";
Map<String, String> token = geToken(encodedParameters);
for (String key : token.keySet()) {
System.out.println(key + ": " + token.get(key));
if (key.equals("refresh_token")) {
result = token.get(key);
}
}
System.out.println("---------------------------------------------------------");
return result;
}
static String getAccessTokenByRefreshToken(OAuthUser user) {
String encodedParameters = "client_id=" + urlEncode(user.clientId) + "&client_secret=" + urlEncode(user.clientSecret) + "&refresh_token=" + urlEncode(user.refreshToken)
+ "&grant_type=refresh_token";
System.out.println("---------------------------------------------------------");
System.out.println("----------- OAuth 2.0 AccessTokenByRefreshToken -----------");
System.out.println("---------------------------------------------------------");
System.out.println("Login: " + user.email);
String result = "";
Map<String, String> token = geToken(encodedParameters);
for (String key : token.keySet()) {
System.out.println(key + ": " + token.get(key));
if (key.equals("access_token")) {
result = token.get(key);
}
}
System.out.println("---------------------------------------------------------");
return result;
}
static Map<String, String> geToken(String encodedParameters) {
try {
HttpURLConnection connection = (HttpURLConnection) new URL(TOKEN_REQUEST_URL).openConnection();
connection.setRequestMethod("POST");
byte[] requestData = encodedParameters.getBytes(StandardCharsets.UTF_8);
connection.setUseCaches(false);
connection.setDoInput(true);
connection.setDoOutput(true);
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
connection.setRequestProperty("Content-Length", "" + requestData.length);
final OutputStream st = connection.getOutputStream();
try {
st.write(requestData, 0, requestData.length);
} finally {
st.flush();
st.close();
}
connection.connect();
if (connection.getResponseCode() >= HttpURLConnection.HTTP_BAD_REQUEST) {
throw new IllegalAccessError("Operation failed: " + connection.getResponseCode() + "/" + connection.getResponseMessage() + "\r\nDetails:\r\n{2}"
+ readInputStream(connection.getErrorStream()));
}
String responseText = readInputStream(connection.getInputStream());
Map<String, String> result = new HashMap<String, String>();
System.out.println(responseText);
String[] strs = responseText.replace("{", "").replace("}", "").replace("\"", "").replace("\r", "").replace("\n", "").split(",");
for (String sPair : strs) {
String[] pair = sPair.split(":");
String name = pair[0].trim().toLowerCase();
String value = urlDecode(pair[1].trim());
result.put(name, value);
}
return result;
} catch (IOException e) {
throw new IllegalAccessError(e.getMessage());
}
}
static String readInputStream(InputStream is) {
if (is == null)
return "";
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
StringBuilder result = new StringBuilder();
String line;
try {
while ((line = reader.readLine()) != null) {
result.append(line);
}
} catch (IOException e) {
// ignorovat
}
return result.toString();
}
}
Vytvořte kontakt na Gmailu v Javě
Níže jsou uvedeny kroky k vytvoření kontaktu na Gmailu v Javě.
- Nejprve vytvořte uživatele Google, získejte přístupový token a inicializujte objekt IGmailClient.
- Poté vytvořte objekt třídy Contact.
- Nastavte vlastnosti kontaktu, jako je jméno, předčíslí, povolání atd.
- Chcete-li nastavit poštovní adresu, vytvořte instanci PostalAddress a nastavte její vlastnosti.
- Přidejte nově vytvořenou adresu do kolekce pomocí metody Contact.getPhysicalAddresses().add(PostalAddress).
- Nastavte podrobnosti o telefonním čísle pomocí třídy PhoneNumber.
- Přidejte podrobnosti o telefonním čísle do sbírky pomocí metody Contact.getPhoneNumbers().add(PhoneNumber).
- Vytvořte instanci třídy EmailAddress, nastavte e-mailovou adresu a přiřaďte ji kontaktu.
- Nakonec zavolejte metodu IGmailClient.createContact(Contact) a vytvořte kontakt Gmail.
Následující ukázka kódu ukazuje, jak vytvořit kontakt na Gmailu v Javě.
OAuthUser user = new OAuthUser();
// Nastavte clientId, clientSecret a email
user.clientId = "<<clientID>>";
user.clientSecret = "<<clientSecret>>";
user.email = "<<email>>";
// AuthorizationCode musíte načíst ručně pomocí vygenerovaného AuthorizationCodeUrl
// Nastavte autorizační kód
String authorizationCode = "<<authCode>>";
// Zkopírujte ověřovací kód z výstupu předchozího kroku
// Nastavit codeVerifier
String codeVerifier = "<<codeVerifier>>";
// Získejte obnovovací token
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;
// Získejte přístupový token
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);
// Použijte přístupový token v API
IGmailClient client = GmailClient.getInstance(accessToken, user.email);
// Vytvořte kontakt
Contact contact = new Contact();
contact.setPrefix("Prefix");
contact.setGivenName("GivenName");
contact.setSurname("Surname");
contact.setMiddleName("MiddleName");
contact.setDisplayName("DisplayName");
contact.setSuffix("Suffix");
contact.setJobTitle("JobTitle");
contact.setDepartmentName("DepartmentName");
contact.setCompanyName("CompanyName");
contact.setProfession("Profession");
contact.setNotes("Notes");
// Nastavte poštovní adresu
PostalAddress address = new PostalAddress();
address.setCategory(PostalAddressCategory.getWork());
address.setAddress("Address");
address.setStreet("Street");
address.setPostOfficeBox("PostOfficeBox");
address.setCity("City");
address.setStateOrProvince("StateOrProvince");
address.setPostalCode("PostalCode");
address.setCountry("Country");
contact.getPhysicalAddresses().add(address);
// Nastavit telefonní číslo
PhoneNumber pnWork = new PhoneNumber();
pnWork.setNumber("323423423423");
pnWork.setCategory(PhoneNumberCategory.getWork());
contact.getPhoneNumbers().add(pnWork);
PhoneNumber pnHome = new PhoneNumber();
pnHome.setNumber("323423423423");
pnHome.setCategory(PhoneNumberCategory.getHome());
contact.getPhoneNumbers().add(pnHome);
PhoneNumber pnMobile = new PhoneNumber();
pnMobile.setNumber("323423423423");
pnMobile.setCategory(PhoneNumberCategory.getMobile());
contact.getPhoneNumbers().add(pnMobile);
// Nastavte další podrobnosti
contact.getUrls().setBlog("Blog.com");
contact.getUrls().setBusinessHomePage("BusinessHomePage.com");
contact.getUrls().setHomePage("HomePage.com");
contact.getUrls().setProfile("Profile.com");
contact.getEvents().setBirthday(new Date());
contact.getEvents().setAnniversary(new Date());
contact.getInstantMessengers().setAIM("AIM");
contact.getInstantMessengers().setGoogleTalk("GoogleTalk");
contact.getInstantMessengers().setICQ("ICQ");
contact.getInstantMessengers().setJabber("Jabber");
contact.getInstantMessengers().setMSN("MSN");
contact.getInstantMessengers().setQQ("QQ");
contact.getInstantMessengers().setSkype("Skype");
contact.getInstantMessengers().setYahoo("Yahoo");
contact.getAssociatedPersons().setSpouse("Spouse");
contact.getAssociatedPersons().setSister("Sister");
contact.getAssociatedPersons().setRelative("Relative");
contact.getAssociatedPersons().setReferredBy("ReferredBy");
contact.getAssociatedPersons().setPartner("Partner");
contact.getAssociatedPersons().setParent("Parent");
contact.getAssociatedPersons().setMother("Mother");
contact.getAssociatedPersons().setManager("Manager");
// Nastavte e-mailovou adresu
EmailAddress eAddress = new EmailAddress();
eAddress.setAddress("email@gmail.com");
contact.getEmailAddresses().add(eAddress);
// Vytvořte kontakt
String contactUri = client.createContact(contact);
Aktualizujte kontakt na Gmailu v Javě
Po otevření kontaktu v Gmailu můžete také aktualizovat podrobnosti. Níže jsou uvedeny kroky k aktualizaci kontaktu v účtu Gmail v jazyce Java.
- Nejprve vytvořte uživatele Google, získejte přístupový token a inicializujte objekt IGmailClient.
- Poté získejte kontakty v poli pomocí metody IGmailClient.getAllContacts().
- Poté načtěte požadovaný kontakt z pole v objektu Contact.
- Nakonec aktualizujte podrobnosti kontaktu a zavolejte metodu IGmailClient.updateContact(contact).
Následující ukázka kódu ukazuje, jak aktualizovat kontakt v Gmailu v Javě.
OAuthUser user = new OAuthUser();
// Nastavte clientId, clientSecret a email
user.clientId = "<<clientID>>";
user.clientSecret = "<<clientSecret>>";
user.email = "<<email>>";
// AuthorizationCode musíte načíst ručně pomocí vygenerovaného AuthorizationCodeUrl
// Nastavte autorizační kód
String authorizationCode = "<<authCode>>";
// Zkopírujte ověřovací kód z výstupu předchozího kroku
// Nastavit codeVerifier
String codeVerifier = "<<codeVerifier>>";
// Získejte obnovovací token
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;
// Získejte přístupový token
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);
// Použijte přístupový token v API
IGmailClient client = GmailClient.getInstance(accessToken, user.email);
// Získejte všechny kontakty
Contact[] contacts = client.getAllContacts();
// Vyžádejte si jeden
Contact contact = contacts[0];
contact.setJobTitle("Manager IT");
contact.setDepartmentName("Customer Support");
contact.setCompanyName("Aspose");
contact.setProfession("Software Developer");
// Aktualizujte kontakt
client.updateContact(contact);
Smazat kontakt na Gmailu v Javě
Nakonec se podívejme, jak odstranit kontakt Gmail pomocí Java. Následují kroky k provedení této operace.
- Nejprve vytvořte uživatele Google, získejte přístupový token a inicializujte objekt IGmailClient.
- Poté získejte kontakty v poli pomocí metody IGmailClient.getAllContacts().
- Filtrujte požadovaný kontakt z pole v objektu Contact.
- Nakonec zavolejte metodu IGmailClient.deleteContact(Contact.Id.GoogleId) a kontakt smažte.
Následující ukázka kódu ukazuje, jak odstranit kontakt na Gmailu v Javě.
OAuthUser user = new OAuthUser();
// Nastavte clientId, clientSecret a email
user.clientId = "<<clientID>>";
user.clientSecret = "<<clientSecret>>";
user.email = "<<email>>";
// AuthorizationCode musíte načíst ručně pomocí vygenerovaného AuthorizationCodeUrl
// Nastavte autorizační kód
String authorizationCode = "<<authCode>>";
// Zkopírujte ověřovací kód z výstupu předchozího kroku
// Nastavit codeVerifier
String codeVerifier = "<<codeVerifier>>";
// Získejte obnovovací token
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;
// Získejte přístupový token
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);
// Použijte přístupový token v API
IGmailClient client = GmailClient.getInstance(accessToken, user.email);
// Získejte všechny kontakty
Contact[] contacts = client.getAllContacts();
// Vyžádejte si jeden
Contact contact = contacts[0];
// Smazat kontakt
client.deleteContact(contact.getId().getGoogleId());
Získejte bezplatnou licenci API
Aspose.Email pro Javu můžete používat bez omezení hodnocení pomocí bezplatné dočasné licence.
Závěr
V tomto článku jste se naučili, jak vytvářet a aktualizovat kontakty v účtu Gmail v Javě. Dále jste viděli, jak programově odstranit kontakt Gmail. Kromě toho můžete navštívit dokumentaci a prozkoumat další funkce Aspose.Email pro Java. V případě, že byste měli nějaké dotazy, můžete psát na naše fórum.