mailnews/compose/public/nsIMsgAttachment.idl
author calbld
Fri, 27 Apr 2012 11:24:12 -0700
branchCAL130_20120427_RELBRANCH
changeset 11275 20e5341d941da3028cd122432e82e0e2b5c255b9
parent 11067 43b791fd9ea48fc0befc2462f085b2915245606b
child 12286 84ac3c71109811da751f0ef2d72108075938f094
permissions -rw-r--r--
Automated checkin: version bump remove "pre" from version number for lightning 1.5b1 release on CAL130_20120427_RELBRANCH CLOSED TREE a=release

/* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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 of 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 MPL, 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 MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

[scriptable, uuid(d17d2d60-ec3a-46de-8bd1-24c77dd9b87b)]
interface nsIMsgAttachment : nsISupports {

  /**
   * name attribute
   *
   * @Attachment real name, will be sent with the attachment's header.
   * @If no name has been provided, a name will be generated using the url.
   */
  attribute AString   name;

  /**
   * url attribute
   *
   * @specify where the attachment live (localy or remotely)
   */
  attribute AUTF8String  url;

  /**
   * urlCharset attribute
   *
   * @specify the Charset of url  (used to convert url to Unicode after 
   *  unescaping)
   */
  attribute ACString    urlCharset;


  /**
   * temporary attribute
   *
   * @If set to true, the file pointed by the url will be destroyed when this object is destroyed.
   * @This is only for local attachment.
   */
  attribute boolean temporary;

  /**
   * Are we storing this attachment via a cloud provider and linking to it?
   */
  attribute boolean sendViaCloud;

  /**
   * Cloud provider account key for this attachment, if any.
   */
  attribute ACString cloudProviderKey;

  /**
   * This allows the compose front end code to put whatever html annotation
   * it wants for the cloud part, e.g., with expiration time, etc.
   */
  attribute AString htmlAnnotation;

  /**
   * contentLocation attribute
   *
   * @Specify the origin url of the attachment, used normally when attaching
   * a locally saved html document, but also used for cloud files.
   */
  attribute ACString contentLocation;
  
  /**
   * contentType attribute
   *
   * @Specify the content-type of the attachment, this does not include extra content-type parameters. If
   * @you need to specify extra information, use contentTypeParam, charset, macType or macCreator.
   * @If ommitted, it will be determined base on either the name, the url or the content of the file.
   */
  attribute string    contentType;

  /**
   * contentTypeParam attribute
   *
   * @Specify the any content-type parameter (other than the content-type itself, charset, macType or macCreator).
   * @It will be added to the content-type during the send/save operation.
   */
  attribute string    contentTypeParam;
  
  /**
   * charset attribute
   *
   * @Specify the charset of the attachment. It will be added to the content-type during the
   * @send/save operation
   * @If omitted, will be determined automatically (if possible).
   */
  attribute string    charset;

  /**
   * size attribute
   *
   * @Specify the size of the attachment.
   */
  attribute PRInt64   size;

  /**
   * macType attribute
   *
   * @Specify the Mac file type of the attachment. It will be added to the content-type during the
   * @send/save operation
   * @If omitted, will be determined automatically on Macintosh OS.
   */
  attribute string    macType;

  /**
   * macCreator attribute
   *
   * @Specify the Mac file creator of the attachment. It will be added to the content-type during the
   * @send/save operation
   * @If omitted, will be determined automatically on Macintosh OS.
   */
  attribute string    macCreator;

  /**
    * equalsUrl
    *
    * @ determines if both attachments have the same url.
    */
  boolean equalsUrl(in nsIMsgAttachment attachment);
};