使用 Java 在 Gmail 中创建、更新和删除联系人

Gmail 是常用的在线收发电子邮件应用程序之一。此外，它还允许使用日历、联系人、聊天等，并提供各种其他协作服务。最近，在 一篇文章 中，我们介绍了如何从 Gmail 帐户导入联系人。今天，您将学习如何使用 Java 在 Gmail 帐户中创建、更新和删除联系人。

• 用于管理 Gmail 联系人的 Java API
• 在 Gmail 上创建联系人
• 在 Gmail 上更新联系人
• 删除 Gmail 上的联系人

用于创建、更新和删除 Gmail 联系人的 Java API

要在 Gmail 帐户中创建和操作联系人，我们将使用 Aspose.Email for Java。它是一个功能丰富的 API，可让您创建和发送电子邮件并使用流行的电子邮件客户端。您可以 下载 API 或使用以下 Maven 配置安装它。

存储库：

<repository>
    <id>AsposeJavaAPI</id>
    <name>Aspose Java API</name>
    <url>http://repository.aspose.com/repo/</url>
</repository>

依赖：

<dependency>
    <groupId>com.aspose</groupId>
    <artifactId>aspose-email</artifactId>
    <version>22.3</version>
    <classifier>jdk16</classifier>
</dependency>

安装 API 后，您需要在 Google Developer Console 上创建一个项目，这将允许您与 Gmail 通信。要创建一个，您可以按照 本指南。

现在，创建一个名为 GoogleOAuthHelper 的帮助器类来处理 Gmail 帐户的身份验证。另外，创建一个名为 OAuthUser 的类来存储用户信息。以下是这两个类的完整实现。

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>
 * 开发者控制台 https://console.developers.google.com/projectselector/apis/credentials?pli=1 
 * 文档 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) {
            // 忽视
        }
        return result.toString();
    }
}

用 Java 在 Gmail 上创建联系人

以下是使用 Java 在 Gmail 上创建联系人的步骤。

• 首先，创建一个 Google 用户，获取一个访问令牌，并初始化一个 IGmailClient 对象。
• 然后，创建一个 Contact 类的对象。
• 设置联系人的属性，例如姓名、前缀、职业等。
• 要设置邮政地址，请创建 PostalAddress 的实例并设置其属性。
• 使用 Contact.getPhysicalAddresses().add(PostalAddress) 方法将新创建的地址添加到集合中。
• 使用 PhoneNumber 类设置电话号码详细信息。
• 使用 Contact.getPhoneNumbers().add(PhoneNumber) 方法将电话号码详细信息添加到集合中。
• 创建 EmailAddress 类的实例，设置电子邮件地址，并将其分配给联系人。
• 最后，调用 IMailClient.createContact(Contact) 方法创建 Gmail 联系人。

以下代码示例展示了如何使用 Java 在 Gmail 上创建联系人。

OAuthUser user = new OAuthUser();

// 设置clientId、clientSecret和email 
user.clientId = "<<clientID>>"; 
user.clientSecret = "<<clientSecret>>"; 
user.email = "<<email>>";

// 您必须使用生成的 AuthorizationCodeUrl 手动检索 AuthorizationCode
// 设置授权码
String authorizationCode = "<<authCode>>";

// 复制上一步输出的代码验证器
// 设置codeVerifier
String codeVerifier = "<<codeVerifier>>";

// 获取刷新令牌
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;

// 获取访问令牌
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);

// 在 API 中使用访问令牌
IGmailClient client = GmailClient.getInstance(accessToken, user.email);

// 创建联系人
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");

// 设置邮政地址
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);

// 设置电话号码
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);

// 设置其他细节
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");

// 设置电子邮件地址
EmailAddress eAddress = new EmailAddress();
eAddress.setAddress("email@gmail.com");
contact.getEmailAddresses().add(eAddress);

// 创建联系人 
String contactUri = client.createContact(contact);

用 Java 更新 Gmail 上的联系人

您还可以在访问 Gmail 联系人后更新其详细信息。以下是使用 Java 更新 Gmail 帐户中的联系人的步骤。

• 首先，创建一个 Google 用户，获取一个访问令牌，并初始化一个 IGmailClient 对象。
• 然后，使用 IGmailClient.getAllContacts() 方法获取数组中的联系人。
• 之后，从 Contact 对象中的数组中获取所需的联系人。
• 最后，更新联系人的详细信息并调用 IGmailClient.updateContact(contact) 方法。

以下代码示例展示了如何在 Java 中更新 Gmail 中的联系人。

OAuthUser user = new OAuthUser();

// 设置clientId、clientSecret和email 
user.clientId = "<<clientID>>"; 
user.clientSecret = "<<clientSecret>>"; 
user.email = "<<email>>";

// 您必须使用生成的 AuthorizationCodeUrl 手动检索 AuthorizationCode
// 设置授权码
String authorizationCode = "<<authCode>>";

// 从上一步输出中复制代码验证器
// 设置codeVerifier
String codeVerifier = "<<codeVerifier>>";

// 获取刷新令牌
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;

// 获取访问令牌
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);

// 在 API 中使用访问令牌
IGmailClient client = GmailClient.getInstance(accessToken, user.email);

// 获取所有联系人
Contact[] contacts = client.getAllContacts();

// 获取所需的一个
Contact contact = contacts[0];
contact.setJobTitle("Manager IT");
contact.setDepartmentName("Customer Support");
contact.setCompanyName("Aspose");
contact.setProfession("Software Developer");

// 更新联系人
client.updateContact(contact);

在 Java 中删除 Gmail 上的联系人

最后，让我们看看如何使用 Java 删除 Gmail 联系人。以下是执行此操作的步骤。

• 首先，创建一个 Google 用户，获取一个访问令牌，并初始化一个 IGmailClient 对象。
• 然后，使用 IGmailClient.getAllContacts() 方法获取数组中的联系人。
• 从 Contact 对象中的数组中过滤所需的联系人。
• 最后调用IGmailClient.deleteContact(Contact.Id.GoogleId)方法删除联系人。

以下代码示例展示了如何在 Java 中删除 Gmail 上的联系人。

OAuthUser user = new OAuthUser();

// 设置clientId、clientSecret和email 
user.clientId = "<<clientID>>"; 
user.clientSecret = "<<clientSecret>>"; 
user.email = "<<email>>";

// 您必须使用生成的 AuthorizationCodeUrl 手动检索 AuthorizationCode
// 设置授权码
String authorizationCode = "<<authCode>>";

// 从上一步输出中复制代码验证器
// 设置codeVerifier
String codeVerifier = "<<codeVerifier>>";

// 获取刷新令牌
String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
user.refreshToken = refreshToken;

// 获取访问令牌
String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);

// 在 API 中使用访问令牌
IGmailClient client = GmailClient.getInstance(accessToken, user.email);

// 获取所有联系人
Contact[] contacts = client.getAllContacts();

// 获取所需的一个
Contact contact = contacts[0];

// 删除联系人
client.deleteContact(contact.getId().getGoogleId());

获取免费 API 许可证

您可以使用 免费临时许可证 使用 Aspose.Email for Java，而不受评估限制。

结论

在本文中，您学习了如何使用 Java 在 Gmail 帐户中创建和更新联系人。此外，您还了解了如何以编程方式删除 Gmail 联系人。此外，您可以访问 文档 来探索 Aspose.Email for Java 的其他功能。如果您有任何问题，您可以在我们的 论坛 上发帖。

也可以看看

• 使用 Java 从 MS Exchange Server 读取电子邮件
• 使用 Java 创建和发送 Outlook 电子邮件