Quản lý bộ lọc trong Gmail

Tài liệu này giải thích cách sử dụng bộ lọc trong Gmail API.

Bạn có thể dùng tài nguyên settings.filters để thiết lập các quy tắc lọc nâng cao cho một tài khoản. Bộ lọc có thể tự động thêm hoặc xoá nhãn hoặc chuyển tiếp email đến bí danh đã xác minh dựa trên các thuộc tính hoặc nội dung của tin nhắn đến.

Để biết thông tin về cách tạo, liệt kê, nhận hoặc xoá bộ lọc Gmail, hãy xem tài nguyên settings.filters.

Tiêu chí so khớp

Lọc thư theo các thuộc tính như người gửi, tiêu đề, ngày, kích thước và nội dung thư. Bộ lọc chỉ áp dụng cho một số thư cụ thể chứ không phải toàn bộ chuỗi email. Bạn cũng có thể dùng mọi truy vấn sử dụng cú pháp tìm kiếm nâng cao của Gmail trong bộ lọc. Ví dụ: các mẫu bộ lọc thường gặp bao gồm:

Lọc Liên kết
criteria.from='sender@example.com' Email từ sender@example.com
criteria.size=10485760
criteria.sizeComparison='larger'		 Email lớn hơn 10 MB
criteria.hasAttachment=true Email có tệp đính kèm
criteria.subject='[People with Pets]' Email có [People with Pets] trong tiêu đề
criteria.query='"my important project"' Email có chứa my important project
criteria.negatedQuery='"secret knock"' Email không chứa secret knock

Nếu có nhiều tiêu chí trong một bộ lọc, thì thư phải đáp ứng tất cả các tiêu chí để bộ lọc được áp dụng.

Thao tác

Áp dụng một Action cho những thư khớp với tiêu chí lọc. Với Action, bạn có thể chuyển tiếp thư đến một địa chỉ email đã xác minh hoặc thêm và xoá nhãn.

Thêm hoặc xoá nhãn để thay đổi trạng thái của email. Ví dụ: một số hành động phổ biến bao gồm:

Hành động Hiệu quả
action.removeLabelIds=['INBOX'] Lưu trữ email (bỏ qua hộp thư đến)
action.removeLabelIds=['UNREAD'] Đánh dấu là đã đọc
action.removeLabelIds=['SPAM'] Không bao giờ đánh dấu là thư rác
action.removeLabelIds=['IMPORTANT'] Không bao giờ đánh dấu là quan trọng
action.addLabelIds=['IMPORTANT'] Đánh dấu là quan trọng
action.addLabelIds=['TRASH'] Xoá email
action.addLabelIds=['STARRED'] Đánh dấu là có gắn dấu sao
action.addLabelIds=['<user label id>'] Gắn nhãn do người dùng xác định cho thư. Bạn chỉ được dùng một nhãn do người dùng xác định cho mỗi bộ lọc.

Mã mẫu

Các mã mẫu sau đây cho biết cách gắn nhãn và lưu trữ thư trong danh sách gửi thư:

Java

gmail/snippets/src/main/java/CreateFilter.java
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("gduser2@workspacesamples.dev"))
          .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
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": "gsuder1@workspacesamples.dev"},
        "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()