diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
commit | 940b4d1848e8c70ab7642901a68594e8016caffc (patch) | |
tree | eb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /offapi/com/sun/star/system/XSimpleMailMessage.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/system/XSimpleMailMessage.idl')
-rw-r--r-- | offapi/com/sun/star/system/XSimpleMailMessage.idl | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/offapi/com/sun/star/system/XSimpleMailMessage.idl b/offapi/com/sun/star/system/XSimpleMailMessage.idl new file mode 100644 index 000000000..449abd8b4 --- /dev/null +++ b/offapi/com/sun/star/system/XSimpleMailMessage.idl @@ -0,0 +1,135 @@ +/* -*- 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_system_XSimpleMailMessage_idl__ +#define __com_sun_star_system_XSimpleMailMessage_idl__ + +#include <com/sun/star/uno/RuntimeException.idl> +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + +module com { module sun { module star { module system { + +/** This interface lets a client set or get the information of a simple mail + message. +*/ + + +published interface XSimpleMailMessage: com::sun::star::uno::XInterface +{ + /** To set the recipient of the simple mail message. + @param aRecipient + The email address of a recipient. The method doesn't check if + the given email address is valid. + */ + void setRecipient( [in] string aRecipient ); + + /** To get the recipient of the simple mail message. + @returns + The specified email address of a recipient + if any has been specified or an empty string. + */ + string getRecipient( ); + + /** To set the cc recipients of a simple mail message. + + @param aCcRecipient + Sets a sequence with the email addresses of one or more cc recipients. + <p>The method does not check if the given addresses are valid. An empty + sequence means there are no cc recipients.</p> + */ + void setCcRecipient( [in] sequence< string > aCcRecipient ); + + /** To get the cc recipients of a simple mail message. + @returns + A sequence with the email addresses of one or more cc recipients. + <p>If no cc recipients have been specified an empty sequence will be returned.</p> + */ + sequence< string > getCcRecipient( ); + + /** To set the BCC recipient of a simple mail message. + @param aBccRecipient + A sequence with the email addresses of one or more BCC recipients. An empty + sequence means there are no BCC recipients.</p> + */ + void setBccRecipient( [in] sequence< string > aBccRecipient ); + + /** To get the BCC recipients of a simple mail message. + @returns + A sequence with the email addresses of one or more BCC recipients. + <p>If no BCC recipients have been specified an empty sequence will be returned.</p> + */ + sequence< string > getBccRecipient( ); + + /** To set the email address of the originator of a simple mail message. + @param aOriginator + Sets the email address of the originator of the mail. + */ + void setOriginator( [in] string aOriginator ); + + /** To get the email address of the originator of a simple mail message. + @returns + The email address of the originator of the mail. + <p>If no originator has been specified an empty string will be returned.</p> + */ + string getOriginator( ); + + /** To set the subject of a simple mail message. + @param aSubject + Sets the subject of the simple mail message. + */ + void setSubject( [in] string aSubject ); + + /** To get the subject of a simple mail message. + @returns + The subject of the simple mail message. + <p>If no subject has been specified an empty string will be returned.</p> + */ + string getSubject( ); + + /** To set an attachment of a simple mail message. + @param aAttachement + Sets a sequence of file URLs specifying the files that should be + attached to the mail. The given file URLs must conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. + The method does not check if the specified file or files really exist. + + @throws ::com::sun::star::lang::IllegalArgumentException + if at least one of the given file URLs is invalid (doesn't conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). + */ + void setAttachement( [in] sequence< string > aAttachement ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + /** To get the attachment of a simple mail message. + @returns + A sequence of file URLs specifying the files that should be attached to + the mail or an empty sequence if no attachments have been specified. + The returned file URLs conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. + */ + sequence< string > getAttachement( ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |