Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISmtpService Interface Reference

import "nsISmtpService.idl";

Inheritance diagram for nsISmtpService:
Inheritance graph
[legend]
Collaboration diagram for nsISmtpService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void SendMailMessage (in nsIFileSpec aFilePath, in string aRecipients, in nsIMsgIdentity aSenderIdentity, in string aPassword, in nsIUrlListener aUrlListener, in nsIMsgStatusFeedback aStatusListener, in nsIInterfaceRequestor aNotificationCallbacks, out nsIURI aURL, out nsIRequest aRequest)
void GetSmtpServerByIdentity (in nsIMsgIdentity aSenderIdentity, out nsISmtpServer aServer)
 Return the SMTP server that is associated with an identity.
nsISmtpServer createSmtpServer ()
 create a new SMTP server.
nsISmtpServer findServer (in string username, in string hostname)
 find the server with the given hostname.
nsISmtpServer getServerByKey (in string key)
 look up the server with the given key if the server does not exist, create it and add it to our list
void deleteSmtpServer (in nsISmtpServer server)
 delete the given server from the server list.

Public Attributes

readonly attribute nsISupportsArray smtpServers
 A copy of the array of SMTP servers, as stored in the preferences.
attribute nsISmtpServer defaultServer
 The default server, across sessions of the app (eventually there will be a session default which does not persist past shutdown)
attribute nsISmtpServer sessionDefaultServer
 The "session default" server - this is never saved, and only used for the current session.

Detailed Description

Definition at line 51 of file nsISmtpService.idl.


Member Function Documentation

create a new SMTP server.

Use this instead of createInstance(), so that the SMTP Service can be aware of this server

delete the given server from the server list.

does nothing if the server does not exist

Parameters:
serverthe server to delete. Use findServer() if you only know the hostname

find the server with the given hostname.

Parameters:
hostnamethe hostname of the server
Returns:
null if no server is found

look up the server with the given key if the server does not exist, create it and add it to our list

Return the SMTP server that is associated with an identity.

void nsISmtpService::SendMailMessage ( in nsIFileSpec  aFilePath,
in string  aRecipients,
in nsIMsgIdentity  aSenderIdentity,
in string  aPassword,
in nsIUrlListener  aUrlListener,
in nsIMsgStatusFeedback  aStatusListener,
in nsIInterfaceRequestor  aNotificationCallbacks,
out nsIURI  aURL,
out nsIRequest  aRequest 
)

Member Data Documentation

The default server, across sessions of the app (eventually there will be a session default which does not persist past shutdown)

Definition at line 98 of file nsISmtpService.idl.

The "session default" server - this is never saved, and only used for the current session.

Always falls back to the default server unless explicitly set.

Definition at line 105 of file nsISmtpService.idl.

A copy of the array of SMTP servers, as stored in the preferences.

Definition at line 91 of file nsISmtpService.idl.


The documentation for this interface was generated from the following file: