1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_mail_XMailMessage_idl__ 25cdf0e10cSrcweir#define __com_sun_star_mail_XMailMessage_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_mail_MailAttachment_idl__ 32cdf0e10cSrcweir#include <com/sun/star/mail/MailAttachment.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_XTransferable_idl__ 36cdf0e10cSrcweir#include <com/sun/star/datatransfer/XTransferable.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweirmodule com { module sun { module star { module mail { 40cdf0e10cSrcweir 41cdf0e10cSrcweir/** 42cdf0e10cSrcweir Represents a mail message. 43cdf0e10cSrcweir 44cdf0e10cSrcweir @see com::sun::star::mail::XMailServer 45cdf0e10cSrcweir 46*96af39f7SJürgen Schmidt @since OpenOffice 2.0 47cdf0e10cSrcweir */ 48cdf0e10cSrcweirinterface XMailMessage: ::com::sun::star::uno::XInterface { 49cdf0e10cSrcweir 50cdf0e10cSrcweir /** 51cdf0e10cSrcweir The display name of the sender of this mail message. 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir [attribute, readonly] string SenderName; 54cdf0e10cSrcweir /** 55cdf0e10cSrcweir The e-mail address of the sender of this mail message. 56cdf0e10cSrcweir The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir [attribute, readonly] string SenderAddress; 59cdf0e10cSrcweir 60cdf0e10cSrcweir /** 61cdf0e10cSrcweir The e-mail address where replies on this mail message should be sent to. 62cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 63cdf0e10cSrcweir sending the mail message later will fail. 64cdf0e10cSrcweir If no ReplyToAddress is set replies go to the SenderAddress. 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir [attribute] string ReplyToAddress; 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** 69cdf0e10cSrcweir Add an recipients e-mail address to the list of recipients of this mail message. 70cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 71cdf0e10cSrcweir sending the mail message will fail. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @param sRecipientAddress 74cdf0e10cSrcweir [in] the e-mail address of the recipient. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir void addRecipient([in] string sRecipientAddress); 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** 79cdf0e10cSrcweir Add an Cc recipients e-mail address to the list of recipients of this mail message. 80cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 81cdf0e10cSrcweir sending the mail message will fail. 82cdf0e10cSrcweir 83cdf0e10cSrcweir @param sRecipientAddress 84cdf0e10cSrcweir [in] the e-mail address of the Cc recipient. 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir void addCcRecipient([in] string sRecipientAddress); 87cdf0e10cSrcweir 88cdf0e10cSrcweir /** 89cdf0e10cSrcweir Add an Bcc recipients e-mail address to the list of recipients of this mail message. 90cdf0e10cSrcweir If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> 91cdf0e10cSrcweir sending the mail message will fail. 92cdf0e10cSrcweir 93cdf0e10cSrcweir @param sRecipientAddress 94cdf0e10cSrcweir [in] the e-mail address of the Bcc recipient. 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir void addBccRecipient([in] string sRecipientAddress); 97cdf0e10cSrcweir 98cdf0e10cSrcweir /** 99cdf0e10cSrcweir Return a sequence of the e-mail addresses of all recipients of 100cdf0e10cSrcweir this mail message. 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir sequence<string> getRecipients(); 103cdf0e10cSrcweir 104cdf0e10cSrcweir /** 105cdf0e10cSrcweir Return a sequence of the e-mail addresses of all the Cc recipients 106cdf0e10cSrcweir of this mail message. 107cdf0e10cSrcweir */ 108cdf0e10cSrcweir sequence<string> getCcRecipients(); 109cdf0e10cSrcweir 110cdf0e10cSrcweir /** 111cdf0e10cSrcweir Return a sequence of the e-mail addresses of all the Bcc recipients 112cdf0e10cSrcweir of this mail message. 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir sequence<string> getBccRecipients(); 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** 117cdf0e10cSrcweir The subject of a mail message. 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir [attribute] string Subject; 120cdf0e10cSrcweir 121cdf0e10cSrcweir /** 122cdf0e10cSrcweir The body of the mail message. 123cdf0e10cSrcweir It is expected that the transferable delivers the data as 124cdf0e10cSrcweir a string. Although a transferable may support multiple 125cdf0e10cSrcweir data flavors only the first data flavor supplied will be 126cdf0e10cSrcweir used to retrieve the data and it is expected that the data 127cdf0e10cSrcweir will be provided as a string. 128cdf0e10cSrcweir 129cdf0e10cSrcweir @see com::sun::star::datatransfer::XTransferable 130cdf0e10cSrcweir */ 131cdf0e10cSrcweir [attribute] com::sun::star::datatransfer::XTransferable Body; 132cdf0e10cSrcweir 133cdf0e10cSrcweir /** 134cdf0e10cSrcweir Add a file attachment to a mail message. 135cdf0e10cSrcweir 136cdf0e10cSrcweir param aMailAttachment 137cdf0e10cSrcweir [in] specifies a file which should be attached to this mail message. 138cdf0e10cSrcweir 139cdf0e10cSrcweir @see com::sun::star::mail::MailAttachment 140cdf0e10cSrcweir */ 141cdf0e10cSrcweir void addAttachment([in] MailAttachment aMailAttachment); 142cdf0e10cSrcweir 143cdf0e10cSrcweir /** 144cdf0e10cSrcweir Return a sequence of <type>MailAttachment</type>'s that will 145cdf0e10cSrcweir be attached to this mail message. 146cdf0e10cSrcweir 147cdf0e10cSrcweir @see com::sun::star::mail::MailAttachment 148cdf0e10cSrcweir */ 149cdf0e10cSrcweir sequence<MailAttachment> getAttachments(); 150cdf0e10cSrcweir}; 151cdf0e10cSrcweir 152cdf0e10cSrcweir}; }; }; }; 153cdf0e10cSrcweir 154cdf0e10cSrcweir#endif 155