001/*
002 * (C) Copyright 2018 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *      André Justo
018 */
019package org.nuxeo.ecm.platform.mail.operations;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.core.api.CoreSession;
026import org.nuxeo.ecm.core.api.DocumentModel;
027import org.nuxeo.ecm.platform.mail.utils.MailCoreHelper;
028
029import javax.mail.MessagingException;
030
031/**
032 * Checks for unread emails in the inbox of an Email Folder.
033 *
034 * @since 10.1
035 */
036@Operation(id = MailCheckInboxOperation.ID, category = Constants.CAT_SERVICES, label = "Check Mail Inbox", description = "Checks for unread emails in the inbox of an Email Folder passed as input.")
037public class MailCheckInboxOperation {
038
039    public static final String ID = "Mail.CheckInbox";
040
041    @Context
042    protected CoreSession session;
043
044    @OperationMethod
045    public void run(DocumentModel document) throws MessagingException {
046        MailCoreHelper.checkMail(document, session);
047    }
048}