 | IMail Interface |
This class provides simple access to email message.
Use MailBuilder class to create this object.
It is possible to access entire MIME tree using MimeDocument property.
Namespace: Limilabs.Mail
Assembly: Mail (in Mail.dll) Version: 3.0.26106.1555
SyntaxThe IMail type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Alternatives | Gets the list of alternative elements in this email message. E.g. MimeCalendar if message is an appointment invitation. |
| Appointments | Gets the list of all appointments in this email message. |
| Attachments | Gets the list of all attachments in this email message. Including Alternatives, Visuals (Inline) and NonVisuals (Attachment). |
| Bcc | Gets the address(es) of others who are to receive this email message ('BCC', Blind Carbon Copy header), even tough the content of the message may not be directed at them. In this collection you can find MailBox which represents single mailbox, or MailGroup which represents group of email addresses. This collection can be modified. May be empty. BCC header is not rendered when Render method is used, however it is rendered when message is saved using Save(String) method. |
| Cc | Gets the address(es) of others who are to receive this email message ('CC', Carbon Copy header), even tough the content of the message may not be directed at them. In this collection you can find MailBox which represent single mailbox, or MailGroup which represents group of email addresses. This collection can be modified. May be empty. |
| Date | Gets or sets the send date of this email message ('Date' header). May be null in case of parsing error or when 'Date' header is missing. |
| DeliveryStatuses | Gets the list of all Delivery Status Notifications (DSNs) in this email message. |
| DKIMSignatureInfo | Gets DKIM signature information from the first 'DKIM-Signature' header. |
| DKIMSignatureInfos | Gets DKIM signature information. |
| Document | Gets the entire MimeDocument object associated with this email message. |
| EnvelopeFrom | Gets or sets the address of the sender taken from the SMTP envelope (SMTP "MAIL FROM"). |
| EnvelopeTo | Gets or sets the address of the recipient taken from the SMTP envelope (SMTP "RCTP FROM"). |
| From | Gets the author(s) of this email message ('From' header). This collection can be modified. If it's empty, email message is NOT RFC 2822 compliant. |
| Headers | MIME headers collection for root MIME entity. |
| Html | Gets HTML version of this email message. You can use GetTextFromHtml method to extract plain text from HTML content. You can also use GetBodyAsText or GetBodyAsHtml to obtain body in a specific format. |
| HtmlData | Gets the object representing 'text/html' body of this email message. May be null if no HTML data is present. You may use Html as a shortcut to retrieve HTML text. |
| HtmlDataString |
Gets HTML data of this email message. You can use GetTextFromHtml method to extract plain text from HTML content.
Obsolete |
| Importance | Gets or sets the importance of this email message ('Importance' header). Consider using GetGenericPriority as it also checks Priority and XPriority properties. |
| InReplyTo | Gets or sets the message-id of the parent email message ('In-Reply-To' header). Does not contain surrounding brackets (< and >). |
| IsDKIMSigned | Indicates if this email message has been DKIM (DomainKeys Identified Mail) signed. |
| IsEncrypted | Indicates if this email message has been encrypted. |
| IsForward | Gets the boolean value indicating if this message was forwarded. |
| IsHtml | Returns true if body of this email message is specified in HTML format. You can use Html property to access HTML version of the body. |
| IsPartial | Gets the boolean value indicating if this message was split (MIME document root is of type MimeMessagePartial). |
| IsReply | Gets the boolean value indicating if this message is a reply. |
| IsRtf | Returns true if body of this email message is specified in RTF format. You can use Rtf property to access RTF version of the body. |
| IsSigned | Indicates if this email message has been signed. |
| IsText | Returns true if body of this email message is specified in plain text format. You can use Text property to access plain text version of the body. |
| ListArchive | Gets URL list of mailing list archive ('List-Archive' header). This collection can be modified. May be empty. |
| ListHelp | Gets URL list for mailing list information ('List-Help' header). This collection can be modified. May be empty. |
| ListID | Gets or sets mailing list identifier ('List-Id' header).May be null. |
| ListOwner | Gets URL list for mailing list owner's mailbox ('List-Owner' header). This collection can be modified. May be empty. |
| ListPost | Gets URL list for mailing list posting ('List-Post' header). This collection can be modified. May be empty. |
| ListSubscribe | Gets URL list for mailing list subscription ('List-Subscribe' header). This collection can be modified. May be empty. |
| ListUnsubscribe | Gets list of URLs ("http://www.example.com/unsubscribe") or emails ("mailto:unsubscribe@lexample.com") for mailing list unsubscription ('List-Unsubscribe' header). This collection can be modified. May be empty. |
| MessageID | Gets or sets id of this email message ('Message-ID' header). Does not include surrounding brackets (< and >). |
| MimeVersion | Gets or sets MIME version of this email message ('MIME-version' header). |
| NeedsDecryption | Indicates if this email message needs to be decrypted. You can use Decrypt, Decrypt(ListX509Certificate2), Decrypt(X509Certificate2) to decrypt a message. |
| NeedsSignedExtraction | Indicates if this email message needs signed message extraction. |
| NonVisuals | Gets the list of all non visual elements (ContentDisposition.Value equal to Attachment) in this email message. E.g. Attached data files. |
| NotificationTo | Gets the disposition notifications addresses ('Disposition-Notification-To' header). This collection can be modified. May be empty. |
| PartialId | Gets the unique identifier to be used to match the parts together. |
| Priority | Gets or sets the priority of this email message ('Priority' header). Consider using GetGenericPriority as it also checks Importance and XPriority properties. |
| RcptTo | Gets or sets the address of the recipient taken from the SMTP envelope (SMTP "RCTP FROM"). |
| ReadReceipts | Gets the list of all Message Disposition Notifications (MDNs) in this email message. |
| Received | Gets the list of all 'received' headers added to this email message. Last item in this list is the one added earliest. |
| References | Gets the ids of the referenced email messages. Does not include surrounding brackets (< and >). This collection can be modified. May be empty. |
| ReplyTo | Gets the address(es) to which the author of this email message suggests that replies be sent ('Reply-to' header). In this collection you can find MailBox which represents single mailbox, or MailGroup which represents group of email addresses. This collection can be modified. May be empty. |
| ReturnPath | Gets or sets return path address ('Return-Path' header). Does not include brackets (< and >). |
| ReturnReceiptTo | Gets return receipt addresses ('Return-Receipt-To' header). This collection can be modified. May be empty. |
| Rtf | Gets RTF version of this email message. RTF may be extracted from a TNEF attachment (winmail.dat) a proprietary e-mail attachment format used by Microsoft Outlook and Microsoft Exchange Server. |
| RtfData | Gets the object representing 'text/rtf' or 'application/rtf' body of this email message. May be null if no RTF data is present. You may use Rtf as a shortcut to retrieve RTF text. |
| Sender | Gets or sets mailbox of the agent responsible for the actual transmission of this email message ('Sender' header). If 'Sender' is null, it returns first item from From collection. |
| SenderHeader | Gets or sets mailbox of the agent responsible for the actual transmission of this email message ('Sender' header). |
| Sensitivity | Gets or sets the sensitivity of this email message ('Sensitivity' header) |
| Subject | Gets or sets the subject of this email message ('Subject' header). May be null. |
| Text | Gets plain text version of this email message. For some HTML emails plain text may be not defined, you can use GetTextFromHtml method to extract plain text from HTML content. You can also use GetBodyAsText or GetBodyAsHtml to obtain body in a specific format. |
| TextData | Gets the object representing 'text/plain' body of this email message. May be null if no text/plain data is present. You may use Text as a shortcut to retrieve plain text. |
| TextDataString |
Gets plain text data from this email message.
For some HTML emails plain text may be not defined, you can use GetTextFromHtml method to extract plain text from HTML content.
You can also use GetBodyAsText or GetBodyAsHtml to obtain body in a specific format.
Obsolete |
| To | Gets the address(es) of the primary recipient(s) of this email message ('To' header). In this collection you can find MailBox which represents single mailbox, or MailGroup which represents group of email addresses. This collection can be modified. May be empty. |
| VCards | Gets the list of all vCards in this email message. |
| Visuals | Gets the list of all visual elements (ContentDisposition.Value equal to Inline) in this email message. E.g. Images embedded inside HTML email. You can use Visuals[string cid] to find the picture embedded in the HTML body using its content id ('Content-ID' header). |
| XConfirmReadingTo | Gets confirm reading addresses ('X-Confirm-Reading-To' header). This collection can be modified. May be empty. |
| XEnvelopeFrom | Gets or sets the address of the sender taken from the SMTP envelope (SMTP "MAIL FROM"). |
| XMsg2Mime | Gets or sets the 'X-Msg2Mime' value. It represents information if this email was created from MSG data. |
| XMsg2MimeClientSubmitTime | Gets or sets the 'X-Msg2Mime-Client-Submit-Time' value. It represents PR_CLIENT_SUBMIT_TIME. May be null. |
| XMsg2MimeCreationTime | Gets or sets the 'X-Msg2Mime-Creation-Time' value. It represents PR_CREATION_TIME. May be null. |
| XMsg2MimeMessageDeliveryTime | Gets or sets the 'X-Msg2Mime-Message-Delivery-Time' value. It represents PR_MESSAGE_DELIVERY_TIME. May be null. |
| XPriority | Gets or sets the X-Priority of this email message ('X-Priority' header) (Outlook specific). Value ranges from "1" to "5" where "1" is the highest priority, "3" is normal, and "5" is the lowest priority. Consider using GetGenericPriority as it also checks Priority and Importance properties. |
| XRcptTo | Gets or sets the address of the recipient taken from the SMTP envelope (SMTP "RCTP FROM"). |
| XTnef2MimeMessageClass | Gets or sets the 'X-Tnef2Mime-MessageClass' value. May be null. |
Methods| Name | Description | |
|---|---|---|
 | CheckDKIMSignature | Verifies the DKIM (DomainKeys Identified Mail) digital signature on this message. Queries DNS server to get the public key. |
