GroupAddressToString(FormatOptions, Boolean) Method

Return a string representation of the GroupAddress, optionally encoding it for transport.

Definition

Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public override string ToString(
	FormatOptions options,
	bool encode
)

Parameters

options  FormatOptions
The formatting options.
encode  Boolean
If set to , the GroupAddress will be encoded.

Return Value

String
A string representing the GroupAddress.

Remarks

Returns a string containing the formatted group of addresses. If the encode parameter is , then the name of the group and all member addresses will be encoded according to the rules defined in rfc2047, otherwise the names will not be encoded at all and will therefor only be suitable for display purposes.

Exceptions

ArgumentNullException options is .

See Also