mozilla

Revision 132479 of nsIMsgCompFields

  • Revision slug: XPCOM_Interface_Reference/NsIMsgCompFields
  • Revision title: nsIMsgCompFields
  • Revision id: 132479
  • Created:
  • Creator: AronRubin
  • Is current revision? No
  • Comment 53 words added

Revision Content

{{ Xpcomapi() }}

Summary

The nsIMsgCompFields interface provides properties for an composition of an outgoing message.

Properties

Attribute Type Description
attachments char * obsolete attachments OBSOLETE, DO NOT USE ANYMORE
attachmentsArray nsISupportsArray readonly  
attachVCard PRBool  
bcc AString  
body AString  
bodyIsAsciiOnly PRBool  
cc AString  
characterSet char *  
defaultCharacterSet char * readonly  
drafId char *  
DSN PRBool  
fcc AString  
fcc2 AString  
followupTo char *  
forceMsgEncoding PRBool  
forcePlainText PRBool  
from AString  
messageId char *  
needToCheckCharset

 

PRBool Indicates whether we need to check if the current DocumentCharset can represent all the characters in the message body. It should be initialized to true and set to false when 'Send Anyway' is selected by a user. (bug 249530)
newsgroups AString  
newshost

 

char *  
newspostUrl

 

char *  
organization AString  
otherRandomHeaders AString  
priority

 

char *  
receiptHeaderType PRInt32  
references

 

char *  
replyTo AString  
securityInfo nsISupports  
subject AString  
templateName AString  
temporaryFiles

 

char * obsolete TemporaryFiles OBSOLETE, DO NOT USE ANYMORE
to AString  
useMultipartAlternative PRBool  
uuEncodeAttachments PRBool  

 

Methods

Utility Methods
PRBool checkCharsetConversion ( out char * fallbackCharset );
nsIMsgRecipientArray SplitRecipients ( in PRUnichar * recipients, in PRBool emailAddressOnly );
void ConvertBodyToPlainText ( );
Attachment Handling Methods
void addAttachment ( in nsIMsgAttachment attachment );
void removeAttachment ( in nsIMsgAttachment attachment );
void removeAttachments ( );

 

References

This interface is the type of the following properties:

nsIMsgCompose.compFields, nsIMsgComposeParams.composeFields

This interface is passed as an argument to the following methods:

nsIMsgComposeSecure.beginCryptoEncapsulation, nsIMsgComposeSecure.requiresCryptoEncapsulation, nsIMsgSend.createAndSendMessage, nsIMsgSend.sendMessageFile, nsISMimeJSHelper.getNoCertAddresses, nsISMimeJSHelper.getRecipientCertsInfo

Revision Source

