Gmailの連絡先をプログラムでJavaにインポートする

GoogleのGmailは、最も人気があり、一般的に使用されているメールサービスの1つです。 Gmailは、カレンダーやチャットなどのメールを送受信するだけでなく、さまざまな機能を提供します。場合によっては、Gmailに接続して、アプリケーション内からプログラムで連絡先をインポートする必要があります。これを実現するために、この記事ではJavaを使用してGmailの連絡先をインポートする方法を示します。また、特定の電子メールグループの連絡先にアクセスする方法についても説明します。

Gmailの連絡先をインポートするJavaAPI

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でプロジェクトを作成する必要があります。これにより、コードを実行できるようになります。作成するには、このガイドに従ってください。

次に、Gmailアカウントの認証を処理するために、GoogleOAuthHelperという名前のヘルパークラスを作成します。また、ユーザー情報を格納する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、およびクライアントシークレットで初期化します。
  • 認証コードとコードベリファイアを格納する2つの文字列オブジェクトを作成します。
  • 更新トークンとアクセストークンを取得します。
  • GmailClient.getInstance(String, String)メソッドを使用して、GmailClientクラスのインスタンスをIGmailClientオブジェクトに取得します。
  • IGmailClient.getAllContacts()メソッドを使用して、連絡先を配列に読み込みます。
  • アレイをループして、各連絡先にアクセスします。

次のコードサンプルは、JavaのアカウントからGmailの連絡先をインポートする方法を示しています。

OAuthUser user = new OAuthUser();

// clientId、clientSecret、および電子メールを設定します 
user.clientId = "<<clientID>>"; 
user.clientSecret = "<<clientSecret>>"; 
user.email = "<<email>>";

// 生成されたAuthorizationCodeUrlを使用してAuthorizationCodeを手動で取得する必要があります
// 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();
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、および電子メールを設定します 
user.clientId = "<<clientID>>"; 
user.clientSecret = "<<clientSecret>>"; 
user.email = "<<email>>";

// 生成されたAuthorizationCodeUrlを使用してAuthorizationCodeを手動で取得する必要があります
// authenticationCodeを設定します
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);

// 特定のグループから連絡先を取得する
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.EmailforJavaを使用できます。

結論

この記事では、JavaのプログラムでアカウントからGmailの連絡先をインポートする方法を学びました。さらに、Gmailで特定のメールグループの連絡先にアクセスする方法を見てきました。それとは別に、ドキュメントを調べて、Aspose.EmailforJavaの詳細を読むことができます。また、フォーラムから質問することもできます。

関連項目