components/camel-mail/src/main/java/org/apache/camel/component/mail/MailUidGenerator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.component.mail;

import javax.mail.Message;

/**
 * To generate an unique ID of the mail message.
 */
public interface MailUidGenerator {

    /**
     * Generates an unique ID of the mail message depending on if its POP3 or IMAP protocol.
     *
     * @param message the mail message
     * @return the unique id, must never be <tt>null</tt>.
     */
    String generateUuid(MailEndpoint mailEndpoint, Message message);

}