HtmlForgeX

API Reference

Class

EmailVCard

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Modifiers sealed

Dependency-free vCard (.vcf) generator for email attachments. Output uses CRLF line endings and folds long lines (UTF-8, 75-octet limit).

Inheritance

  • Object
  • EmailVCard

Constructors

Methods

AddAddress 2 overloads
public EmailVCard AddAddress(EmailVCardAddress address) #
Returns: EmailVCard

Adds an address configured via callback (ADR).

Parameters

configure System.Action{HtmlForgeX.Email.EmailVCardAddress} requiredposition: 0
AddAddress(HtmlForgeX.Email.EmailVCardAddress address) #

Adds an address instance (ADR).

Parameters

address HtmlForgeX.Email.EmailVCardAddress required
public EmailVCard AddEmail(String email, EmailVCardEmailType type = Work, Boolean preferred = false) #
Returns: EmailVCard

Adds an email address (EMAIL).

Parameters

email System.String requiredposition: 0
type HtmlForgeX.Email.EmailVCardEmailType = Work optionalposition: 1
preferred System.Boolean = false optionalposition: 2
public EmailVCard AddPhone(String number, EmailVCardPhoneType type = Cell, Boolean preferred = false) #
Returns: EmailVCard

Adds a phone number (TEL).

Parameters

number System.String requiredposition: 0
type HtmlForgeX.Email.EmailVCardPhoneType = Cell optionalposition: 1
preferred System.Boolean = false optionalposition: 2
public Byte[] ToBytes() #
Returns: Byte[]

Returns the vCard as UTF-8 bytes.

public override String ToString() #
Returns: String
public EmailVCard WithFileName(String fileName) #
Returns: EmailVCard

Sets the suggested file name for the payload.

Parameters

fileName System.String requiredposition: 0
public EmailVCard WithFullName(String fullName) #
Returns: EmailVCard

Sets the formatted name (FN).

Parameters

fullName System.String requiredposition: 0
public EmailVCard WithName(String firstName, String lastName, String fullName = null) #
Returns: EmailVCard

Sets first/last name and optionally overrides FullName.

Parameters

firstName System.String requiredposition: 0
lastName System.String requiredposition: 1
fullName System.String = null optionalposition: 2
public EmailVCard WithNote(String note) #
Returns: EmailVCard

Sets the note (NOTE).

Parameters

note System.String requiredposition: 0
public EmailVCard WithOrganization(String organization) #
Returns: EmailVCard

Sets the organization (ORG).

Parameters

organization System.String requiredposition: 0
public EmailVCard WithTitle(String title) #
Returns: EmailVCard

Sets the title (TITLE).

Parameters

title System.String requiredposition: 0
public EmailVCard WithUrl(String url) #
Returns: EmailVCard

Sets the URL (URL).

Parameters

url System.String requiredposition: 0
public EmailVCard WithVersion(EmailVCardVersion version) #
Returns: EmailVCard

Sets the vCard version.

Parameters

version HtmlForgeX.Email.EmailVCardVersion requiredposition: 0

Properties

public String FileName { get; set; } #

Recommended file name for the vCard payload.

public String ContentType { get; } #

Recommended content type for the payload.

public EmailVCardVersion Version { get; set; } #

vCard version.

public String FirstName { get; set; } #

First (given) name (N component).

public String LastName { get; set; } #

Last (family) name (N component).

public String MiddleName { get; set; } #

Middle name (N component).

public String Prefix { get; set; } #

Name prefix (e.g. "Dr.") (N component).

public String Suffix { get; set; } #

Name suffix (e.g. "Jr.") (N component).

public String FullName { get; set; } #

Formatted name (FN). If empty, derived from name parts.

public String Organization { get; set; } #

Organization name (ORG).

public String Title { get; set; } #

Job title (TITLE).

public String Note { get; set; } #

Free-form note (NOTE).

public String Url { get; set; } #

Website URL (URL).

public List<EmailVCardPhone> Phones { get; } #

Phone numbers (TEL).

public List<EmailVCardEmail> Emails { get; } #

Email addresses (EMAIL).

public List<EmailVCardAddress> Addresses { get; } #

Addresses (ADR).