offapi/com/sun/star/mail/XSmtpService.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 module com { module sun { module star { module mail {
  21
  22 /**
  23    Represents a SMTP service abstraction.
  24
  25    @see com::sun::star::mail::XMailService
  26    @see com::sun::star::mail::XMailMessage
  27
  28    @since OOo 2.0
  29  */
  30 interface XSmtpService: ::com::sun::star::mail::XMailService {
  31
  32     /**
  33         Send a mail message to its recipients.
  34
  35         @param xMailMessage
  36         [in] the mail message to be sent.
  37
  38         @throws com::sun::star::io::NotConnectedException
  39         if no user is currently connected to the mail server.
  40
  41         @throws com::sun::star::mail::SendMailMessageFailedException
  42         if the message could not be sent because of invalid recipient
  43         addresses. The e-mail addresses of recipients have to conform to
  44         <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  45
  46         @throws com::sun::star::mail::MailException
  47         is thrown on other errors that may happen during sending.
  48         A possible reason may be for instance that a file attachment
  49         specified in a mail message could not be found or accessed.
  50
  51         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  52         is thrown when the body of the mail message is provided in an
  53         unsupported mime content type or may be thrown if one of the file
  54         attachments specifies an unsupported mime content type.
  55
  56         @see com::sun::star::mail::XMailMessage
  57         @see com::sun::star::io::NotConnectedException
  58         @see com::sun::star::mail::SendMailMessageFailedException
  59         @see com::sun::star::mail::MailException
  60         @see com::sun::star::datatransfer::UnsupportedFlavorException
  61     */
  62     void sendMailMessage([in] XMailMessage xMailMessage)
  63         raises(com::sun::star::io::NotConnectedException, com::sun::star::mail::SendMailMessageFailedException, com::sun::star::mail::MailException, com::sun::star::datatransfer::UnsupportedFlavorException);
  64 };
  65
  66 }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */