1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_mail_XMailMessage_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_mail_XMailMessage_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_mail_MailAttachment_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/mail/MailAttachment.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_XTransferable_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/datatransfer/XTransferable.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweirmodule com { module sun { module star { module mail { 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir/** 46*cdf0e10cSrcweir Represents a mail message. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir @see com::sun::star::mail::XMailServer 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir @since OOo 2.0 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweirinterface XMailMessage: ::com::sun::star::uno::XInterface { 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /** 55*cdf0e10cSrcweir The display name of the sender of this mail message. 56*cdf0e10cSrcweir */ 57*cdf0e10cSrcweir [attribute, readonly] string SenderName; 58*cdf0e10cSrcweir /** 59*cdf0e10cSrcweir The e-mail address of the sender of this mail message. 60*cdf0e10cSrcweir The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. 61*cdf0e10cSrcweir */ 62*cdf0e10cSrcweir [attribute, readonly] string SenderAddress; 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir /** 65*cdf0e10cSrcweir The e-mail address where replies on this mail message should be sent to. 66*cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 67*cdf0e10cSrcweir sending the mail message later will fail. 68*cdf0e10cSrcweir If no ReplyToAddress is set replies go to the SenderAddress. 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir [attribute] string ReplyToAddress; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** 73*cdf0e10cSrcweir Add an recipients e-mail address to the list of recipients of this mail message. 74*cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 75*cdf0e10cSrcweir sending the mail message will fail. 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir @param sRecipientAddress 78*cdf0e10cSrcweir [in] the e-mail address of the recipient. 79*cdf0e10cSrcweir */ 80*cdf0e10cSrcweir void addRecipient([in] string sRecipientAddress); 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir /** 83*cdf0e10cSrcweir Add an Cc recipients e-mail address to the list of recipients of this mail message. 84*cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 85*cdf0e10cSrcweir sending the mail message will fail. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @param sRecipientAddress 88*cdf0e10cSrcweir [in] the e-mail address of the Cc recipient. 89*cdf0e10cSrcweir */ 90*cdf0e10cSrcweir void addCcRecipient([in] string sRecipientAddress); 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir /** 93*cdf0e10cSrcweir Add an Bcc recipients e-mail address to the list of recipients of this mail message. 94*cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 95*cdf0e10cSrcweir sending the mail message will fail. 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir @param sRecipientAddress 98*cdf0e10cSrcweir [in] the e-mail address of the Bcc recipient. 99*cdf0e10cSrcweir */ 100*cdf0e10cSrcweir void addBccRecipient([in] string sRecipientAddress); 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir /** 103*cdf0e10cSrcweir Return a sequence of the e-mail addresses of all recipients of 104*cdf0e10cSrcweir this mail message. 105*cdf0e10cSrcweir */ 106*cdf0e10cSrcweir sequence<string> getRecipients(); 107*cdf0e10cSrcweir 108*cdf0e10cSrcweir /** 109*cdf0e10cSrcweir Return a sequence of the e-mail addresses of all the Cc recipients 110*cdf0e10cSrcweir of this mail message. 111*cdf0e10cSrcweir */ 112*cdf0e10cSrcweir sequence<string> getCcRecipients(); 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir /** 115*cdf0e10cSrcweir Return a sequence of the e-mail addresses of all the Bcc recipients 116*cdf0e10cSrcweir of this mail message. 117*cdf0e10cSrcweir */ 118*cdf0e10cSrcweir sequence<string> getBccRecipients(); 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir /** 121*cdf0e10cSrcweir The subject of a mail message. 122*cdf0e10cSrcweir */ 123*cdf0e10cSrcweir [attribute] string Subject; 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir /** 126*cdf0e10cSrcweir The body of the mail message. 127*cdf0e10cSrcweir It is expected that the transferable delivers the data as 128*cdf0e10cSrcweir a string. Although a transferable may support multiple 129*cdf0e10cSrcweir data flavors only the first data flavor supplied will be 130*cdf0e10cSrcweir used to retrieve the data and it is expected that the data 131*cdf0e10cSrcweir will be provided as a string. 132*cdf0e10cSrcweir 133*cdf0e10cSrcweir @see com::sun::star::datatransfer::XTransferable 134*cdf0e10cSrcweir */ 135*cdf0e10cSrcweir [attribute] com::sun::star::datatransfer::XTransferable Body; 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir /** 138*cdf0e10cSrcweir Add a file attachment to a mail message. 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir param aMailAttachment 141*cdf0e10cSrcweir [in] specifies a file which should be attached to this mail message. 142*cdf0e10cSrcweir 143*cdf0e10cSrcweir @see com::sun::star::mail::MailAttachment 144*cdf0e10cSrcweir */ 145*cdf0e10cSrcweir void addAttachment([in] MailAttachment aMailAttachment); 146*cdf0e10cSrcweir 147*cdf0e10cSrcweir /** 148*cdf0e10cSrcweir Return a sequence of <type>MailAttachment</type>'s that will 149*cdf0e10cSrcweir be attached to this mail message. 150*cdf0e10cSrcweir 151*cdf0e10cSrcweir @see com::sun::star::mail::MailAttachment 152*cdf0e10cSrcweir */ 153*cdf0e10cSrcweir sequence<MailAttachment> getAttachments(); 154*cdf0e10cSrcweir}; 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir}; }; }; }; 157*cdf0e10cSrcweir 158*cdf0e10cSrcweir#endif 159