org.apache.james.services
Interface MailServer

All Known Implementing Classes:

James

public interface MailServer

The interface for Phoenix blocks to the James MailServer

Version:

This is $Revision: 521427 $

Field Summary

static java.lang.String	ALL Reserved user name meaning all users for multi-user mailboxes
static java.lang.String	MDA Reserved user name for the mail delivery agent for multi-user mailboxes
static java.lang.String	ROLE The component role used by components implementing this service

Method Summary

boolean	addUser(java.lang.String userName, java.lang.String password) Deprecated. addUser should not be considered a property of a MailServer We could have readonly userbases providing full MailServer implementations. Look at the UsersRepository.addUser(username, password) method.
java.lang.String	getDefaultDomain() Return the default domain which will get used to deliver mail to if only the localpart was given on rcpt to.
java.lang.String	getHelloName() Return the helloName which should use for all services by default
java.lang.String	getId() Generate a new identifier/name for a mail being processed by this server.
MailRepository	getUserInbox(java.lang.String userName) Retrieve the primary mailbox for userName.
boolean	isLocalServer(java.lang.String serverName) Checks if a server is serviced by mail context
void	sendMail(org.apache.mailet.Mail mail) Pass a Mail to this MailServer for processing
void	sendMail(org.apache.mailet.MailAddress sender, java.util.Collection recipients, java.io.InputStream msg) Deprecated. You can use MailetContext service for this purpose
void	sendMail(org.apache.mailet.MailAddress sender, java.util.Collection recipients, javax.mail.internet.MimeMessage msg) Deprecated. You can use MailetContext service for this purpose
void	sendMail(javax.mail.internet.MimeMessage message) Deprecated. You can use MailetContext service for this purpose
boolean	supportVirtualHosting() Return true if virtualHosting support is enabled, otherwise false

Field Detail

ROLE

static final java.lang.String ROLE

The component role used by components implementing this service

See Also:

Constant Field Values

MDA

static final java.lang.String MDA

Reserved user name for the mail delivery agent for multi-user mailboxes

See Also:

Constant Field Values

ALL

static final java.lang.String ALL

Reserved user name meaning all users for multi-user mailboxes

See Also:

Constant Field Values

Method Detail

sendMail

void sendMail(org.apache.mailet.MailAddress sender,
              java.util.Collection recipients,
              javax.mail.internet.MimeMessage msg)
              throws javax.mail.MessagingException

Deprecated. You can use MailetContext service for this purpose

Pass a MimeMessage to this MailServer for processing

Parameters:

sender - - the sender of the message

recipients - - a Collection of String objects of recipients

msg - - the MimeMessage of the headers and body content of the outgoing message

Throws:

javax.mail.MessagingException - - if the message fails to parse

sendMail

void sendMail(org.apache.mailet.MailAddress sender,
              java.util.Collection recipients,
              java.io.InputStream msg)
              throws javax.mail.MessagingException

Deprecated. You can use MailetContext service for this purpose

Pass a MimeMessage to this MailServer for processing

Parameters:

sender - - the sender of the message

recipients - - a Collection of String objects of recipients

msg - - an InputStream containing the headers and body content of the outgoing message

Throws:

javax.mail.MessagingException - - if the message fails to parse

sendMail

void sendMail(org.apache.mailet.Mail mail)
              throws javax.mail.MessagingException

Pass a Mail to this MailServer for processing

Parameters:

mail - the Mail to be processed

Throws:

javax.mail.MessagingException

sendMail

void sendMail(javax.mail.internet.MimeMessage message)
              throws javax.mail.MessagingException

Deprecated. You can use MailetContext service for this purpose

Pass a MimeMessage to this MailServer for processing

Parameters:

message - the message

Throws:

javax.mail.MessagingException

getUserInbox

MailRepository getUserInbox(java.lang.String userName)

Retrieve the primary mailbox for userName. For POP3 style stores this is their (sole) mailbox.

Parameters:

userName - - the name of the user

Returns:

a reference to an initialised mailbox

getId

java.lang.String getId()

Generate a new identifier/name for a mail being processed by this server.

Returns:

the new identifier

addUser

boolean addUser(java.lang.String userName,
                java.lang.String password)

Deprecated. addUser should not be considered a property of a MailServer We could have readonly userbases providing full MailServer implementations. Look at the UsersRepository.addUser(username, password) method.

Adds a new user to the mail system with userName. For POP3 style stores this may only involve adding the user to the UsersStore.

Parameters:

userName - - the name of the user

Returns:

a reference to an initialised mailbox

isLocalServer

boolean isLocalServer(java.lang.String serverName)

Checks if a server is serviced by mail context

Parameters:

serverName - - name of server.

Returns:

true if server is local, i.e. serviced by this mail context

supportVirtualHosting

boolean supportVirtualHosting()

Return true if virtualHosting support is enabled, otherwise false

Returns:

true or false

getDefaultDomain

java.lang.String getDefaultDomain()

Return the default domain which will get used to deliver mail to if only the localpart was given on rcpt to.

Returns:

the defaultdomain

getHelloName

java.lang.String getHelloName()

Return the helloName which should use for all services by default

Returns:

the helloName