net.rim.blackberry.api.mail
Class Service

This class represents an email service on the BlackBerry handheld device.
An email service enables messaging functionality, including the creating,
editing, sending, and receiving of email messages, and optionally
communicating these operations with a mail server.

The default service is implicitly connected.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

addServiceListener

Registers a service listener to handle service events for this server.

Service listeners are invoked when something in the service changes,
such as the addition or removal of a Folder.

Parameters:

sl - Service listener to register.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getServiceConfiguration

By default, this method returns null; implementing subclasses should
override this to provide more specific functionality.

Returns:

Service configuration for the current email address service, or
null if no configuration available.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

isConnected

public boolean isConnected()

Determines whether this service is connected.

Returns:

True if the service is connected; otherwise, false.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

removeServiceListener

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

setConnected

public void setConnected(boolean connected)

Sets the connection status of a service.

Parameters:

connected - True to connect the service; false to disconnect the
service.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

A human-readable string that describes this service. For example, the default name for
the mail service on a default device is "Email". The email service name
may be set in the “Redirector Settings” section of the Deskktop Manager application.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.