Search Results for

    Show / Hide Table of Contents

    Class ExtractAttachmentTextResult

    Extracted text result for an attachment

    Inheritance
    object
    ExtractAttachmentTextResult
    Implements
    IValidatableObject
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: mailslurp.Model
    Assembly: mailslurp.dll
    Syntax
    [DataContract(Name = "ExtractAttachmentTextResult")]
    public class ExtractAttachmentTextResult : IValidatableObject

    Constructors

    View Source

    ExtractAttachmentTextResult()

    Initializes a new instance of the ExtractAttachmentTextResult class.

    Declaration
    [JsonConstructor]
    protected ExtractAttachmentTextResult()
    View Source

    ExtractAttachmentTextResult(bool, string, MethodUsedEnum?, string, List<string>)

    Initializes a new instance of the ExtractAttachmentTextResult class.

    Declaration
    public ExtractAttachmentTextResult(bool present = false, string text = null, ExtractAttachmentTextResult.MethodUsedEnum? methodUsed = null, string contentType = null, List<string> warnings = null)
    Parameters
    Type Name Description
    bool present

    True if extracted text is present (required).

    string text

    Extracted text when present.

    ExtractAttachmentTextResult.MethodUsedEnum? methodUsed

    Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction..

    string contentType

    Detected attachment content type.

    List<string> warnings

    Warnings or fallback notes (required).

    Properties

    View Source

    ContentType

    Detected attachment content type

    Declaration
    [DataMember(Name = "contentType", EmitDefaultValue = true)]
    public string ContentType { get; set; }
    Property Value
    Type Description
    string

    Detected attachment content type

    View Source

    MethodUsed

    Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.

    Declaration
    [DataMember(Name = "methodUsed", EmitDefaultValue = true)]
    public ExtractAttachmentTextResult.MethodUsedEnum? MethodUsed { get; set; }
    Property Value
    Type Description
    ExtractAttachmentTextResult.MethodUsedEnum?

    Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.

    View Source

    Present

    True if extracted text is present

    Declaration
    [DataMember(Name = "present", IsRequired = true, EmitDefaultValue = true)]
    public bool Present { get; set; }
    Property Value
    Type Description
    bool

    True if extracted text is present

    View Source

    Text

    Extracted text when present

    Declaration
    [DataMember(Name = "text", EmitDefaultValue = true)]
    public string Text { get; set; }
    Property Value
    Type Description
    string

    Extracted text when present

    View Source

    Warnings

    Warnings or fallback notes

    Declaration
    [DataMember(Name = "warnings", IsRequired = true, EmitDefaultValue = true)]
    public List<string> Warnings { get; set; }
    Property Value
    Type Description
    List<string>

    Warnings or fallback notes

    Methods

    View Source

    ToJson()

    Returns the JSON string presentation of the object

    Declaration
    public virtual string ToJson()
    Returns
    Type Description
    string

    JSON string presentation of the object

    View Source

    ToString()

    Returns the string presentation of the object

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    String presentation of the object

    Overrides
    object.ToString()

    Implements

    IValidatableObject
    • View Source
    In this article
    Back to top See MailSlurp website for more information.