org.gridgain.grid.spi.communication.mail
Interface GridMailCommunicationSpiMBean

All Superinterfaces:

GridSpiManagementMBean

All Known Implementing Classes:

GridMailCommunicationSpi

@GridMBeanDescription(value="MBean provides access to the Mail communication SPI configuration.")
public interface GridMailCommunicationSpiMBean
extends GridSpiManagementMBean

Management bean that provides read-only access to the Mail communication SPI configuration.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Method Summary

String	getFolderName() Gets folder name of email folder on mail server.
String	getFromAddress() Gets message field 'From' all email messages.
String	getInConnectionTypeFormatted() Gets type of incoming mail connection.
Properties	getInCustomProperties() Gets custom properties required for receiving connection.
String	getInHost() Gets incoming host name for receiving email (usually either POP or IMAP).
int	getInPort() Gets incoming host port number for receiving email.
String	getInProtocolFormatted() Sets incoming mail protocol.
String	getInUsername() Gets incoming host username for receiving email.
long	getLeaveMessagesOnServer() Gets incoming messages life-time on mail server in milliseconds.
String	getOutConnectionTypeFormatted() Gets type of outgoing mail connection.
Properties	getOutCustomProperties() Gets custom properties required for outgoing connection.
String	getOutHost() Gets outgoing host name for sending email (usually either SMTP or IMAP).
int	getOutPort() Gets port number for outgoing mail.
String	getOutProtocolFormatted() Gets outgoing mail protocol.
String	getOutUsername() Gets username for outgoing mail authentication.
int	getReadBatchSize() Gets number of messages fetched from mail server at a time.
long	getReceiverDelay() Gets interval in milliseconds between checking for new messages.
String	getStoreFileName() Gets locally stored full file name for all read messages.
String	getSubject() Gets email message subject.

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getAuthor, getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion

Method Detail

getReceiverDelay

@GridMBeanDescription(value="Interval between receiving messages.")
long getReceiverDelay()

Gets interval in milliseconds between checking for new messages.

Returns:

Interval between receiving messages.

getLeaveMessagesOnServer

@GridMBeanDescription(value="Time to live for incoming messages.")
long getLeaveMessagesOnServer()

Gets incoming messages life-time on mail server in milliseconds.

Returns:

Time to live for incoming messages.

getOutConnectionTypeFormatted

@GridMBeanDescription(value="Connection type.")
String getOutConnectionTypeFormatted()

Gets type of outgoing mail connection. Should be one of the following:

• NONE
• SSL
• STARTTLS
• null

Returns:

Connection type.

getOutProtocolFormatted

@GridMBeanDescription(value="Outgoing mail protocol.")
String getOutProtocolFormatted()

Gets outgoing mail protocol. Could be one of the following:

• SMTP
• SMTPS
• null

Returns:

Outgoing mail protocol.

getOutHost

@GridMBeanDescription(value="Outgoing email host name.")
String getOutHost()

Gets outgoing host name for sending email (usually either SMTP or IMAP).

Returns:

Outgoing email host name.

getOutPort

@GridMBeanDescription(value="Outgoing email port number.")
int getOutPort()

Gets port number for outgoing mail.

Returns:

Outgoing email port number.

getOutUsername

@GridMBeanDescription(value="Outbox username.")
String getOutUsername()

Gets username for outgoing mail authentication.

Returns:

Outbox username.

getInConnectionTypeFormatted

@GridMBeanDescription(value="Connection type.")
String getInConnectionTypeFormatted()

Gets type of incoming mail connection. Should be one of the following:

• NONE
• SSL
• STARTTLS
• null

Returns:

Connection type.

getReadBatchSize

@GridMBeanDescription(value="Number of fetched messages.")
int getReadBatchSize()

Gets number of messages fetched from mail server at a time.

Returns:

Number of fetched messages.

getInProtocolFormatted

@GridMBeanDescription(value="Incoming protocol.")
String getInProtocolFormatted()

Sets incoming mail protocol. Could be one of the following:

• POP3
• POP3S
• IMAP
• IMAPS
• null

Returns:

Incoming protocol.

getInHost

@GridMBeanDescription(value="Incoming email host name.")
String getInHost()

Gets incoming host name for receiving email (usually either POP or IMAP).

Returns:

Incoming email host name.

getInPort

@GridMBeanDescription(value="Incoming email host name.")
int getInPort()

Gets incoming host port number for receiving email.

Returns:

Incoming email host name.

getInUsername

@GridMBeanDescription(value="Incoming email host name.")
String getInUsername()

Gets incoming host username for receiving email.

Returns:

Incoming email host name.

getFolderName

@GridMBeanDescription(value="Email folder name.")
String getFolderName()

Gets folder name of email folder on mail server.

Returns:

Email folder name.

getSubject

@GridMBeanDescription(value="Email message subject.")
String getSubject()

Gets email message subject.

Returns:

Email message subject.

getOutCustomProperties

@GridMBeanDescription(value="Outgoing connection properties.")
Properties getOutCustomProperties()

Gets custom properties required for outgoing connection.

Returns:

Outgoing connection properties.

getInCustomProperties

@GridMBeanDescription(value="Custom properties required for receiving connection.")
Properties getInCustomProperties()

Gets custom properties required for receiving connection.

Returns:

Properties.

getFromAddress

@GridMBeanDescription(value="Message field \'From\' for all email messages.")
String getFromAddress()

Gets message field 'From' all email messages.

Returns:

Message field 'From'.

getStoreFileName

@GridMBeanDescription(value="Locally stored full file name for all read messages.")
String getStoreFileName()

Gets locally stored full file name for all read messages. Can be either full path or a path relative to GridGain installation home folder.

Returns:

Store file path.