gecko-dev/mailnews/mime/public/nsIMimeConverter.idl
2004-12-01 22:27:03 +00:00

121 lines
5.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** 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 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"
%{C++
#include "prtypes.h"
// default line length for calling the encoder
#define kMIME_ENCODED_WORD_SIZE 72
// Max length of charset name.
#define kMAX_CSNAME 64
/* Opaque objects used by the encoder/decoder to store state. */
typedef struct MimeDecoderData MimeDecoderData;
typedef struct MimeEncoderData MimeEncoderData;
%}
[scriptable, uuid(59B73615-2285-4d88-A31C-1ABFE4773F4F)]
interface nsIMimeConverter : nsISupports {
// These methods are all implemented by libmime to be used by
// modules that need to encode/decode mail headers
// Decode routine.
// If header does not need decoding, places nsnull in decodedString
// Encode routine
string encodeMimePartIIStr(in string header,
in boolean structured,
in string mailCharset,
in long fieldnamelen,
in long encodedWordSize);
// Encode routine (utf-8 input)
string encodeMimePartIIStr_UTF8(in string header,
in boolean structured,
in string mailCharset,
in long fieldnamelen,
in long encodedWordSize);
// TO DO: Comeback and convert the rest of these methods into scriptable methods when we have more time...
%{C++
NS_IMETHOD DecodeMimeHeader(const char *header,
char **decodedString,
const char *default_charset = nsnull,
PRBool override_charset = PR_FALSE,
PRBool eatContinuations = PR_TRUE) = 0;
// Decode routine (also converts output to unicode)
// On success, decodedString is never null
NS_IMETHOD DecodeMimeHeader(const char *header,
PRUnichar **decodedString,
const char *default_charset = nsnull,
PRBool override_charset = PR_FALSE,
PRBool eatContinuations = PR_TRUE) = 0;
// Decode routine (also converts output to unicode)
// On success, decodedString is never null
NS_IMETHOD DecodeMimeHeader(const char *header,
nsAString& decodedString,
const char *default_charset = nsnull,
PRBool override_charset = PR_FALSE,
PRBool eatContinuations = PR_TRUE) = 0;
NS_IMETHOD B64EncoderInit(nsresult (*PR_CALLBACK output_fn) (const char *buf, PRInt32 size, void *closure),
void *closure, MimeEncoderData **returnEncoderData) = 0;
NS_IMETHOD QPEncoderInit (nsresult (*PR_CALLBACK output_fn) (const char *buf,
PRInt32 size, void *closure), void *closure,
MimeEncoderData ** returnEncoderData) = 0;
NS_IMETHOD UUEncoderInit (char *filename, nsresult (*PR_CALLBACK output_fn)
(const char *buf, PRInt32 size, void *closure), void *closure,
MimeEncoderData ** returnEncoderData) = 0;
NS_IMETHOD EncoderDestroy(MimeEncoderData *data, PRBool abort_p) = 0;
NS_IMETHOD EncoderWrite (MimeEncoderData *data, const char *buffer, PRInt32 size, PRInt32 *written) = 0;
%}
};