org.apache.james.protocols.smtp.MailEnvelope Maven / Gradle / Ivy
/****************************************************************
* 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.protocols.smtp;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import org.apache.james.core.MailAddress;
import org.apache.james.core.MaybeSender;
/**
* The MailEnvelope of a SMTP-Transaction
*/
public interface MailEnvelope {
/**
* Return the size of the message. If the message is "empty" it will return -1
*/
long getSize();
/**
* Return the recipients which where supplied in the RCPT TO: command
*/
List getRecipients();
/**
* Return the sender of the mail which was supplied int the MAIL FROM:
* command. If its a "null" sender, null will get returned
*
* @deprecated @see {@link #getMaybeSender()}
*
* Note that SMTP null sender ( "<>" ) needs to be implicitly handled by the caller under the form of 'null' or
* {@link MailAddress#nullSender()}. Replacement method adds type safety on this operation.
*/
@Deprecated
default MailAddress getSender() {
return getMaybeSender().asOptional().orElse(MailAddress.nullSender());
}
/**
* Returns the sender of the message, as specified by the SMTP "MAIL FROM" command,
* or internally defined.
*
* 'null' or {@link MailAddress#nullSender()} are handled with {@link MaybeSender}.
*
* @since Mailet API v3.2.0
* @return the sender of this message wrapped in an optional
*/
default MaybeSender getMaybeSender() {
return MaybeSender.of(getSender());
}
/**
* Return the OutputStream of the message
*
* TODO: Think about how to remove this!
*/
OutputStream getMessageOutputStream() throws IOException;
/**
* Return the InputStream of the message
*/
InputStream getMessageInputStream() throws IOException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy