Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgIdentity.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 #include "nsIMsgSignature.idl"
00040 #include "nsILocalFile.idl"
00041 
00042 /*
00043  * this interface contains all the personal outgoing mail information
00044  * for a given person.
00045  * each identity is identified by a key, which is the <id> string in
00046  * the identity preferences, such as in
00047  * mail.identity.<id>.replyTo
00048  *
00049  */
00050 
00051 
00052 [scriptable, uuid(e823535a-66b8-4bd4-99cd-cb1cafbfedb6)]
00053 interface nsIMsgIdentity : nsISupports {
00054   /* internal preferences ID */
00055   attribute string key;
00056 
00057   /*
00058    *overriding display name for this identity. if this pref is not set
00059    * then this will return some composed string from the fullname and email
00060    */
00061   attribute wstring identityName;
00062 
00063   /* user's full name, i.e. John Doe */
00064   attribute wstring fullName;
00065 
00066   /* user's e-mail address, i.e. john@doe.com */
00067   attribute string email;
00068 
00069   /* optional replyTo address, i.e. johnNOSPAM@doe.com */
00070   attribute string replyTo;
00071 
00072   /* optional organization */
00073   attribute wstring organization;
00074 
00075   /* should we compose with HTML by default? */
00076   attribute boolean composeHtml;
00077 
00078   /* should we attach a signature by default? */
00079   attribute boolean attachSignature;
00080 
00081   /* should we attach a vcard by default? */
00082   attribute boolean attachVCard;
00083 
00084   /* should we automatically quote the original message? */
00085   attribute boolean autoQuote;
00086 
00087   /* what should our quoting preference be? */
00088   attribute long replyOnTop;
00089 
00090   /* what should our signature be at the end of the quoted text when replying above it? */
00091   attribute boolean sigBottom;
00092 
00093   /* the current signature */
00094   /*  after PR1, let's make this a real object */
00095   /*  attribute nsIMsgSignature signature; */
00096   attribute nsILocalFile signature;
00097   attribute long signatureDate;
00098 
00099   attribute string escapedVCard;
00100 
00101   attribute boolean doFcc;
00102   attribute string fccFolder;
00103 
00104   attribute string fccFolderPickerMode;
00105   attribute string draftsFolderPickerMode;
00106   attribute string tmplFolderPickerMode;  
00107 
00108 
00109   // Don't call bccSelf, bccOthers, and bccList directly, they are 
00110   // only used for migration and backward compatability. Use doBcc
00111   // and doBccList instead.
00112   attribute boolean bccSelf;
00113   attribute boolean bccOthers;
00114   attribute string bccList;
00115 
00116   attribute boolean doBcc;
00117   attribute string doBccList;
00118 
00119   attribute string draftFolder;
00120   attribute string stationeryFolder;
00121   attribute boolean showSaveMsgDlg;
00122   attribute string directoryServer;
00123   attribute boolean overrideGlobalPref;
00128    attribute boolean autocompleteToMyDomain;
00134   attribute boolean valid;
00135 
00140   void clearAllValues();
00141 
00147   attribute string smtpServerKey;
00148 
00154   readonly attribute boolean requestReturnReceipt;
00155   readonly attribute long receiptHeaderType;
00156   
00157   /* copy the attributes of the identity we pass in */
00158   void copy(in nsIMsgIdentity identity);
00159 
00164   wstring getUnicharAttribute(in string name);
00165   void setUnicharAttribute(in string name, in wstring value);
00166   
00167   string getCharAttribute(in string name);
00168   void setCharAttribute(in string name, in string value);
00169 
00170   boolean getBoolAttribute(in string name);
00171   void setBoolAttribute(in string name, in boolean value);
00172 
00173   long getIntAttribute(in string name);
00174   void setIntAttribute(in string name, in long value);
00175 
00176   /* useful for debugging */
00177   wstring toString();
00178 
00179   attribute boolean fccReplyFollowsParent;
00180 };