offapi/com/sun/star/system/XSimpleMailClient.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module system {
  22
  23 /** Specifies an interface for creating and sending email messages.
  24 */
  25
  26 published interface XSimpleMailClient: com::sun::star::uno::XInterface
  27 {
  28     /** Create a simple mail message object that implements the interface
  29         XSimpleMailMessage.
  30         @returns
  31         An object that implements the XSimpleMailMessage interface.
  32     */
  33     XSimpleMailMessage createSimpleMailMessage( );
  34
  35     /** Sends a given simple mail message object that implements the interface
  36         XSimpleMailMessage.
  37
  38         @param xSimpleMailMessage
  39         Specifies a configured mail object to be sent.
  40
  41         @param aFlag
  42         Specifies different flags that control the send process
  43         if the flag NO_USER_INTERFACE is specified. A recipient
  44         address must have been specified for the given xMailMessage object.
  45
  46         @throws com::sun::star::lang::IllegalArgumentException
  47         <ul>
  48             <li>If invalid or excluding flags have been specified.</li>
  49             <li>The flag NO_USER_INTERFACE is specified and no recipient
  50             address has been specified for the given xSimpleMailMessage object.</li>
  51             <li>The parameter xSimpleMailMessage is NULL.</li>
  52         </ul>
  53
  54         @throws com::sun::star::uno::Exception
  55         if an error occurs while sending the mail.
  56         <p>The Message member of the exception may contain an error description.</p>
  57
  58         @see com::sun::star::system::XSimpleMailMessage
  59         @see com::sun::star::system::SimpleMailClientFlags
  60     */
  61     void sendSimpleMailMessage( [in] XSimpleMailMessage xSimpleMailMessage, [in] long aFlag )
  62         raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception );
  63 };
  64
  65
  66 }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */