Documentation – برنامه‌نویسی با Gmail

Java: ویژگی‌های ابزارک Gmail

Mon, 01 Jan 0001 00:00:00 +0000

کار با پرس و جوی FreeBusy

Aspose.Email مکانیزمی برای پرس و جو فراهم می‌کند تا بررسی کند آیا یک قرار ملاقات مطابق معیارها موعد دارد یا خیر. FreebusyQuery کلاسی برای این منظور ارائه شده است که امکان تهیهٔ پرس و جو برای یک تقویم خاص را فراهم می‌کند.

پرس و جوی تقویم

این نمونه کد قابلیت پرس و جوی یک تقویم را نشان می‌دهد. کارهای زیر در این نمونه انجام می‌شود:

ایجاد و درج یک تقویم
ایجاد یک قرار ملاقات
درج قرار ملاقات
آماده‌سازی یک FreebusyQuery
دریافت FreebusyResponse

// Use the OAuthUser and GoogleOAuthHelper classes below to receive an access token
IGmailClient client = GmailClient.getInstance(accessToken, "user@domain.com");
try {
    Calendar newCalendar = new Calendar("summary", null, null, "Europe/Kiev");

    // Insert calendar and get back id of newly inserted calendar and Fetch the same calendar using calendar id
    String id = client.createCalendar(newCalendar);
    Calendar fetchedCalendar = client.fetchCalendar(id);
    String calendarId = fetchedCalendar.getId();
    try {
        // Get list of appointments in newly inserted calendar. It should be zero
        Appointment[] appointments = client.listAppointments(calendarId);

        // Create a new appointment and Calculate appointment start and finish time
        java.util.Calendar c = java.util.Calendar.getInstance();
        Date startDate = c.getTime();
        c.add(java.util.Calendar.HOUR_OF_DAY, 1);
        Date endDate = c.getTime();

        // Create attendees list for appointment
        MailAddressCollection attendees = new MailAddressCollection();
        attendees.add("user1@domain.com");
        attendees.add("user2@domain.com");

        // Create appointment
        Appointment app1 = new Appointment("Location", startDate, endDate, MailAddress.to_MailAddress("user2@domain.com"), attendees);
        app1.setSummary("Summary");
        app1.setDescription("Description");
        app1.setStartTimeZone("Europe/Kiev");
        app1.setEndTimeZone("Europe/Kiev");

        // Insert the newly created appointment and get back the same in case of successful insertion
        Appointment newAppointment = client.createAppointment(calendarId, app1);

        // Create Freebusy query by setting min/max timeand time zone
        FreebusyQuery query = new FreebusyQuery();
        c = java.util.Calendar.getInstance();
        c.add(java.util.Calendar.DATE, -1);
        query.setTimeMin(c.getTime());
        c.add(java.util.Calendar.DATE, 2);
        query.setTimeMax(c.getTime());
        query.setTimeZone("Europe/Kiev");

        // Set calendar item to search and Get the reponse of query containing
        query.getItems().add(calendarId);
        FreebusyResponse resp = client.getFreebusyInfo(query);

        client.deleteAppointment(calendarId, newAppointment.getUniqueId());
    } finally {
        client.deleteCalendar(calendarId);
    }
} finally {
    client.dispose();
}

ایجاد پروژه در Google Developer Console

یک پروژه در Google Developer Console باید برای کاربری که حساب Gmail دارد ایجاد شود. در صفحه API & auth → Credentials پروژهٔ گوگل، اطلاعاتی مانند شناسهٔ مشتری (Client ID) و راز مشتری (Client Secret) باید ثبت شود. این اطلاعات به همراه نام کاربری و رمز عبور حساب Gmail برای اجرای کدها در این بخش مورد نیاز است، مثلاً تقویم گوگل، لیست‌های کنترل دسترسی، ملاقات‌ها، مخاطبان، تنظیمات و غیره.

مراحل ایجاد پروژه در Google Developer Console

در زیر یک آموزش گام به گام برای ایجاد پروژه در Google Developer Console ارائه شده است.

به لینک https://console.cloud.google.com بروید و با اطلاعات کاربری جیمیل خود وارد شوید
کادر «من شرایط خدمات تمام محصولات Google Cloud Platform را خوانده‌ام و با آن موافقم» را انتخاب کنید و دکمهٔ پروژه جدید را فشار دهید

ایجاد و انتخاب پروژهٔ جدید

Library را انتخاب کنید و API‌های Contact و Calendar را فعال کنید

صفحهٔ رضایت OAuth را باز کنید

کادر چک External را انتخاب کنید و دکمهٔ ایجاد را فشار دهید

ثبت‌نام برنامه را ویرایش کنید و دکمهٔ ذخیره و ادامه را فشار دهید

مجوزها را اضافه کنید و دکمهٔ بروزرسانی را فشار دهید

ایجاد اعتبارنامه‌های OAuth

شناسهٔ مشتری (Client ID) و راز مشتری (Client Secret) که در کدهای نمونهٔ این بخش استفاده خواهند شد، اینجا قرار می‌گیرند.

کلاس‌های کمکی

کلاس‌های کمکی زیر برای اجرای مثال‌های کد در این بخش مورد نیاز هستند. این کلاس‌ها GoogleOAuthHelper و OAuthUser فقط برای ساده‌سازی نمایش هستند. متدهای این کلاس‌ها از ساختار غیرعمومی صفحات وب استفاده می‌کنند که ممکن است در هر زمان تغییر کند.

کلاس GoogleOAuthHelper

قطعه کد زیر نشان می‌دهد چگونه پیاده‌سازی کنید GoogleOAuthHelper کلاس.

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>
 * Developers console https://console.developers.google.com/projectselector/apis/credentials?pli=1 
 * Documentation 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 class OAuthUser {
        String email;
        String clientId;
        String clientSecret;
        String refreshToken;
    }

    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) {
            // ignore
        }
        return result.toString();
    }
}

Google OAuth Helper باید به شکل زیر استفاده شود:

ابتدا باید یک URL کد مجوز تولید شود.
آدرس را در مرورگر باز کنید و تمام عملیات را تکمیل کنید. در نتیجه، یک کد مجوز دریافت خواهید کرد.
از کد مجوز برای دریافت توکن تازه‌سازی استفاده کنید.
هنگامی که توکن تازه‌سازی موجود باشد، می‌توانید از آن برای دریافت توکن‌های دسترسی استفاده کنید.

static class OAuthUser {
    String email;
    String clientId;
    String clientSecret;
    String refreshToken;
}

static void getRefreshToken() {
    Scanner inputReader = new Scanner(System.in);
    OAuthUser user = new OAuthUser();

    // Set clientId, clientSecret and email
    System.out.println("Set clientId: ");
    user.clientId = inputReader.nextLine();
    System.out.println("Set clientSecret: ");
    user.clientSecret = inputReader.nextLine();
    System.out.println("Set email: ");
    user.email = inputReader.nextLine();

    // Generate AuthorizationCodeUrl
    String authorizationCodeUrl = GoogleOAuthHelper.getAuthorizationCodeUrl(user);

    System.out.println("You have to retrieve AuthorizationCode manually with generated AuthorizationCodeUrl");
    System.out.println("Set authorizationCode: ");
    String authorizationCode = inputReader.nextLine();
    System.out.println("Copy Code Verifier from the previous step output");
    System.out.println("Set codeVerifier: ");
    String codeVerifier = inputReader.nextLine();

    // Get "Refresh Token"
    String refreshToken = GoogleOAuthHelper.getAccessTokenByAuthCode(authorizationCode, codeVerifier, user);
    user.refreshToken = refreshToken;

    // Get "Access Token"
    String accessToken = GoogleOAuthHelper.getAccessTokenByRefreshToken(user);
    
    // Use "Access Token" in API
    IGmailClient client = GmailClient.getInstance(accessToken, user.email);
}

Java: کار با تقویم‌های Gmail

Mon, 01 Jan 0001 00:00:00 +0000

افزودن، ویرایش و حذف یک تقویم

Aspose.Email به برنامه‌ها اجازه می‌دهد تا تقویم‌های Gmail را با استفاده از مدیریت کنند IGmailClient که ویژگی‌های افزودن، حذف و به‌روزرسانی تقویم‌های Gmail را فراهم می‌کند. این کلاس مشتری فهرستی از اشیاء نوع ExtendedCalendar را برمی‌گرداند که حاوی اطلاعات موارد تقویم Gmail هستند. IGmailClient کلاس توابع زیر را برای تقویم‌ها در اختیار می‌گذارد:

