pjs/mailnews/base/public/nsIMsgIdentity.idl

117 строки
3.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsISupports.idl"
#include "nsIMsgSignature.idl"
#include "nsILocalFile.idl"
#include "nsIMsgVCard.idl"
/*
* this interface contains all the personal outgoing mail information
* for a given person.
* each identity is identified by a key, which is the <id> string in
* the identity preferences, such as in
* mail.identity.<id>.replyTo
*
*/
[scriptable, uuid(D3B4A420-D5AC-11d2-806A-006008128C4E)]
interface nsIMsgIdentity : nsISupports {
/* internal preferences ID */
attribute string key;
/*
*overriding display name for this identity. if this pref is not set
* then this will return some composed string from the fullname and email
*/
attribute wstring identityName;
/* user's full name, i.e. John Doe */
attribute wstring fullName;
/* user's e-mail address, i.e. john@doe.com */
attribute string email;
/* optional replyTo address, i.e. johnNOSPAM@doe.com */
attribute string replyTo;
/* optional organization */
attribute wstring organization;
/* should we compose with HTML by default? */
attribute boolean composeHtml;
/* should we attach a signature by default? */
attribute boolean attachSignature;
/* should we attach a vcard by default? */
attribute boolean attachVCard;
/* the current signature */
/* after PR1, let's make this a real object */
/* attribute nsIMsgSignature signature; */
attribute nsILocalFile signature;
attribute long signatureDate;
/* the current vcard */
attribute nsIMsgVCard vCard;
attribute boolean doFcc;
attribute string fccFolder;
attribute boolean bccSelf;
attribute boolean bccOthers;
attribute string bccList;
attribute string draftFolder;
attribute string stationeryFolder;
attribute string junkMailFolder;
attribute boolean showSaveMsgDlg;
attribute string directoryServer;
attribute boolean overrideGlobalPref;
/**
* valid determines if the UI should use this identity
* and the wizard uses this to determine whether or not
* to ask the user to complete all the fields
*/
attribute boolean valid;
/**
* this is really dangerous. this destroys all pref values
* do not call this unless you know what you're doing!
*/
void clearAllValues();
/**
* the preferred smtp server for this identity.
* if this is set, this the smtp server that should be used
* for the message send
*/
attribute string smtpServerKey;
/* copy the attributes of the identity we pass in */
void copy(in nsIMsgIdentity identity);
wstring toString();
};