aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/linden/indra/llmessage/llmail.h
blob: 82c272f8fca9dab969febb6bb0b642c591c1cda9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/** 
 * @file llmail.h
 * @brief smtp helper functions.
 *
 * Copyright (c) 2001-2007, Linden Research, Inc.
 * 
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlife.com/developers/opensource/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at http://secondlife.com/developers/opensource/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 */

#ifndef LL_LLMAIL_H
#define LL_LLMAIL_H

typedef struct apr_pool_t apr_pool_t;

// if hostname is NULL, then the host is resolved as 'mail'
void init_mail(const std::string& hostname, apr_pool_t* pool);

// Allow all email transmission to be disabled/enabled.
void enable_mail(bool mail_enabled);

// returns TRUE if the call succeeds, FALSE otherwise.
//
// Results in:
// From: "from_name" <from_address>
// To:   "to_name" <to_address>
// Subject: subject
// message
BOOL send_mail(const char* from_name, const char* from_address,
			   const char* to_name, const char* to_address,
			   const char* subject, const char* message);

/**
 * @brief build the complete smtp transaction & header for use in an
 * mail.
 *
 * @param from_name The name of the email sender
 * @param from_address The email address for the sender
 * @param to_name The name of the email recipient
 * @param to_name The email recipient address
 * @param subject The subject of the email
 * @return Returns the complete SMTP transaction mail header.
 */
std::string build_smtp_transaction(
	const char* from_name,
	const char* from_address,
	const char* to_name,
	const char* to_address,
	const char* subject);

/**
 * @brief send an email with header and body.
 *
 * @param header The email header. Use build_mail_header().
 * @param message The unescaped email message.
 * @param from_address Used for debugging
 * @param to_address Used for debugging
 * @return Returns true if the message could be sent.
 */
bool send_mail(
	const std::string& header,
	const std::string& message,
	const char* from_address,
	const char* to_address);

extern const size_t LL_MAX_KNOWN_GOOD_MAIL_SIZE;

#endif