mozilla

Revision 580267 of nsIMsgProtocolInfo

  • Revision slug: nsIMsgProtocolInfo
  • Revision title: nsIMsgProtocolInfo
  • Revision id: 580267
  • Created:
  • Creator: Oeekker
  • Is current revision? Yes
  • Comment

Revision Content

The nsIMsgProtocolInfo interface describes the capabilities of an account type.

{{ tbInterfaceStatus("nsIMsgProtocolInfo", "mailnews/base/public/nsIMsgProtocolInfo.idl", "unfrozen", "Mozilla 1.9", "yes") }}

Inherits from: {{ Interface("nsISupports") }}

Implemented by: @mozilla.org/messenger/protocol/info;1?type=acct, where acct is the account type that are you are interested in.

Method overview

long getDefaultServerPort(in boolean isSecure);

 Attributes

Attribute Type Description
canDelete boolean True if an account of this type may be deleted. Read only.
canDuplicate boolean Unused. Read only.
canGetIncomingMessages boolean True if Junk UI actions should be enabled for the account type. Read only.
canGetMessages boolean True if "Get Messages" UI actions should be enabled for the account type. Read only.
canLoginAtStartUp boolean True if the account type can perform biff during startup. Read only.
defaultDoBiff boolean True if the biff should be enabled by default for the account type. Read only.
defaultLocalFilePath {{ Interface("nsILocalFile") }} The default path under which all server data for this account type will be stored.
foldersCreateAsync boolean {{ tb_minversion_inline("24") }} (bug 832034)
preflightPrettyNameWithEmailAddress boolean Unused. Read only.
requiresUsername boolean True if the server requires a username to log on. Read only.
serverIID nsIIDPtr The IID of the server-specific interface, used during account creation. Read only.
showComposeMsgLink boolean True if Compose UI actions should be enabled for the account type. Read only.
specialFoldersDeletionAllowed boolean True if the user can delete folders like Inbox, Trash, etc. Read only.

Methods

getDefaultServerPort()

Returns the default port for a connection to a server of this account type.

long getDefaultServerPort(
  in boolean isSecure
);
Parameters
isSecure
Whether or not the connection will be secure.
Return value

The default port number for connections of this account type.

Remarks

This is one of the interfaces that is required to create a new account type.

See also

  • {{ Interface("nsIMsgIncomingServer") }}

Revision Source

<p>The <code>nsIMsgProtocolInfo</code> interface describes the capabilities of an account type.</p>
<p>{{ tbInterfaceStatus("nsIMsgProtocolInfo", "mailnews/base/public/nsIMsgProtocolInfo.idl", "unfrozen", "Mozilla 1.9", "yes") }}</p>
<p>Inherits from: {{ Interface("nsISupports") }}</p>
<p>Implemented by: <code>@mozilla.org/messenger/protocol/info;1?type=<em>acct</em></code>, where <code><em>acct</em></code> is the account type that are you are interested in.</p>
<h2 id="Method_overview" name="Method_overview">Method overview</h2>
<table class="standard-table">
 <tbody>
  <tr>
   <td><code>long <a href="/en/nsIMsgProtocolInfo#getDefaultServerPort()" title="en/nsIMsgProtocolInfo#getDefaultServerPort()"><u><span style="text-decoration: underline;">getDefaultServerPort</span></u></a>(in boolean isSecure);</code></td>
  </tr>
 </tbody>
</table>
<h2 id=".C2.A0Attributes">&nbsp;Attributes</h2>
<table class="standard-table" style="width: auto;">
 <tbody>
  <tr>
   <td class="header">Attribute</td>
   <td class="header">Type</td>
   <td class="header">Description</td>
  </tr>
  <tr>
   <td><code>canDelete</code></td>
   <td><code>boolean</code></td>
   <td>True if an account of this type may be deleted. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>canDuplicate</code></td>
   <td><code>boolean</code></td>
   <td>Unused. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>canGetIncomingMessages</code></td>
   <td><code>boolean</code></td>
   <td>True if Junk UI&nbsp;actions should be enabled for the account type. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>canGetMessages</code></td>
   <td><code>boolean</code></td>
   <td>True if "Get&nbsp;Messages" UI&nbsp;actions should be enabled for the account type. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>canLoginAtStartUp</code></td>
   <td><code>boolean</code></td>
   <td>True if the account type can perform biff during startup. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>defaultDoBiff</code></td>
   <td><code>boolean</code></td>
   <td>True if the biff should be enabled by default for the account type. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>defaultLocalFilePath</code></td>
   <td><code>{{ Interface("nsILocalFile") }}</code></td>
   <td>The default path under which all server data for this account type will be stored.</td>
  </tr>
  <tr>
   <td>foldersCreateAsync</td>
   <td><code>boolean</code></td>
   <td>{{ tb_minversion_inline("24") }} (<a href="https://bugzilla.mozilla.org/show_bug.cgi?id=832034">bug 832034</a>)</td>
  </tr>
  <tr>
   <td><code>preflightPrettyNameWithEmailAddress</code></td>
   <td><code>boolean</code></td>
   <td>Unused. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>requiresUsername</code></td>
   <td><code>boolean</code></td>
   <td>True if the server requires a username to log on. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>serverIID</code></td>
   <td><code>nsIIDPtr</code></td>
   <td>The IID of the server-specific interface, used during account creation. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>showComposeMsgLink</code></td>
   <td><code>boolean</code></td>
   <td>True if Compose UI actions should be enabled for the account type. <strong>Read only.</strong></td>
  </tr>
  <tr>
   <td><code>specialFoldersDeletionAllowed</code></td>
   <td><code>boolean</code></td>
   <td>True if the user can delete folders like Inbox, Trash, etc. <strong>Read only.</strong></td>
  </tr>
 </tbody>
</table>
<h2 id="Methods" name="Methods">Methods</h2>
<h3 id="eatCookie.28.29" name="eatCookie.28.29">getDefaultServerPort()</h3>
<p>Returns the default port for a connection to a server of this account type.</p>
<pre class="eval">
long getDefaultServerPort(
  in boolean isSecure
);
</pre>
<h6 id="Parameters" name="Parameters">Parameters</h6>
<dl>
 <dt>
  <code>isSecure</code></dt>
 <dd>
  Whether or not the connection will be secure.</dd>
</dl>
<h6 id="Return_value">Return value</h6>
<p>The default port number for connections of this account type.</p>
<h2 id="Remarks" name="Remarks">Remarks</h2>
<p>This is one of the interfaces that is required to create a new account type.</p>
<h2 id="See_also" name="See_also">See also</h2>
<ul>
 <li>{{ Interface("nsIMsgIncomingServer") }}</li>
</ul>
Revert to this revision