nsIMsgIdentity

The nsIMsgIdentity 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.

Inherits from: nsISupports

Method overview

void clearAllValues();
void copy(in nsIMsgIdentity identity);
AString getUnicharAttribute(in string name);
void setUnicharAttribute(in string name, in AString value);
ACString getCharAttribute(in string name);
void setCharAttribute(in string name, in ACString value);
boolean getBoolAttribute(in string name);
void setBoolAttribute(in string name, in boolean value);
long getIntAttribute(in string name);
void setIntAttribute(in string name, in long value);
AString toString();

Attributes

Attribute Type Description
identityName AString  
fullName AString User's full name, i.e. John Doe
email AString User's e-mail address, i.e. john@doe.com
replyTo AString Optional replyTo address, i.e. johnNOSPAM@doe.com
organization AString Optional organization
composeHtml boolean Should we compose with HTML by default?
attachSignature boolean Should we attach a signature by default?
attachVCard boolean Should we attach a vCard by default?
autoQuote boolean Should we automatically quote the original message?
replyOnTop long Should replies appear above or below the quoted message. (1 - replies appear above the quoted message. 0 - replies appear below the quoted message.
sigBottom boolean What should our signature be at the end of the quoted text when replying above it?
signature nsILocalFile The file containing the current signature.
signatureDate long  
escapedVCard AString  
doFcc boolean  
fccFolder AString  
fccFolderPickerMode AString  
fccReplyFollowsParent boolean  
draftsFolderPickerMode AString  
tmplFolderPickerMode AString  
bccSelf boolean
Note: Don't call bccSelf, bccOthers, and bccList directly, they are only used for migration and backward compatability. Use doBcc and doBccList instead.
bccOthers boolean  
bccList AString  
doBcc boolean  
doBccList AString  
draftFolder AString  
stationeryFolder AString  
showSaveMsgDlg boolean  
directoryServer AString  
overrideGlobalPref boolean  
autocompleteToMyDomain boolean If this is false, don't append the user's domain to an autocomplete address with no matches.
valid boolean 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.
smtpServerKey AString The preferred SMTP server for this identity. If this is set, this is the SMTP server that should be used for the message send.
requestReturnReceipt boolean Readonly: Default request for return receipt option for this identity. If this is set, the Return Receipt menu item on the compose window will be checked.
receiptHeaderType long Readonly:
requestDSN boolean Readonly: Default request for DSN option for this identity. If this is set, the DSN menu item on the compose window will be checked.

Methods

clearAllValues()

Note: This is really dangerous! This destroys all pref values; do not call this unless you know what you're doing!

 void clearAllValues();
Parameters

None.

copy()

Copy the attributes of the identity we pass in.

 void copy(in nsIMsgIdentity identity);
Parameters
identity

getUnicharAttribute()

Getter for Unicode attributes.

Note: These attributes persist across sessions.

 AString getUnicharAttribute(in string name);
Parameters
name

setUnicharAttribute()

Setter for Unicode attributes.

 void setUnicharAttribute(in string name, in AString value);
Parameters
name
Name of the attribute to set.
value
Value to set the attribute to.

getCharAttribute()

Getter for char attributes.

 ACString getCharAttribute(in string name);
Parameters
name
Name of the attribute to get.

setCharAttribute()

Setter for char attributes.

 void setCharAttribute(in string name, in ACString value);
Parameters
name
Name of the attribute to set.
value
Value to set the attribute to.

getBoolAttribute()

Getter for boolean attributes.

 boolean getBoolAttribute(in string name);
Parameters
name
Name of the attribute to get.

setBoolAttribute()

Setter for boolean attributes.

 void setBoolAttribute(in string name, in boolean value);
Parameters
name
Name of the attribute to set.
value
Value to set the attribute to.

getIntAttribute()

Getter for int attributes.

 long getIntAttribute(in string name);
Parameters
name
Name of the attribute to get.

setIntAttribute()

Getter for int attributes.

 void setIntAttribute(in string name, in long value);
Parameters
name
Name of the attribute to set.
value
Value to set the attribute to.

toString()

Converts the nsIMsgIdentity to a string. Useful for debugging.

 AString toString();

Document Tags and Contributors

Contributors to this page: fscholz, Sheppy, Wjjohnst
Last updated by: fscholz,