在 Java 中以編程方式導入 Gmail 聯繫人

Google 的 Gmail 是最流行和最常用的電子郵件服務之一。 Gmail 提供一系列功能以及發送和接收電子郵件，例如日曆、聊天等。在某些情況下，您可能需要連接到 Gmail 並從您的應用程序中以編程方式導入聯繫人。為此，本文展示瞭如何使用 Java 導入 Gmail 聯繫人。此外，我們還將介紹如何訪問特定電子郵件組中的聯繫人。

從 Gmail 導入聯繫人的 API
從 Gmail 導入聯繫人
- 導入 Gmail 聯繫人
- 從特定組獲取聯繫人

用於導入 Gmail 聯繫人的 Java API

Aspose.Email for Java 是一個用於創建電子郵件客戶端應用程序的強大 API。此外，它支持與 Gmail 一起使用，例如訪問聯繫人、日曆、約會等。我們將使用此 API 從 Gmail 帳戶訪問和導入聯繫人。您可以下載 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.2</version>
    <classifier>jdk16</classifier>
</dependency>

在 Java 中從 Gmail 導入聯繫人

在開始之前，您需要在 Google Developer Console 上創建一個項目，這將允許您執行代碼。要創建一個，您可以遵循本指南。

現在，創建一個名為 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();
    }
}

從 Gmail 帳戶導入聯繫人

以下是使用 Java 從 Gmail 帳戶導入聯繫人的步驟。

創建 OAuthUser 類的對象並使用電子郵件、客戶端 ID 和客戶端密碼對其進行初始化。
創建兩個字符串對象來存儲授權碼和驗證碼。
獲取刷新令牌和訪問令牌。
使用 GmailClient.getInstance(String, String) 方法將 GmailClient 類的實例放入 IGmailClient 對像中。
使用 IGmailClient.getAllContacts() 方法將聯繫人讀入數組。
遍歷數組以訪問每個聯繫人。

以下代碼示例顯示瞭如何從 Java 帳戶導入 Gmail 聯繫人。

OAuthUser user = new OAuthUser();

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

// 您必須使用生成的 AuthorizationCodeUrl 手動檢索 AuthorizationCode
// 設置授權碼
String authorizationCode = "<<authCode>>";

// 從上一步輸出複制代碼驗證器
// 設置代碼驗證器
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();
for (Contact contact : contacts)
	System.out.println(contact.getDisplayName() + ", " + contact.getEmailAddresses().get_Item(0));

從組中導入 Gmail 聯繫人

您還可以按照以下步驟訪問 Gmail 中特定電子郵件組的聯繫人。

按照上一節中提到的步驟初始化 IGmailClient。
調用 IGmailClient.getAllGroups() 將組放入 ContactGroupCollection 對像中。
根據標題過濾所需的組。
使用 IGmailClient.getContactsFromGroup(String) 方法訪問群組中的聯繫人。
遍歷數組以訪問每個聯繫人。

以下代碼示例顯示如何從 Java 中的特定 Gmail 組導入聯繫人。

OAuthUser user = new OAuthUser();

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

// 您必須使用生成的 AuthorizationCodeUrl 手動檢索 AuthorizationCode
// 設置授權碼
String authorizationCode = "<<authCode>>";

// 從上一步輸出複制代碼驗證器
// 設置代碼驗證器
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);

// 從特定組中獲取聯繫人
ContactGroupCollection groups = client.getAllGroups();
GoogleContactGroup group = null;
for (GoogleContactGroup g : groups) {
	if ("TestGroup".equals(g.getTitle())) {
		group = g;
	}
}

// 從組中檢索聯繫人
if (group != null) {
	Contact[] contacts2 = client.getContactsFromGroup(group.getId());
	for (Contact con : contacts2)
		System.out.println(con.getDisplayName() + "," + con.getEmailAddresses().get_Item(0).toString());
}

獲取免費的 API 許可證

您可以獲得免費的臨時許可證來使用 Aspose.Email for Java，沒有評估限制。

結論

在本文中，您了解瞭如何使用 Java 以編程方式從帳戶導入 Gmail 聯繫人。此外，您還了解瞭如何訪問 Gmail 中特定電子郵件組的聯繫人。除此之外，您可以瀏覽文檔以閱讀有關 Aspose.Email for Java 的更多信息。此外，您可以通過我們的論壇提問。

用於導入 Gmail 聯繫人的 Java API#

在 Java 中從 Gmail 導入聯繫人#

從 Gmail 帳戶導入聯繫人#

從組中導入 Gmail 聯繫人#

獲取免費的 API 許可證#

結論#

也可以看看#

用於導入 Gmail 聯繫人的 Java API

在 Java 中從 Gmail 導入聯繫人

從 Gmail 帳戶導入聯繫人

從組中導入 Gmail 聯繫人

獲取免費的 API 許可證

結論

也可以看看