createCalendar برای درج تقویم جدید
listCalendars

دریافت فهرست تمام تقویم‌های یک مشتری

deleteCalendar می‌تواند برای حذف یک تقویم استفاده شود
fetchCalendar می‌تواند برای دریافت تقویم خاص یک مشتری استفاده شود
updateCalendar این تابع برای درج مجدد تقویم اصلاح‌شده یک مشتری استفاده می‌شود

برای دسترسی به تقویم‌ها، GoogleTestUser با استفاده از اعتبارهای حساب Gmail مقداردهی می‌شود. GoogleOAuthHelper برای دریافت توکن دسترسی کاربر استفاده می‌شود که سپس برای مقداردهی اولیه به کار می‌رود. IGmailClient.

درج، دریافت و به‌روزرسانی

برای درج یک تقویم، یک را مقداردهی اولیه کنید Calendar نوع شیء و با استفاده از درج کنید createCalendar تابع. createCalendar شناسه تقویم تازه وارد شده را برمی‌گرداند. این شناسه می‌تواند برای دریافت تقویم از سرور استفاده شود. قطعه کد زیر نشان می‌دهد چگونه تقویم را درج، دریافت و به‌روزرسانی کنید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Insert, get and update calendar
    Calendar calendar = new Calendar("Summary", "Description", "Location", "America/Los_Angeles");

    // Insert calendar and Retrieve same calendar using id
    String id = client.createCalendar(calendar);
    Calendar cal = client.fetchCalendar(id);

    // Change information in the fetched calendar and Update calendar
    cal.setDescription("New Description");
    cal.setLocation("New Location");
    client.updateCalendar(cal);
}

حذف تقویم خاص

برای حذف یک تقویم خاص، باید فهرست تمام تقویم‌های یک مشتری را دریافت کنیم و سپس به‌صورت مورد نیاز حذف کنیم. listCalendars فهرست زیر را باز می‌گرداند ExtendedCalendar که شامل تقویم‌های Gmail است. قطعه کد زیر نشان می‌دهد چگونه تقویم خاصی را حذف کنید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Access and delete calendar with summary starting from "Calendar summary"
    String summary = "Calendar summary";

    // Get calendars list
    ExtendedCalendar[] lst = client.listCalendars();

    for (ExtendedCalendar extCal : lst) {
        // Delete selected calendars
        if (extCal.getSummary().startsWith(summary))
            client.deleteCalendar(extCal.getId());
    }
}

کار با کنترل دسترسی تقویم

Aspose.Email کنترل کامل بر دسترسی به موارد تقویم را فراهم می‌کند. listAccessRules تابع توسط IGmailClient که فهرست زیر را باز می‌گرداند AccessControlRule. اطلاعات هر قانون می‌تواند واکشی، تغییر و برای تقویم مشتری ذخیره شود. IGmailClient حاوی توابع زیر برای مدیریت قوانین کنترل دسترسی است.

listAccessRules این تابع فهرست زیر را فراهم می‌کند AccessControlRule
createAccessRule این تابع یک قانون دسترسی جدید برای تقویم ایجاد می‌کند.
updateAccessRule این تابع برای به‌روزرسانی یک قانون دسترسی استفاده می‌شود.
fetchAccessRule می‌توان از آن برای واکشی قانون دسترسی خاص برای تقویم یک مشتری استفاده کرد
deleteAccessRule این تابع برای حذف یک قانون دسترسی استفاده می‌شود.

