OpenSim.Modules.EMail/src/MailKit/BodyPartText.cs

124 lines
4.0 KiB
C#

//
// BodyPartText.cs
//
// Author: Jeffrey Stedfast <jestedfa@microsoft.com>
//
// Copyright (c) 2013-2020 .NET Foundation and Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
using System;
using System.Text;
namespace MailKit {
/// <summary>
/// A textual body part.
/// </summary>
/// <remarks>
/// Represents any body part with a media type of "text".
/// </remarks>
/// <example>
/// <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
/// </example>
public class BodyPartText : BodyPartBasic
{
/// <summary>
/// Initializes a new instance of the <see cref="MailKit.BodyPartText"/> class.
/// </summary>
/// <remarks>
/// Creates a new <see cref="BodyPartText"/>.
/// </remarks>
public BodyPartText ()
{
}
/// <summary>
/// Gets whether or not this text part contains plain text.
/// </summary>
/// <remarks>
/// Checks whether or not the text part's Content-Type is text/plain.
/// </remarks>
/// <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
public bool IsPlain {
get { return ContentType.IsMimeType ("text", "plain"); }
}
/// <summary>
/// Gets whether or not this text part contains HTML.
/// </summary>
/// <remarks>
/// Checks whether or not the text part's Content-Type is text/html.
/// </remarks>
/// <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
public bool IsHtml {
get { return ContentType.IsMimeType ("text", "html"); }
}
/// <summary>
/// Gets the length of the text, in lines.
/// </summary>
/// <remarks>
/// Gets the length of the text, in lines.
/// </remarks>
/// <value>The number of lines.</value>
public uint Lines {
get; set;
}
/// <summary>
/// Dispatches to the specific visit method for this MIME body part.
/// </summary>
/// <remarks>
/// This default implementation for <see cref="MailKit.BodyPart"/> nodes
/// calls <see cref="MailKit.BodyPartVisitor.VisitBodyPart"/>. Override this
/// method to call into a more specific method on a derived visitor class
/// of the <see cref="MailKit.BodyPartVisitor"/> class. However, it should still
/// support unknown visitors by calling
/// <see cref="MailKit.BodyPartVisitor.VisitBodyPart"/>.
/// </remarks>
/// <param name="visitor">The visitor.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="visitor"/> is <c>null</c>.
/// </exception>
public override void Accept (BodyPartVisitor visitor)
{
if (visitor == null)
throw new ArgumentNullException (nameof (visitor));
visitor.VisitBodyPartText (this);
}
/// <summary>
/// Encodes the <see cref="BodyPart"/> into the <see cref="System.Text.StringBuilder"/>.
/// </summary>
/// <remarks>
/// Encodes the <see cref="BodyPart"/> into the <see cref="System.Text.StringBuilder"/>.
/// </remarks>
/// <param name="builder">The string builder.</param>
protected override void Encode (StringBuilder builder)
{
base.Encode (builder);
builder.Append (' ');
Encode (builder, Lines);
}
}
}