llmail.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:4k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llmail.h
  3.  * @brief smtp helper functions.
  4.  *
  5.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2001-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLMAIL_H
  33. #define LL_LLMAIL_H
  34. typedef struct apr_pool_t apr_pool_t;
  35. #include "llsd.h"
  36. class LLMail
  37. {
  38. public:
  39. // if hostname is NULL, then the host is resolved as 'mail'
  40. static void init(const std::string& hostname, apr_pool_t* pool);
  41. // Allow all email transmission to be disabled/enabled.
  42. static void enable(bool mail_enabled);
  43. /**
  44.  * @brief send an email
  45.  * @param from_name The name of the email sender
  46.  * @param from_address The email address for the sender
  47.  * @param to_name The name of the email recipient
  48.  * @param to_address The email recipient address
  49.  * @param subject The subject of the email
  50.  * @param headers optional X-Foo headers in an llsd map. 
  51.  * @return Returns TRUE if the call succeeds, FALSE otherwise.
  52.  *
  53.  * Results in:
  54.  * From: "from_name" <from_address>
  55.  * To:   "to_name" <to_address>
  56.  * Subject: subject
  57.  * 
  58.  * message
  59.  */
  60. static BOOL send(
  61. const char* from_name,
  62. const char* from_address,
  63. const char* to_name,
  64. const char* to_address,
  65. const char* subject,
  66. const char* message,
  67. const LLSD& headers = LLSD());
  68. /**
  69.  * @brief build the complete smtp transaction & header for use in an
  70.  * mail.
  71.  *
  72.  * @param from_name The name of the email sender
  73.  * @param from_address The email address for the sender
  74.  * @param to_name The name of the email recipient
  75.  * @param to_address The email recipient address
  76.  * @param subject The subject of the email
  77.  * @param headers optional X-Foo headers in an llsd map. 
  78.  * @return Returns the complete SMTP transaction mail header.
  79.  */
  80. static std::string buildSMTPTransaction(
  81. const char* from_name,
  82. const char* from_address,
  83. const char* to_name,
  84. const char* to_address,
  85. const char* subject,
  86. const LLSD& headers = LLSD());
  87. /**
  88. * @brief send an email with header and body.
  89. *
  90. * @param header The email header. Use build_mail_header().
  91. * @param message The unescaped email message.
  92. * @param from_address Used for debugging
  93. * @param to_address Used for debugging
  94. * @return Returns true if the message could be sent.
  95. */
  96. static bool send(
  97. const std::string& header,
  98. const std::string& message,
  99. const char* from_address,
  100. const char* to_address);
  101. // IM-to-email sessions use a "session id" based on an encrypted
  102. // combination of from agent_id, to agent_id, and timestamp.  When
  103. // a user replies to an email we use the from_id to determine the
  104. // sender's name and the to_id to route the message.  The address
  105. // is encrypted to prevent users from building addresses to spoof
  106. // IMs from other users.  The timestamps allow the "sessions" to 
  107. // expire, in case one of the sessions is stolen/hijacked.
  108. //
  109. // indra/tools/mailglue is responsible for parsing the inbound mail.
  110. //
  111. // secret: binary blob passed to blowfish, max length 56 bytes
  112. // secret_size: length of blob, in bytes
  113. //
  114. // Returns: "base64" encoded email local-part, with _ and - as the
  115. // non-alphanumeric characters.  This allows better compatibility
  116. // with email systems than the default / and + extra chars.  JC
  117. static std::string encryptIMEmailAddress(
  118. const LLUUID& from_agent_id,
  119. const LLUUID& to_agent_id,
  120. U32 time,
  121. const U8* secret,
  122. size_t secret_size);
  123. };
  124. extern const size_t LL_MAX_KNOWN_GOOD_MAIL_SIZE;
  125. #endif