Package io.netty.handler.codec.smtp

Class SmtpRequestEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<java.lang.Object>

io.netty.handler.codec.smtp.SmtpRequestEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@UnstableApi
public final class SmtpRequestEncoder
extends MessageToMessageEncoder<java.lang.Object>

Encoder for SMTP requests.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
SmtpRequestEncoder()

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(java.lang.Object msg)	Returns true if the given message should be handled.
protected void	encode(ChannelHandlerContext ctx, java.lang.Object msg, java.util.List<java.lang.Object> out)	Encode from one message to an other.

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder

write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

SmtpRequestEncoder

public SmtpRequestEncoder()

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception

Description copied from class: MessageToMessageEncoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelOutboundHandler in the ChannelPipeline.

Overrides:

acceptOutboundMessage in class MessageToMessageEncoder<java.lang.Object>

Throws:

java.lang.Exception

encode

protected void encode(ChannelHandlerContext ctx,
                      java.lang.Object msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

Description copied from class: MessageToMessageEncoder

Encode from one message to an other. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToMessageEncoder<java.lang.Object>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

Throws:

java.lang.Exception - is thrown if an error occurs