gecko-dev/mailnews/compose/public/nsIMsgAttachment.idl

124 lines
4.2 KiB
Plaintext

/* -*- Mode: idl; tab-width: 2; 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"
[scriptable, uuid(5FB62950-9A0B-41b4-8D11-F6888DFF835E)]
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 wstring name;
/**
* url attribute
*
* @specify where the attachment live (localy or remotely)
*/
attribute string url;
/**
* temporary attribute
*
* @If set to true, the file pointed by the url will be destroyed when tis object is destroyed.
* @This is only for local attachment.
*/
attribute boolean temporary;
/**
* contentLocation attribute
*
* @Specify the origin url of the attachment, used normaly when attaching a locally saved html document.
*/
attribute string contentLocation;
/**
* contentType attribute
*
* @Specify the content-type of the attachment, this 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;
/**
* 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);
};