mailnews/compose/public/nsIMsgCompFields.idl
author Joshua Cranmer <Pidgeot18@gmail.com>
Sun, 03 Mar 2013 16:46:26 -0600
changeset 14312 3044a67220c7cc9927cc1aed9096854495756472
parent 13608 931f0547903cb8955d1f5e1c1b676f6deed455d1
child 14619 463b6050612089df176deb0b9cdeb4fa77332330
permissions -rw-r--r--
Followup to bug 846524 to fix --enable-extensions on comm-central, rs=Callek.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"
#include "nsIMsgAttachment.idl"
#include "nsISimpleEnumerator.idl"

[scriptable, uuid(bb793677-87c1-4125-b929-252bd9177793)]
interface nsIMsgCompFields : nsISupports {

  attribute AString from;
  attribute AString replyTo;
  attribute AString to;
  attribute AString cc;
  attribute AString bcc;

  attribute AString fcc;
  attribute AString fcc2;

  attribute AString newsgroups;
  attribute string  newspostUrl;
  attribute AString followupTo;

  attribute AString subject;

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

  attribute AString templateName;
  attribute string  draftId;

  attribute boolean returnReceipt;
  attribute long receiptHeaderType;
  attribute boolean DSN;
  attribute boolean attachVCard;
  attribute boolean forcePlainText;
  attribute boolean useMultipartAlternative;
  attribute boolean bodyIsAsciiOnly;
  attribute boolean forceMsgEncoding;

  attribute AString otherRandomHeaders;

  /**
   * Beware that when setting this property, your body must be properly wrapped,
   * and the line endings must match MSG_LINEBREAK, namely "\r\n" on Windows
   * and "\n" on Linux and OSX.
   */
  attribute AString body;

  /**
   * temporaryFiles
   *
   * @OBSOLETE, DO NOT USE ANYMORE
   */
  attribute string  temporaryFiles;

  readonly attribute nsISimpleEnumerator attachments;
  void addAttachment(in nsIMsgAttachment attachment);
  void removeAttachment(in nsIMsgAttachment attachment);
  void removeAttachments();

  /**
   * This function will split the recipients into an array.
   *
   * @param aRecipients       The recipients list to split.
   * @param aEmailAddressOnly Set to true to drop display names from the results
   *                          array.
   * @param aLength           The length of the aResult array.
   * @param aResult           An array of the recipients.
   */
  void splitRecipients(in AString aRecipients, in boolean aEmailAddressOnly,
                       out unsigned long aLength,
                       [array, size_is(aLength), retval] out wstring aResult);

  void ConvertBodyToPlainText();

  // Check if the composing mail headers can be converted to a mail charset.
  boolean checkCharsetConversion(out string fallbackCharset);

  /**
   * 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)
   */
  attribute boolean needToCheckCharset;

  attribute nsISupports securityInfo;
};