From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/mail/XMailMessage.idl | 144 ++++++++++++++++++++++++++++++ 1 file changed, 144 insertions(+) create mode 100644 offapi/com/sun/star/mail/XMailMessage.idl (limited to 'offapi/com/sun/star/mail/XMailMessage.idl') diff --git a/offapi/com/sun/star/mail/XMailMessage.idl b/offapi/com/sun/star/mail/XMailMessage.idl new file mode 100644 index 000000000..e9c2d4c77 --- /dev/null +++ b/offapi/com/sun/star/mail/XMailMessage.idl @@ -0,0 +1,144 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_mail_XMailMessage_idl__ +#define __com_sun_star_mail_XMailMessage_idl__ + +#include +#include +#include + +module com { module sun { module star { module mail { + +/** + Represents a mail message. + + @see com::sun::star::mail::XMailService + + @since OOo 2.0 + */ +interface XMailMessage: ::com::sun::star::uno::XInterface { + + /** + The display name of the sender of this mail message. + */ + [attribute, readonly] string SenderName; + /** + The e-mail address of the sender of this mail message. + The e-mail address has to conform to RFC 822. + */ + [attribute, readonly] string SenderAddress; + + /** + The e-mail address where replies on this mail message should be sent to. + If the e-mail address doesn't conform to RFC 822 + sending the mail message later will fail. + If no ReplyToAddress is set replies go to the SenderAddress. + */ + [attribute] string ReplyToAddress; + + /** + Add a recipients e-mail address to the list of recipients of this mail message. + If the e-mail address doesn't conform to RFC 822 + sending the mail message will fail. + + @param sRecipientAddress + [in] the e-mail address of the recipient. + */ + void addRecipient([in] string sRecipientAddress); + + /** + Add a Cc recipients e-mail address to the list of recipients of this mail message. + If the e-mail address doesn't conform to RFC 822 + sending the mail message will fail. + + @param sRecipientAddress + [in] the e-mail address of the Cc recipient. + */ + void addCcRecipient([in] string sRecipientAddress); + + /** + Add a BCC recipients e-mail address to the list of recipients of this mail message. + If the e-mail address doesn't conform to RFC 822 + sending the mail message will fail. + + @param sRecipientAddress + [in] the e-mail address of the BCC recipient. + */ + void addBccRecipient([in] string sRecipientAddress); + + /** + Return a sequence of the e-mail addresses of all recipients of + this mail message. + */ + sequence getRecipients(); + + /** + Return a sequence of the e-mail addresses of all the Cc recipients + of this mail message. + */ + sequence getCcRecipients(); + + /** + Return a sequence of the e-mail addresses of all the BCC recipients + of this mail message. + */ + sequence getBccRecipients(); + + /** + The subject of a mail message. + */ + [attribute] string Subject; + + /** + The body of the mail message. + It is expected that the transferable delivers the data as + a string. Although a transferable may support multiple + data flavors only the first data flavor supplied will be + used to retrieve the data and it is expected that the data + will be provided as a string. + + @see com::sun::star::datatransfer::XTransferable + */ + [attribute] com::sun::star::datatransfer::XTransferable Body; + + /** + Add a file attachment to a mail message. + + param aMailAttachment + [in] specifies a file which should be attached to this mail message. + + @see com::sun::star::mail::MailAttachment + */ + void addAttachment([in] MailAttachment aMailAttachment); + + /** + Return a sequence of MailAttachment's that will + be attached to this mail message. + + @see com::sun::star::mail::MailAttachment + */ + sequence getAttachments(); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3