path: root/Emails.Transactional.Client/Emails.Transactional.Client.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Emails.Transactional.Client</name>
    </assembly>
    <members>
        <member name="T:Emails.Transactional.Client.ClientExtensions">
            <summary>
            Contains extension methods to send emails on remote transational email servers
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.ClientExtensions.SendEmailAsync(RestSharp.RestClient,Emails.Transactional.Client.EmailTransactionRequest,System.Threading.CancellationToken)">
            <summary>
            Asynchronously begins an email transaction against the mail server with the specified
            transaction request.
            </summary>
            <param name="client"></param>
            <param name="transaction">The <see cref="T:Emails.Transactional.Client.EmailTransactionRequest"/> to submit</param>
            <param name="token">A cancelaion token to cancel the operation</param>
            <returns>A task that represents the async send operation</returns>
            <exception cref="T:Emails.Transactional.Client.Exceptions.ValidationFailedException"></exception>
            <exception cref="T:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException"></exception>
            <exception cref="T:Emails.Transactional.Client.Exceptions.InvalidTransactionRequestException"></exception>
            <exception cref="T:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException"></exception>
        </member>
        <member name="T:Emails.Transactional.Client.EmailTransactionRequest">
            <summary>
            A transactional email request to send an email 
            template.
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.Endpoint">
            <summary>
            The transactional send endpoint address
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.ToAddresses">
            <summary>
            A dictionary of email addresses/names of 
            users to send this email to
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.CcAddresses">
            <summary>
            A dictionary of email addresses/names of 
            users to carbon copy this email to
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.BccAddresses">
            <summary>
            A dictionary of email addresses/names of 
            users to blind carbon copy this email to
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.Variables">
            <summary>
            A dictionary of variables to substitute into the liquid 
            email template
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.Subject">
            <summary>
            The subject of the email to send
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.TemplateId">
            <summary>
            The unique id of the email template to send 
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.FromName">
            <summary>
            The system from email name. NOTE: This is a protected value
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.EmailTransactionRequest.FromAddress">
            <summary>
            The system from email address. NOTE: This is a protected value
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.#ctor(System.String)">
            <summary>
            Creates a new email transaction with the specified email template to send
            </summary>
            <param name="templateId">The id of the template to send</param>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.#ctor(System.String,System.String,System.String)">
            <summary>
            Creates a new email transaction with the specified email template 
            and a single recipient
            </summary>
            <param name="templateId">The id of the template to send</param>
            <param name="toAddress">A singular recipient name</param>
            <param name="toName">A singlular recipient email address</param>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.AddToAddress(System.String,System.String)">
            <summary>
            Adds a recipient to the To email address dictionary
            </summary>
            <param name="toName">The name of the user to send the email to</param>
            <param name="toAddress">The unique email address of the user to add to the recipient collection</param>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.AddToAddress(System.String)">
            <summary>
            Adds a recipient to the To email address dictionary
            </summary>
            <param name="toAddress">The unique email address of the user to add to the recipient collection</param>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.AddCcAddress(System.String,System.String)">
            <summary>
            Adds a carbon copy recipient to the current cc dictionary
            </summary>
            <param name="ccName">The name of the recipient</param>
            <param name="ccAddress">The unique email address of the bcc recipient</param>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.AddBccAddress(System.String,System.String)">
            <summary>
            Adds a blind carbon copy recipient to the current bcc dictionary
            </summary>
            <param name="bccName">The name of the recipient</param>
            <param name="bccAddress">The unique email address of the bcc recipient</param>
        </member>
        <member name="M:Emails.Transactional.Client.EmailTransactionRequest.AddVariable(System.String,System.String)">
            <summary>
            Adds a liquid template variable to be subsituted by the template
            renderer.
            </summary>
            <param name="varName">The unique name of the variable to add to the collection</param>
            <param name="varValue">The value if the variable that will be substituted into the template</param>
        </member>
        <member name="T:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException">
            <summary>
            A excption raised when an Authorization error occured
            during a request
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException.#ctor">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException.#ctor(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException.#ctor(System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidAuthorizationException.#ctor(System.String,RestSharp.RestResponse{Emails.Transactional.Client.TransactionResult})">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionRequestException.#ctor">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionRequestException.#ctor(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionRequestException.#ctor(System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionRequestException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <inheritdoc/>
        </member>
        <member name="T:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException">
            <summary>
            Raised when the results of an email transaction 
            failed. Inner exceptions may be set
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException.ErrorMessage">
            <summary>
            An error message received from the client
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException.#ctor">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException.#ctor(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException.#ctor(System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException.#ctor(System.String,RestSharp.RestResponse{Emails.Transactional.Client.TransactionResult})">
            <summary>
            Initializes a new <see cref="T:Emails.Transactional.Client.Exceptions.InvalidTransactionResponseException"/> with 
            the response that contains the error
            </summary>
            <param name="message">The base exception message</param>
            <param name="response">The response that caused the error</param>
        </member>
        <member name="T:Emails.Transactional.Client.Exceptions.TransactionExceptionBase">
            <summary>
            A base exception for all client transaction excepions
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.#ctor">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.#ctor(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.#ctor(System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <inheritdoc/>
        </member>
        <member name="P:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.ErrorResponse">
            <summary>
            The response objec that caused the exception
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.Exceptions.TransactionExceptionBase.ResultMessage">
            <summary>
            The string represenation of the response body
            </summary>
        </member>
        <member name="T:Emails.Transactional.Client.Exceptions.ValidationFailedException">
            <summary>
            Raised when server message validation failed
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.ValidationFailedException.#ctor">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.ValidationFailedException.#ctor(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.ValidationFailedException.#ctor(System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.ValidationFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <inheritdoc/>
        </member>
        <member name="P:Emails.Transactional.Client.Exceptions.ValidationFailedException.ValidationErrors">
            <summary>
            A collection of validaion error messages
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.Exceptions.ValidationFailedException.#ctor(Emails.Transactional.Client.TransactionResult)">
            <summary>
            
            </summary>
            <param name="result"></param>
        </member>
        <member name="T:Emails.Transactional.Client.TransactionalEmailConfig">
            <summary>
            A global configuration object for transactional email clients
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.TransactionalEmailConfig.ServiceLocation">
            <summary>
            The server transaction endpoint location
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.TransactionalEmailConfig.TemplateIdLookup">
            <summary>
            An email id template/translation table for email template-ids
            </summary>
        </member>
        <member name="M:Emails.Transactional.Client.TransactionalEmailConfig.WithUrl(System.Uri)">
            <summary>
            Adds the mail service location to the current instance
            </summary>
            <param name="serviceLocation">The address of the remote server transaction endpoint</param>
            <returns>A referrence to the current object (fluent api)</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:Emails.Transactional.Client.TransactionalEmailConfig.WithTemplates(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
            <summary>
            Sets the template lookup table for the current instance
            </summary>
            <param name="templates">The template-id lookup table to referrence</param>
            <returns>A referrence to the current object (fluent api)</returns>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="M:Emails.Transactional.Client.TransactionalEmailConfig.GetTemplateRequest(System.String)">
            <summary>
            Gets a new <see cref="T:Emails.Transactional.Client.EmailTransactionRequest"/> from the specifed
            template name.
            </summary>
            <param name="templateName"></param>
            <returns></returns>
            <exception cref="T:System.Collections.Generic.KeyNotFoundException"></exception>
            <exception cref="T:System.ArgumentNullException"></exception>
        </member>
        <member name="T:Emails.Transactional.Client.TransactionResult">
            <summary>
            A JSON serializable object that contains the results of the transaction
            </summary>
        </member>
        <member name="T:Emails.Transactional.Client.ValidationErrorMessage">
            <summary>
            A json serializable server validaion error
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.ValidationErrorMessage.PropertyName">
            <summary>
            The name of the propery that was invalid
            </summary>
        </member>
        <member name="P:Emails.Transactional.Client.ValidationErrorMessage.ErrorMessage">
            <summary>
            The message that 
            </summary>
        </member>
    </members>
</doc>