قطعه کد زیر نشان می‌دهد چگونه توابع مورد استفاده برای مدیریت قوانین دسترسی را به کار می‌برید:

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Retrieve list of calendars for the current client
    ExtendedCalendar[] calendarList = client.listCalendars();

    // Get first calendar id and retrieve list of AccessControlRule for the first calendar
    String calendarId = calendarList[0].getId();
    AccessControlRule[] roles1 = client.listAccessRules(calendarId);

    // Create a local access control rule and Set rule properties
    AccessControlRule rule = new AccessControlRule();
    rule.setRole(AccessRole.reader);
    rule.setScope(new AclScope(AclScopeType.user, email2));

    // Insert new rule for the calendar. It returns the newly created rule
    AccessControlRule createdRule = client.createAccessRule(calendarId, rule);

    // Get list of rules
    AccessControlRule[] roles2 = client.listAccessRules(calendarId);

    // Current list length should be 1 more than the earlier one
    if (roles1.length + 1 == roles2.length) {
        System.out.println("List lengths are ok");
    } else {
        System.out.println("List lengths are not ok");
        return;
    }

    // Change rule and Update the rule for the selected calendar
    createdRule.setRole(AccessRole.writer);
    AccessControlRule updatedRule = client.updateAccessRule(calendarId, createdRule);

    // Retrieve individaul rule against a calendar
    AccessControlRule fetchedRule = client.fetchAccessRule(calendarId, createdRule.getId());

    // Delete particular rule against a given calendar and Retrieve the all rules list for the same calendar
    client.deleteAccessRule(calendarId, createdRule.getId());
    AccessControlRule[] roles3 = client.listAccessRules(calendarId);

    // Check that current rules list length should be equal to the original list length before adding and deleting the rule
    if (roles1.length == roles3.length) {
        System.out.println("List lengths are same");
    } else {
        System.out.println("List lengths are not equal");
        return;
    }
}

کار با تنظیمات مشتری و اطلاعات رنگ

Aspose.Email از دسترسی به تنظیمات مشتری با استفاده از پشتیبانی می‌کند IGmailClient.getSettings. این تابع فهرست تنظیمات را همان‌طور که در زیر آمده است باز می‌گرداند:

dateFieldOrder
displayAllTimezones
hideInvitations
format24HourTime
defaultCalendarMode
defaultEventLength
locale
remindOnRespondedEventsOnly
alternateCalendar
userLocation
hideWeekends
showDeclinedEvents
weekStart
weather
customCalendarMode
timezoneLabel
timezone
useKeyboardShortcuts
country

به‌طور مشابه می‌توان اطلاعات رنگ برای مشتریان را با استفاده از دریافت کرد IGmailClient.getColors. این شیء اطلاعات رنگ فهرست رنگ‌های پیش‌زمینه، رنگ‌های پس‌زمینه و تاریخ و زمان به‌روزرسانی را باز می‌گرداند.

دستیابی به تنظیمات مشتری

قطعه کد زیر نشان می‌دهد چگونه توابع مورد استفاده برای دسترسی به تنظیمات مشتری را به کار می‌برید:

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Retrieve client settings
    Dictionary<String, String> settings = client.getSettings();
    if (settings.size() < 1) {
        System.out.println("No settings are available.");
        return;
    }

    // Traverse the settings list
    for (KeyValuePair<String, String> pair : settings) {
        // Get the setting value and test if settings are ok
        String value = client.getSetting(pair.getKey());
        if (pair.getValue().equals(value)) {
            System.out.println("Key = " + pair.getKey() + ", Value = " + pair.getValue());
        } else {
            System.out.println("Settings could not be retrieved");
        }
    }
}

دسترسی به اطلاعات رنگ

قطعه کد زیر نشان می‌دهد چگونه توابع مورد استفاده برای دسترسی به تنظیمات رنگ مشتری را به کار می‌برید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    ColorsInfo colors = client.getColors();
    Dictionary<String, Colors> palettes = colors.getCalendar();

    // Traverse the settings list
    for (KeyValuePair<String, Colors> pair : palettes) {
        System.out.println("Key = " + pair.getKey() + ", Color = " + pair.getValue());
    }
    System.out.println("Update Date = " + colors.getUpdated());
}

کار با قرارها

Aspose.Email ویژگی‌هایی برای کار با ارائه می‌دهد قرارها در تقویم‌های گوگل. لیست کارهایی که می‌توان بر روی قرارها در تقویم گوگل انجام داد، به شرح زیر است:

اضافه کردن قرارها - createAppointment, importAppointment
دریافت فهرست قرارهای ملاقات - listAppointments
دریافت قرار ملاقات خاص - fetchAppointment, listAppointmentInstances
به‌روزرسانی یک قرار ملاقات - updateAppointment
انتقال قرار ملاقات از یک تقویم به تقویم دیگر - moveAppointment
حذف قرار ملاقات - deleteAppointment

افزودن یک قرار ملاقات

