org.apache.james.imap.message.request.AppendRequest 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.message.request;

import java.io.InputStream;
import java.util.Date;

import javax.mail.Flags;

import org.apache.james.imap.api.ImapCommand;
import org.apache.james.imap.api.message.request.ImapRequest;

/**
 * {@link ImapRequest} which request the append of a message to a mailbox
 */
public class AppendRequest extends AbstractImapRequest {
    private final String mailboxName;

    private final Flags flags;

    private final Date datetime;

    private final InputStream message;

    public AppendRequest(ImapCommand command, String mailboxName, Flags flags, Date datetime, InputStream message, String tag) {
        super(tag, command);
        this.mailboxName = mailboxName;
        this.flags = flags;
        this.datetime = datetime;
        this.message = message;
    }

    /**
     * Return the Date used for the append
     * 
     * @return date
     */
    public Date getDatetime() {
        return datetime;
    }

    /**
     * Return Flags for the Message
     * 
     * @return flags
     */
    public Flags getFlags() {
        return flags;
    }

    /**
     * Return the name of the mailbox we want to append to
     * 
     * @return mailboxName
     */
    public String getMailboxName() {
        return mailboxName;
    }

    /**
     * Return the message to append as {@link InputStream}
     * 
     * @return message
     */
    public InputStream getMessage() {
        return message;
    }

}