pjs/mailnews/compose/public/nsIMsgCompFields.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * 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 the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the NPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsIMsgRecipientArray.idl"
#include "nsIMsgAttachment.idl"
#include "nsISupportsArray.idl"


[scriptable, uuid(3E89CAE3-BD2D-11d2-8293-000000000000)]
interface nsIMsgCompFields : nsISupports {

  attribute wstring from;
  attribute wstring replyTo;
  attribute wstring to;
  attribute wstring cc;
  attribute wstring bcc;
  
  attribute wstring fcc;
  attribute wstring fcc2;
  
  attribute string  newsgroups;
  attribute string  newshost;
  attribute string  newspostUrl;
  attribute string  followupTo;

  attribute wstring subject;
  
  /**
   * attachments
   *
   * @OBSOLETE, DO NOT USE ANYMORE
   */
  attribute string  attachments;

  attribute wstring organization;
  attribute string  references;
  attribute string  priority;
  attribute string  messageId;
  attribute string  characterSet;
  readonly attribute string defaultCharacterSet;

  attribute wstring templateName;
  attribute string  draftId;

  attribute boolean returnReceipt;
  attribute boolean attachVCard;
  attribute boolean forcePlainText;
  attribute boolean useMultipartAlternative;
  attribute boolean uuEncodeAttachments;

  attribute wstring otherRandomHeaders;

  attribute wstring body;

  /**
   * temporaryFiles
   *
   * @OBSOLETE, DO NOT USE ANYMORE
   */
  attribute string  temporaryFiles;
  
  readonly attribute nsISupportsArray attachmentsArray;
  void addAttachment(in nsIMsgAttachment attachment);
  void removeAttachment(in nsIMsgAttachment attachment);
  void removeAttachments();

  /* some utility functions */
  nsIMsgRecipientArray SplitRecipients(in wstring recipients, in boolean emailAddressOnly);    
  void ConvertBodyToPlainText();

  attribute nsISupports securityInfo;
};