| CheckDKIMSignature(DKIMValidationConfiguration) | Verifies the DKIM (DomainKeys Identified Mail) digital signature on this message. Queries DNS server to get the public key. |
| CheckDKIMSignature(RSACryptoServiceProvider) | Verifies the DKIM (DomainKeys Identified Mail) digital signature on this message. |
| CheckDKIMSignature(RSACryptoServiceProvider, DKIMValidationConfiguration) | Verifies the DKIM (DomainKeys Identified Mail) digital signature on this message. |
| CheckSignature(Boolean) | Verifies the digital signatures on the signed CMS/PKCS #7 email message and, optionally, validates the signers' certificates. Checks also if the content was signed by the person that sent it. |
| CheckSignature(SignatureValidationConfiguration) | Verifies the digital signatures on the signed CMS/PKCS #7 email message and, optionally, validates the signers' certificates. Checks also if the content was signed by the person that sent it. |
| Decrypt | Decrypts the message. Searches through My certificate store to find appropriate certificate. You can use SMIMEConfiguration to specify certificates and automatic email decryption. |
| Decrypt(ListX509Certificate2) | Decrypts the message. Searches through specified certificates and My certificate store to find appropriate certificate. |
| Decrypt(MimeConfiguration) | Decrypts the message using specified MIME and S/MIME configuration. |
| Decrypt(SMIMEConfiguration) | Decrypts the message using specified S/MIME configuration. |
| Decrypt(X509Certificate2) | Decrypts the message using specified certificate for decryption. Uses the specified certificate and My certificate store to find appropriate certificate. |
| DKIMSign(ListDKIMSignatureConfiguration) | Signs this message with multiple DKIM (DomainKeys Identified Mail) signatures. |
| DKIMSign(RSACryptoServiceProvider, DKIMSignatureInfo) | Signs this message using DKIM (DomainKeys Identified Mail) signature. |
| DKIMSign(RSACryptoServiceProvider, String, String) | Signs this message using DKIM (DomainKeys Identified Mail) signature. |
| EstimateTransportSize | Gets the estimated transport size of this message. |
| ExtractAttachmentsFromInnerMessages | Extracts attachments from this message and all attached messages (MimeRfc822 objects with MessageRfc822 content type). |
| ExtractSigned | Extracts signed message. |
| ExtractSigned(MimeConfiguration) | Extracts signed message using specified MIME and S/MIME configuration. |
| ExtractSigned(SMIMEConfiguration) | Extracts signed message using specified S/MIME configuration. |
| Forward | Creates ForwardBuilder configured to forward this email. |
| GetBodyAsHtml | Returns body in HTML format. If IsHtml is false this method uses Text property to create valid HTML. |
| GetBodyAsHtml(Boolean) | Returns body in HTML format. If IsHtml is false this method uses Text property to create valid HTML. When inlineVisuals is set to true, all visual elements are inlined using 'data:' URI scheme. |
| GetBodyAsText | Returns body in plain text format. Uses Text, GetTextFromHtml or GetTextFromRtf. |
| GetBodyAsText(Boolean) | Returns body in plain text format. Uses Text, GetTextFromHtml or GetTextFromRtf. |
| GetEnvelopedCms | Gets the EnvelopedCms object for encrypted emails. |
| GetGenericPriority | Gets message priority. It checks following headers in the specified order: Priority, Importance, XPriority. |
| GetReadReceiptAddresses | Gets addresses to which read receipt should be send. It uses , NotificationTo and XConfirmReadingTo header. Duplicates are removed. It returs an empty list, if read receipt was not requested. |
| GetSignedCms | Gets the SignedCms object for signed emails. |
| GetTextFromHtml | Extracts plain text from Html. This text may be different from what is actually stored in the email's Text property. |
| GetTextFromRtf | Extracts plain text from Rtf. This text may be different from what is actually stored in the email's Text property. |
| PriorityHigh | Sets XPriority to 1, Priority to Urgent and Importance to High |
| PriorityLow | Sets XPriority to 5, Priority to NonUrgent and Importance to Low |
| RemoveAttachments | Removes all attachments (NonVisuals) and visual elements from this email. Same as invoking RemoveAttachments(new AttachmentRemoverConfiguration()). |
| RemoveAttachments(AttachmentRemoverConfiguration) | Removes attachments and visual elements from this email, according to configuration settings. |
| Render | Renders mail message using eml format. BCC header is not rendered. |
| Render(AddressHeaderRenderMode) | Renders mail message using eml format. |
| Render(Stream) | Render mail message using eml format to specified stream. BCC header is rendered. |
| Render(Stream, AddressHeaderRenderMode) | Render mail message using eml format to specified stream. |
| RenderEml |
Renders mail message using eml format.
BCC header is not rendered.
Obsolete |
| RenderEml(Boolean) |
Renders mail message using eml format.
Obsolete |
| ReplaceAttachments | Replaces all attachments (NonVisuals) and visual elements with text indicating that attachment/visual was removed. |
| ReplaceAttachments(AttachmentReplacerConfiguration) | Replaces attachments and visual elements with text indicating that attachment/visual was removed, according to configuration settings. |
| Reply | Creates ReplyBuilder configured to reply to this email. |
| RequestReadReceipt | This method copies From or ReplyTo addresses to all read receipts lists. Read receipts are stored using NotificationTo, ReturnReceiptTo and XConfirmReadingTo headers. |
| ReSignWith(SignatureConfiguration) | Computes the signature again. |
| ReSignWith(X509Certificate2) | Computes the signature again. |
| Save | Saves email using eml format to specified file. BCC header is rendered. |
| SaveHtmlAs(String) | Saves HTML version of the message as regular HTML file. Saves all visual elements as files to the same folder. If the message is plain text only, this method uses GetBodyAsHtml to create HTML from plain text. |
| SaveHtmlAs(String, Boolean) | Saves HTML version of the message as regular HTML file. When inlineVisuals is set to true: all visual elements are inlined using data: URI scheme, instead of being saved to disk. If the message is plain text only, this method uses GetBodyAsHtml to create HTML from plain text. |
| ToBuilder | Creates new, fully initialized MailBuilder instance, with all data imported from this email object. |
See Also