إدارة الفلاتر

يمكنك استخدام الفلاتر لمحاولة ضبط قواعد فلترة متقدّمة لحساب معيّن. يمكن للفلاتر تلقائيًا إضافة تصنيفات أو إزالتها أو إعادة توجيه الرسائل الإلكترونية إلى الأسماء البديلة التي تم إثبات ملكيتها استنادًا إلى سمات الرسالة الواردة أو محتواها.

للحصول على معلومات عن كيفية create أو إدراج أو الحصول على أو حذف الفلاتر، اطّلِع على مرجع الفلاتر.

معايير المطابقة

يمكنك فلترة الرسائل حسب خصائص مثل المُرسِل والموضوع والتاريخ والحجم ومحتوى الرسالة. يمكن أيضًا استخدام أي طلب بحث يستخدم بنية البحث المتقدّم في فلتر. على سبيل المثال، تشمل أنماط الفلاتر الشائعة ما يلي:

تصفية	المطابقات
criteria.from='[e-mail]'	كل الرسائل الإلكترونية من [e-mail]
criteria.size=10485760 criteria.sizeComparison='larger'	جميع الرسائل الإلكترونية التي يزيد حجمها عن 10 ميغابايت
criteria.hasAttachment=true	جميع الرسائل الإلكترونية التي تتضمّن مرفقًا
criteria.subject='[People with Pets]'	جميع الرسائل الإلكترونية التي تحتوي على السلسلة [People with Pets] في الموضوع
criteria.query='"my important project"'	جميع الرسائل الإلكترونية التي تحتوي على السلسلة my important project
criteria.negatedQuery='"secret knock"'	جميع عناوين البريد الإلكتروني التي لا تحتوي على السلسلة secret knock

إذا كانت هناك معايير متعدّدة في فلتر، يجب أن تستوفي الرسالة جميع المعايير لكي يتم تطبيق الفلتر.

المهام

يمكنك تطبيق إجراء على الرسائل التي تتطابق مع معايير الفلتر. يمكن إعادة توجيه الرسائل إلى عنوان بريد إلكتروني تم إثبات ملكيته، أو إضافة تصنيفات إليها أو إزالتها.

يمكنك إضافة تصنيفات أو إزالتها لتغيير حالة الرسالة الإلكترونية. على سبيل المثال، تشمل بعض الإجراءات الشائعة ما يلي:

الإجراء	التأثير
action.removeLabelIds=['INBOX']	أرشفة الرسالة الإلكترونية (تخطّي البريد الوارد)
action.removeLabelIds=['UNREAD']	وضع علامة "مقروءة"
action.removeLabelIds=['SPAM']	عدم وضع علامة مطلقًا على الرسالة باعتبارها غير مرغوب فيها
action.removeLabelIds=['IMPORTANT']	عدم وضع علامة مطلقًا على الرسالة باعتبارها مهمة
action.addLabelIds=['IMPORTANT']	وضع علامة كمهمة
action.addLabelIds=['TRASH']	حذف الرسالة الإلكترونية
action.addLabelIds=['STARRED']	وضع علامة "مميّز بنجمة"
action.addLabelIds=['<user label id>']	يمكنك وضع علامة على الرسالة باستخدام تصنيف يحدّده المستخدم. يُسمح بتصنيف واحد فقط يحدّده المستخدم لكل فلتر.

أمثلة

في ما يلي مثال أكثر اكتمالاً يوضّح كيفية تصنيف الرسائل وأرشفتها من قائمة بريدية.

Java

gmail/snippets/src/main/java/CreateFilter.java

العرض على GitHub

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.Filter;
import com.google.api.services.gmail.model.FilterAction;
import com.google.api.services.gmail.model.FilterCriteria;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Arrays;

/* Class to demonstrate the use of Gmail Create Filter API */
public class CreateFilter {
  /**
   * Create a new filter.
   *
   * @param labelId - ID of the user label to add
   * @return the created filter id, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String createNewFilter(String labelId) throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_BASIC,
            GmailScopes.GMAIL_LABELS);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    try {
      // Filter the mail from sender and archive them(skip the inbox)
      Filter filter = new Filter()
          .setCriteria(new FilterCriteria()
              .setFrom("[e-mail]"))
          .setAction(new FilterAction()
              .setAddLabelIds(Arrays.asList(labelId))
              .setRemoveLabelIds(Arrays.asList("INBOX")));

      Filter result = service.users().settings().filters().create("me", filter).execute();
      // Prints the new created filter ID
      System.out.println("Created filter " + result.getId());
      return result.getId();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to create filter: " + e.getDetails());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/settings snippets/create_filter.py

العرض على GitHub

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def create_filter():
  """Create a filter.
  Returns: Draft object, including filter id.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    label_name = "IMPORTANT"
    filter_content = {
        "criteria": {"from": "[e-mail]"},
        "action": {
            "addLabelIds": [label_name],
            "removeLabelIds": ["INBOX"],
        },
    }

    # pylint: disable=E1101
    result = (
        service.users()
        .settings()
        .filters()
        .create(userId="me", body=filter_content)
        .execute()
    )
    print(f'Created filter with id: {result.get("id")}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    result = None

  return result.get("id")


if __name__ == "__main__":
  create_filter()