Gmail от Google является одним из самых популярных и часто используемых почтовых сервисов. Помимо отправки и получения сообщений электронной почты, Gmail предоставляет ряд функций, таких как календари, чаты и т. д. В некоторых случаях вам может потребоваться подключиться к Gmail и программно импортировать контакты из ваших приложений. Для этого в этой статье показано, как импортировать контакты Gmail с помощью Java. Кроме того, мы расскажем, как получить доступ к контактам в определенной группе электронной почты.
Java API для импорта контактов Gmail
Aspose.Email для 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>
Импорт контактов из Gmail в Java
Прежде чем начать, вам нужно создать проект в консоли разработчика Google, который позволит вам выполнить код. Чтобы создать его, вы можете следовать этому руководству.
Теперь создайте вспомогательный класс с именем 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
Ниже приведены шаги для импорта контактов из учетной записи Gmail в Java.
- Создайте объект класса OAuthUser и инициализируйте его с помощью электронной почты, идентификатора клиента и секрета клиента.
- Создайте два строковых объекта для хранения кода авторизации и верификатора кода.
- Получите токен обновления и токен доступа.
- Получите экземпляр класса GmailClient в объект IGmailClient, используя метод GmailClient.getInstance(String, String).
- Считайте контакты в массив с помощью метода IGmailClient.getAllContacts().
- Прокрутите массив, чтобы получить доступ к каждому контакту.
В следующем примере кода показано, как импортировать контакты Gmail из учетной записи на Java.
OAuthUser user = new OAuthUser();
// Установите clientId, clientSecret и адрес электронной почты
user.clientId = "<<clientID>>";
user.clientSecret = "<<clientSecret>>";
user.email = "<<email>>";
// Вы должны получить AuthorizationCode вручную с помощью сгенерированного AuthorizationCodeUrl
// Установить код авторизации
String authorizationCode = "<<authCode>>";
// Скопируйте Code Verifier из выходных данных предыдущего шага
// Установить 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).
- Прокрутите массив, чтобы получить доступ к каждому контакту.
В следующем примере кода показано, как импортировать контакты из определенной группы Gmail в Java.
OAuthUser user = new OAuthUser();
// Установите clientId, clientSecret и адрес электронной почты
user.clientId = "<<clientID>>";
user.clientSecret = "<<clientSecret>>";
user.email = "<<email>>";
// Вы должны получить AuthorizationCode вручную с помощью сгенерированного AuthorizationCodeUrl
// Установить код авторизации
String authorizationCode = "<<authCode>>";
// Скопируйте Code Verifier из выходных данных предыдущего шага
// Установить 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.Email для Java без ограничений пробной версии.
Вывод
В этой статье вы узнали, как программно импортировать контакты Gmail из учетной записи на Java. Более того, вы видели, как получить доступ к контактам из определенной группы электронной почты в Gmail. Кроме того, вы можете изучить документацию, чтобы узнать больше об Aspose.Email для Java. Также вы можете задать свои вопросы на нашем форуме.