TeamFoundationMailService Class

A service for sending emails through SMTP.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.TeamFoundationMailService

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationRegistryService))> _
<TeamFoundationServiceDependency(GetType(IdentityService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationJobService))> _
Public Class TeamFoundationMailService _
    Implements ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(IdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationJobService))]
public class TeamFoundationMailService : ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(IdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationJobService))]
public ref class TeamFoundationMailService : ITeamFoundationService

[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))>]
[<TeamFoundationServiceDependency(typeof(IdentityService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationJobService))>]
type TeamFoundationMailService =  
    class 
        interface ITeamFoundationService 
    end

public class TeamFoundationMailService implements ITeamFoundationService

The TeamFoundationMailService type exposes the following members.

Constructors

	Name	Description
	TeamFoundationMailService

Top

Properties

	Name	Description
	AnonymousAuth	It true then mail is sent to the server anonymously.
	CertThumbprint	The thumbprint of the certificate used to authenticate against the SMTP server.
	Enabled	A flag indicating if the mail service is enabled or not. If it is enabled, all other fields are guaranteed to have been loaded from the registry.
	EnableSsl	Use Ssl when communicating to the SMTP server.
	FromAddress	The default mail address that will show up in the "From" field of sent emails (e.g. a service account).
	LastRetry	The last retry of sending failed mail requests.
	LogAllExceptions	Indicator of whether all send mail exceptions should be logged.
	LogLevel	The log level.
	MaxEmailBodySize	The maximum email body size (in bytes).
	MaxRetryAttempts	Maximum retries of sending failed mail requests.
	RetryInterval	Interval (in seconds) between retry.
	SendMailJobDelay	Delay duration (in seconds) of the send mail job.
	SmtpPassword	Password portion of the credential used to connect to the SMTP server.
	SmtpPort	The SMTP port.
	SmtpServer	The SMTP host server network address.
	SmtpUser	User credential for connecting to the SMTP server. When empty or null, integrated authorization is used.
	UseReplyTo	A flag that controls whether the "From" field is populated with the originator's email address, or the default email address (and the originator's email address is put in the reply to list).

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LoadSettings	Load the TeamFoundationMailSevice settings from the registry.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	QueueMailJob(TeamFoundationRequestContext, IEnumerable<MailMessage>)	Queue messages to be sent by the SendMailJob.
	QueueMailJob(TeamFoundationRequestContext, MailMessage)	Queue a new message to be sent by the SendMailJob.
	Send(TeamFoundationRequestContext, IEnumerable<MailMessage>)	Send multiple mail messages. If an exception is encountered, this method will not continue with sending.
	Send(TeamFoundationRequestContext, MailMessage)	Send a mail message.
	ServiceEnd	Invoked on service stop.
	ServiceStart	Invoked on service start.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateMessage	Validate the message to be sent or queued for sending.
	ValidateMessages	Validate the messages to be sent or queued for sending.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace