summaryrefslogtreecommitdiff
path: root/slips/build/lib/castle/bin/Castle.Components.Common.EmailSender.xml
blob: 52a9a632560e0d82470f9f75a12ecf3110bf7b6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Castle.Components.Common.EmailSender</name>
    </assembly>
    <members>
        <member name="T:Castle.Components.Common.EmailSender.IEmailSender">
            <summary>
            Abstracts an approach to send e-mails
            </summary>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.IEmailSender.Send(System.String,System.String,System.String,System.String)">
            <summary>
            Sends a message. 
            </summary>
            <param name="from">From field</param>
            <param name="to">To field</param>
            <param name="subject">e-mail's subject</param>
            <param name="messageText">message's body</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.IEmailSender.Send(Castle.Components.Common.EmailSender.Message)">
            <summary>
            Sends a message. 
            </summary>
            <param name="message">Message instance</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.IEmailSender.Send(Castle.Components.Common.EmailSender.Message[])">
            <summary>
            Sends multiple messages. 
            </summary>
            <param name="messages">Array of messages</param>
        </member>
        <member name="T:Castle.Components.Common.EmailSender.Smtp.SmtpSender">
            <summary>
            Uses Smtp to send emails.
            </summary>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Smtp.SmtpSender.#ctor(System.String)">
            <summary>
            This service implementation
            requires a host name in order to work
            </summary>
            <param name="hostname">The smtp server name</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Send(System.String,System.String,System.String,System.String)">
            <summary>
            Sends a message. 
            </summary>
            <exception cref="T:System.ArgumentNullException">If any of the parameters is null</exception>
            <param name="from">From field</param>
            <param name="to">To field</param>
            <param name="subject">e-mail's subject</param>
            <param name="messageText">message's body</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Send(Castle.Components.Common.EmailSender.Message)">
            <summary>
            Sends a message. 
            </summary>
            <exception cref="T:System.ArgumentNullException">If the message is null</exception>
            <param name="message">Message instance</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Smtp.SmtpSender.CreateMailMessage(Castle.Components.Common.EmailSender.Message)">
            <summary>
            Converts a message from Castle.Components.Common.EmailSender.Message  type
            to System.Web.Mail.MailMessage
            </summary>
            <param name="message">The message to convert.</param>
            <returns>The converted message .</returns>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Smtp.SmtpSender.ConfigureSender(Castle.Components.Common.EmailSender.Message)">
            <summary>
            Configures the message or the sender
            with port information and eventual credential
            informed
            </summary>
            <param name="message">Message instance</param>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Port">
            <summary>
            Gets or sets the port used to 
            access the SMTP server
            </summary>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Hostname">
            <summary>
            Gets the hostname.
            </summary>
            <value>The hostname.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.AsyncSend">
            <summary>
            Gets or sets a value which is used to 
            configure if emails are going to be sent asyncrhonously or not.
            </summary>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Timeout">
            <summary>
            Gets or sets a value that specifies 
            the amount of time after which a synchronous Send call times out.
            </summary>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Domain">
            <summary>
            Gets or sets the domain.
            </summary>
            <value>The domain.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.UserName">
            <summary>
            Gets or sets the name of the user.
            </summary>
            <value>The name of the user.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.Password">
            <summary>
            Gets or sets the password.
            </summary>
            <value>The password.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.Smtp.SmtpSender.HasCredentials">
            <summary>
            Gets a value indicating whether credentials were informed.
            </summary>
            <value>
            <see langword="true"/> if this instance has credentials; otherwise, <see langword="false"/>.
            </value>
        </member>
        <member name="T:Castle.Components.Common.EmailSender.Format">
            <summary>
            Message formats
            </summary>
        </member>
        <member name="F:Castle.Components.Common.EmailSender.Format.Html">
            <summary>
            The body is composed of html content
            </summary>
        </member>
        <member name="F:Castle.Components.Common.EmailSender.Format.Text">
            <summary>
            The body is pure text
            </summary>
        </member>
        <member name="T:Castle.Components.Common.EmailSender.MessagePriority">
            <summary>
            Message priority
            </summary>
        </member>
        <member name="T:Castle.Components.Common.EmailSender.Message">
            <summary>
            Abstracts an e-mail message
            </summary>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Message.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Common.EmailSender.Message"/> class.
            </summary>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.Message.#ctor(System.String,System.String,System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Common.EmailSender.Message"/> class.
            </summary>
            <param name="from">From header.</param>
            <param name="to">To header.</param>
            <param name="subject">The subject header.</param>
            <param name="body">The message body.</param>
        </member>
        <member name="T:Castle.Components.Common.EmailSender.MessageAttachment">
            <summary>
            Represents a file attachment
            </summary>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.MessageAttachment.#ctor(System.String,System.String)">
            <summary>
            Creates a new attachment
            </summary>
            <param name="mediaType">Look at System.Net.Mimie.MediaTypeNames for help.</param>
            <param name="fileName">Path to the file.</param>
        </member>
        <member name="M:Castle.Components.Common.EmailSender.MessageAttachment.#ctor(System.String,System.IO.Stream)">
            <summary>
            Creates a new attachment
            </summary>
            <param name="mediaType">Look at System.Net.Mime.MediaTypeNames for help.</param>
            <param name="stream">File stream.</param>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.MessageAttachment.FileName">
            <summary>
            Gets the name of the file.
            </summary>
            <value>The name of the file.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.MessageAttachment.MediaType">
            <summary>
            Gets the type of the media.
            </summary>
            <value>The type of the media.</value>
        </member>
        <member name="P:Castle.Components.Common.EmailSender.MessageAttachment.Stream">
            <summary>
            Gets the stream.
            </summary>
            <value>The stream.</value>
        </member>
    </members>
</doc>