نمونه کد زیر ویژگی افزودن یک قرار ملاقات به تقویم را نشان می‌دهد. در این نمونه مراحل زیر دنبال می‌شود:

یک تقویم ایجاد و وارد کنید.
فهرست قرار ملاقات‌ها را از یک تقویم جدید بازیابی کنید.
یک قرار ملاقات ایجاد کنید.
قرار ملاقات را وارد کنید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Create local calendar
    Calendar calendar1 = new Calendar("Summary", null, null, "Europe/Kiev");

    // Insert calendar and get id of inserted calendar and Get back calendar using an id
    String id = client.createCalendar(calendar1);
    Calendar cal1 = client.fetchCalendar(id);
    String calendarId1 = cal1.getId();

    try {
        // Retrieve list of appointments from the first calendar
        Appointment[] appointments = client.listAppointments(calendarId1);
        if (appointments.length > 0) {
            System.out.println("Wrong number of appointments");
            return;
        }

        // Get current time and Calculate time after an hour from now
        java.util.Calendar c = java.util.Calendar.getInstance();
        Date startDate = c.getTime();
        c.add(java.util.Calendar.HOUR_OF_DAY, 1);
        Date endDate = c.getTime();

        // Initialize a mail address collection and set attendees mail address
        MailAddressCollection attendees = new MailAddressCollection();
        attendees.add("User1.EMail@domain.com");
        attendees.add("User3.EMail@domain.com");

        // Create an appointment with above attendees
        Appointment app1 = new Appointment("Location", startDate, endDate, MailAddress.to_MailAddress(email2), attendees);

        // Set appointment summary, description, start/end time zone
        app1.setSummary("New Summary");
        app1.setDescription("New Description");
        app1.setStartTimeZone("Europe/Kiev");
        app1.setEndTimeZone("Europe/Kiev");

        // Insert appointment in the first calendar inserted above and get back inserted appointment
        Appointment app2 = client.createAppointment(calendarId1, app1);

        // Retrieve appointment using unique id
        Appointment app3 = client.fetchAppointment(calendarId1, app2.getUniqueId());
    } catch (Exception ex) {
        System.err.println(ex);
    }
    
}

بازیابی و به‌روزرسانی قرار ملاقات

در اینجا بازیابی و به‌روزرسانی تقویم به‌صورت زیر نشان داده شده است:

یک قرار ملاقات خاص را بازیابی کنید.
قرار ملاقات را ویرایش کنید.
قرار ملاقات را در تقویم به‌روز کنید.

فرض می‌شود یک تقویم با شناسه "calendarId" و یک قرار ملاقات دارای شناسه یکتای "AppointmentUniqueId" قبلاً استخراج شده‌اند. کد نمونه زیر نشان می‌دهد چگونه قرار ملاقات را بازیابی و به‌روزرسانی کنید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    String calendarId = client.listCalendars()[0].getId();
    String AppointmentUniqueId = client.listAppointments(calendarId)[0].getUniqueId();

    // Retrieve Appointment
    Appointment app3 = client.fetchAppointment(calendarId, AppointmentUniqueId);
    // Change the appointment information
    app3.setSummary("New Summary");
    app3.setDescription("New Description");
    app3.setLocation("New Location");
    app3.setFlags(AppointmentFlags.AllDayEvent);
    java.util.Calendar c = java.util.Calendar.getInstance();
    c.add(java.util.Calendar.HOUR_OF_DAY, 2);
    app3.setStartDate(c.getTime());
    c.add(java.util.Calendar.HOUR_OF_DAY, 1);
    app3.setEndDate(c.getTime());
    app3.setStartTimeZone("Europe/Kiev");
    app3.setEndTimeZone("Europe/Kiev");
    // Update the appointment and get back updated appointment
    Appointment app4 = client.updateAppointment(calendarId, app3);
}

جابجایی و حذف قرار ملاقات

