1 | /**
|
2 | * This file is part of the @egodigital/egoose distribution.
|
3 | * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/)
|
4 | *
|
5 | * @egodigital/egoose is free software: you can redistribute it and/or modify
|
6 | * it under the terms of the GNU Lesser General Public License as
|
7 | * published by the Free Software Foundation, version 3.
|
8 | *
|
9 | * @egodigital/egoose is distributed in the hope that it will be useful, but
|
10 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
12 | * Lesser General Public License for more details.
|
13 | *
|
14 | * You should have received a copy of the GNU Lesser General Public License
|
15 | * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
16 | */
|
17 | /**
|
18 | * List of mail formats.
|
19 | */
|
20 | export declare enum MailFormat {
|
21 | /**
|
22 | * Plain text.
|
23 | */
|
24 | PlainText = 0,
|
25 | /**
|
26 | * Rich text HTML
|
27 | */
|
28 | HTML = 1
|
29 | }
|
30 | /**
|
31 | * Options for 'sendMail()' function.
|
32 | */
|
33 | export interface SendMailOptions {
|
34 | /**
|
35 | * The body.
|
36 | */
|
37 | body: any;
|
38 | /**
|
39 | * The format.
|
40 | */
|
41 | format?: MailFormat;
|
42 | /**
|
43 | * The subject.
|
44 | */
|
45 | subject?: string;
|
46 | /**
|
47 | * The address, where to send the mail to.
|
48 | */
|
49 | to: string;
|
50 | }
|
51 | /**
|
52 | * Sends an email.
|
53 | *
|
54 | * @param {SendMailOptions} opts Options.
|
55 | */
|
56 | export declare function sendMail(opts: SendMailOptions): Promise<void>;
|