org.apache.james.transport.mailets.smime
Class SMIMEDecrypt

java.lang.Object
  org.apache.mailet.GenericMailet
      org.apache.james.transport.mailets.smime.SMIMEDecrypt

All Implemented Interfaces:

Mailet, MailetConfig

public class SMIMEDecrypt
extends GenericMailet

This mailet decrypts a s/mime encrypted message. It takes as input an encrypted message and it tries to dechiper it using the key specified in its configuration. If the decryption is successful the mail will be changed and it will contain the decrypted message. The mail attribute org.apache.james.SMIMEDecrypt will contain the public certificate of the key used in the process. The configuration parameters of this mailet are summarized below. The firsts define the keystore where the key that will be used to decrypt messages is saved.

• keyStoreType (default: system dependent): defines the type of the store. Usually jks, pkcs12 or pkcs7
• keyStoreFileName (mandatory): private key store path.
• keyStorePassword (default: ""): private key store password

The other parameters define which private key have to be used. (if the store contains more than one key).

• keyAlias: private key alias.
• keyPass: private key password

Field Summary

protected java.lang.String

mailAttribute

Constructor Summary

SMIMEDecrypt()

Method Summary

void	init() A convenience method which can be overridden so that there's no need to call super.init(config).
void	service(Mail mail) Called by the mailet container to allow the mailet to process a message.

Methods inherited from class org.apache.mailet.GenericMailet

destroy, getInitParameter, getInitParameter, getInitParameterNames, getMailetConfig, getMailetContext, getMailetInfo, getMailetName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

mailAttribute

protected java.lang.String mailAttribute

Constructor Detail

SMIMEDecrypt

public SMIMEDecrypt()

Method Detail

init

public void init()
          throws javax.mail.MessagingException

Description copied from class: GenericMailet

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding init(MailetConfig), simply override this method and it will be called by GenericMailet.init(MailetConfig config). The MailetConfig object can still be retrieved via getMailetConfig().

Overrides:

init in class GenericMailet

Throws:

javax.mail.MessagingException - if an exception occurs that interrupts the mailet's normal operation

service

public void service(Mail mail)
             throws javax.mail.MessagingException

Description copied from class: GenericMailet

Called by the mailet container to allow the mailet to process a message.

This method is declared abstract so subclasses must override it.

Specified by:

service in interface Mailet

Specified by:

service in class GenericMailet

Parameters:

mail - - the Mail object that contains the MimeMessage and routing information

Throws:

javax.mail.MessagingException - - if an exception occurs that interferes with the mailet's normal operation