Click or drag to resize
MimeKit

InternetAddressToString Method (FormatOptions, Boolean)

Returns a string representation of the InternetAddress, optionally encoding it for transport.

Namespace:  MimeKit
Assembly:  MimeKit (in MimeKit.dll) Version: 2.1.0.0
Syntax
C#
public abstract string ToString(
	FormatOptions options,
	bool encode
)

Parameters

options
Type: MimeKitFormatOptions
The formatting options.
encode
Type: SystemBoolean
If set to true, the InternetAddress will be encoded.

Return Value

Type: String
A string representing the InternetAddress.
Exceptions
ExceptionCondition
ArgumentNullExceptionoptions is null.
Remarks

If the encode parameter is true, then this method will return an encoded version of the internet address according to the rules described in rfc2047.

However, if the encode parameter is false, then this method will return a string suitable only for display purposes.

See Also