org.apache.james.imap.encode.ImapEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protocols-imap Show documentation

There is a newer version: 3.8.1

/****************************************************************
 * 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.james.imap.encode;

import java.io.IOException;

import org.apache.james.imap.api.ImapMessage;
import org.apache.james.imap.api.process.ImapSession;

/**
 * TODO: correct this API
 */
public interface ImapEncoder {

    /**
     * Writes response. TODO: pass in writer rather than composer
     * 
     * @param message
     *            ImapMessage, not null
     * @param composer
     *            ImapResponseComposer, not null
     * @param session
     *            TODO
     * @throws IOException
     *             when message encoding fails
     */
    void encode(ImapMessage message, ImapResponseComposer composer, ImapSession session) throws IOException;
}