Appointment قابل جابجایی است با ارائه تقویم مبدأ، تقویم مقصد و شناسه یکتا یک قرار ملاقات در تقویم مبدأ. کد نمونه زیر نشان می‌دهد چگونه قرار ملاقات را جابجا و حذف کنید.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    String SourceCalendarId = client.listCalendars()[0].getId();
    String DestinationCalendarId = client.listCalendars()[1].getId();
    String TargetAppUniqueId = client.listAppointments(SourceCalendarId)[0].getUniqueId();

    // Retrieve the list of appointments in the destination calendar before moving the appointment
    Appointment[] appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("Before moving count = " + appointments.length);
    Appointment Movedapp = client.moveAppointment(SourceCalendarId, DestinationCalendarId, TargetAppUniqueId);

    // Retrieve the list of appointments in the destination calendar after moving the appointment
    appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("After moving count = " + appointments.length);

    // Delete particular appointment from a calendar using unique id
    client.deleteAppointment(DestinationCalendarId, Movedapp.getUniqueId());

    // Retrieve the list of appointments. It should be one less than the earlier appointments in the destination calendar
    appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("After deleting count = " + appointments.length);
}

Java: کار با مخاطبان Gmail

Mon, 01 Jan 0001 00:00:00 +0000

Aspose.Email از کار با مخاطبان Gmail پشتیبانی می‌کند. با استفاده از IGmailClient از طریق این واسط، کاربران می‌توانند مخاطبان را از یک حساب Gmail بازیابی کنند، مخاطبان جدید ایجاد کرده، و مخاطبان موجود را به‌روزرسانی یا حذف کنند. Gmail به توسعه‌دهندگان این امکان را می‌دهد که با استفاده از API عمومی خود این کارها را انجام دهند. اطلاعات کاربری زیر برای کار با مخاطبان Gmail لازم است: نام کاربری، آدرس ایمیل، رمز عبور، شناسهٔ مشتری (Client ID)، راز مشتری (Client Secret) و توکن تازه‌سازی (refresh token).

دسترسی به مخاطبان Gmail

در زیر یک برنامهٔ نمونه آورده شده است که می‌تواند برای دسترسی به جزئیات مخاطبین در تمام گروه‌ها استفاده شود.

        try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
            Contact[] contacts = client.getAllContacts();
            for (Contact contact : contacts)
                System.out.println(contact.getDisplayName() + ", " + contact.getEmailAddresses().get_Item(0));

            // Fetch contacts from a specific group
            ContactGroupCollection groups = client.getAllGroups();
            GoogleContactGroup group = null;
            for (GoogleContactGroup g : groups) {
                if ("TestGroup".equals(g.getTitle())) {
                    group = g;
                }
            }

            // Retrieve contacts from the Group
            if (group != null) {
                Contact[] contacts2 = client.getContactsFromGroup(group.getId());
                for (Contact con : contacts2)
                    System.out.println(con.getDisplayName() + "," + con.getEmailAddresses().get_Item(0).toString());
            }
        }

ایجاد مخاطب

قطعه کد زیر نشان می‌دهد چگونه یک مخاطب ایجاد کنید.

// Create a Contact
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");

// Email Address
EmailAddress eAddress = new EmailAddress();
eAddress.setAddress("email@gmail.com");
contact.getEmailAddresses().add(eAddress);
String contactUri = client.createContact(contact);

به‌روزرسانی مخاطب

پس از دریافت یک مخاطب، می‌توان ویژگی‌های آن را به‌روز کرد و مخاطب را دوباره در حساب Gmail ذخیره نمود. قطعه کد زیر نحوهٔ بازیابی مخاطبین از یک حساب Gmail، سپس اصلاح یکی از آن‌ها و ذخیرهٔ مجدد را نشان می‌دهد.

try (IGmailClient client = GmailClient.getInstance(accessToken, 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);
}

حذف مخاطب

برای حذف یک مخاطب Gmail، متد DeleteContact مشتری Gmail همان‌طور که در قطعه کد نمونه زیر نشان داده شده است، استفاده می‌شود.

client.deleteContact(contact.getId().getGoogleId());

ذخیره‌سازی مخاطب

Aspose.Email امکان ذخیرهٔ مخاطب را در قالب‌های مختلفی مانند MSG و VCF فراهم می‌کند. متد Save این قابلیت را فراهم می‌سازد. قطعه کد زیر نشان می‌دهد چگونه مخاطب را ذخیره کنید.

contact.save(dataDir + "contact_out.msg", ContactSaveFormat.Msg);
contact.save(dataDir + "contact_out.vcf", ContactSaveFormat.VCard);