<p>{{ Xpcomapi() }}</p>
<h2>Summary</h2>
<p>The nsIMsgCompFields interface provides properties for an composition of an outgoing message.</p>
<h2 name="Properties">Properties</h2>
<table class="standard-table"> <tbody> <tr> <td class="header">Attribute</td> <td class="header">Type</td> <td class="header">Description</td> </tr> <tr> <td><code>attachments</code></td> <td><code>char *</code> <em>obsolete</em></td> <td>attachments <em>OBSOLETE, DO NOT USE ANYMORE</em></td> </tr> <tr> <td><code>attachmentsArray</code></td> <td><code><a class="internal" href="/en/nsISupportsArray" title="nsISupportsArray">nsISupportsArray</a> <em>readonly</em></code></td> <td> </td> </tr> <tr> <td><code>attachVCard</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>bcc</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>body</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>bodyIsAsciiOnly</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>cc</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>characterSet</code></td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>defaultCharacterSet</code></td> <td><code>char *</code> <em>readonly</em></td> <td> </td> </tr> <tr> <td><code>drafId</code></td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>DSN</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>fcc</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>fcc2</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>followupTo</code></td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>forceMsgEncoding</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>forcePlainText</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>from</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>messageId</code></td> <td>char *</td> <td> </td> </tr> <tr> <td><code>needToCheckCharset</code> <p> </p> </td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td>Indicates whether we need to check if the current DocumentCharset can represent all the characters in the message body. It should be initialized to true and set to false when 'Send Anyway' is selected by a user. (bug 249530)</td> </tr> <tr> <td><code>newsgroups</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>newshost</code> <p> </p> </td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>newspostUrl</code> <p> </p> </td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>organization</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>otherRandomHeaders</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>priority</code> <p> </p> </td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>receiptHeaderType</code></td> <td><code><a class="internal" href="/en/PRInt32" title="PRInt32">PRInt32</a></code></td> <td> </td> </tr> <tr> <td><code>references</code> <p> </p> </td> <td><code>char *</code></td> <td> </td> </tr> <tr> <td><code>replyTo</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>securityInfo</code></td> <td><code><a class="internal" href="/en/nsISupports" title="nsISupports">nsISupports</a></code></td> <td> </td> </tr> <tr> <td><code>subject</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>templateName</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>temporaryFiles</code> <p> </p> </td> <td><code>char *</code> <em>obsolete</em></td> <td>TemporaryFiles <em>OBSOLETE, DO NOT USE ANYMORE</em></td> </tr> <tr> <td><code>to</code></td> <td><code><a class="internal" href="/en/AString" title="AString">AString</a></code></td> <td> </td> </tr> <tr> <td><code>useMultipartAlternative</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> <tr> <td><code>uuEncodeAttachments</code></td> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a></code></td> <td> </td> </tr> </tbody>
</table>
<p> </p>
<h2>Methods</h2>
<table class="standard-table"> <tbody> <tr> <td bgcolor="#3366ff"><span style="color: rgb(255, 255, 255);">Utility Methods</span></td> </tr> <tr> <td><code><a class="internal" href="/en/PRBool" title="PRBool">PRBool</a> checkCharsetConversion ( out char * fallbackCharset );</code></td> </tr> <tr> <td><code><a class="internal" href="/en/nsIMsgRecipientArray" title="nsIMsgRecipientArray">nsIMsgRecipientArray</a> SplitRecipients ( in <a class="internal" href="/En/PRUnichar" title="PRUnichar">PRUnichar</a> * recipients, in <a class="internal" href="/en/PRBool" title="PRBool">PRBool</a> emailAddressOnly );</code></td> </tr> <tr> <td><code>void ConvertBodyToPlainText ( );</code></td> </tr> <tr> <td bgcolor="#3366ff"><span style="color: rgb(255, 255, 255);">Attachment Handling Methods</span></td> </tr> <tr> <td><code>void addAttachment ( in <a class="internal" href="/nsIMsgAttachment" title="nsIMsgAttachment">nsIMsgAttachment</a> attachment );</code></td> </tr> <tr> <td><code>void removeAttachment ( in <a class="internal" href="/nsIMsgAttachment" title="nsIMsgAttachment">nsIMsgAttachment</a> attachment );</code></td> </tr> <tr> <td><code>void removeAttachments ( );</code></td> </tr> </tbody>
</table>
<p> </p>
<h2>References</h2>
<p>This interface is the type of the following properties:</p>
<p><a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgCompose.html#method_compFields">nsIMsgCompose.compFields</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgComposeParams.html#method_composeFields">nsIMsgComposeParams.composeFields</a></p>
<p>This interface is passed as an argument to the following methods:</p>
<p><a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgComposeSecure.html#method_beginCryptoEncapsulation">nsIMsgComposeSecure.beginCryptoEncapsulation</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgComposeSecure.html#method_requiresCryptoEncapsulation">nsIMsgComposeSecure.requiresCryptoEncapsulation</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgSend.html#method_createAndSendMessage">nsIMsgSend.createAndSendMessage</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIMsgSend.html#method_sendMessageFile">nsIMsgSend.sendMessageFile</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsISMimeJSHelper.html#method_getNoCertAddresses">nsISMimeJSHelper.getNoCertAddresses</a>, <a class=" external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsISMimeJSHelper.html#method_getRecipientCertsInfo">nsISMimeJSHelper.getRecipientCertsInfo</a></p>
Revert to this revision