/* -*- 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 .
*/
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 <a href="
http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>
.
*/
[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 <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>
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 <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>
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 <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>
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 <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>
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<string> getRecipients();
/**
Return a sequence of the e-mail addresses of all the Cc recipients
of this mail message.
*/
sequence<string> getCcRecipients();
/**
Return a sequence of the e-mail addresses of all the BCC recipients
of this mail message.
*/
sequence<string> 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<MailAttachment> getAttachments();
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
