Xqsmapi コンポーネント

 XqsmapiCom メール送受信機能を持ったコンポーネント

メソッド

プロパティ



Initialize メソッド

Xqsmapi クラスを初期化します。

Initialize( pop3name As String, smtpname As String, username As String, password As String, mailaddr As String, fullname As String ) As long

引数

pop3name POP3サーバ名
smtpname SMTPサーバ名
username POP3 ユーザ名
password POP3 パスワード
mailaddr メールアドレス 例. masuda@sec.co.jp
fullname フルネーム 例. 稀Jr

戻り値

0 以外 成功
0 失敗

解説

xqsmapi クラスの初期化を行います。メールアドレスは、SMTP サーバの ドメイン認証で使っています。メールアドレス、フルネームは、フルネーム<メールアドレス> の形式で From フィールドとして送信されます。


SendMail メソッド

メールを送信します。

SendMail( mailfile As String, attachfile As String ) As Long

引数

mailfile 送信メールファイル
attachfile 添付ファイル

戻り値

0 以外 送信成功
0 送信失敗

解説

メールファイルを指定して送信します。
POP_BEFORE_SMTP プロパティを True にした時は、送信時に POP3 サーバ認証を行ってから送信します。
送信に失敗した場合は、ErrNumber あるいは ErrDiscription を参照してください。

送信ファイルの形式は、
X-Mailer: xqsmail.mac ver.0.9.9 / xqsmapi.dll ver.1.0.0
Subject: 
To: 
Cc: 
Bcc: 
---
増田 です。

-- 
*--*--*--*--*--*--*--*--*--*--*--*--*
 増田@セック
 mailto:masuda@sec.co.jp
*--*--*--*--*--*--*--*--*--*--*--*--*
のように、Subject, To, Cc, Bcc, X-Mailer フィールドをヘッダ部に書きます。このヘッダ部と本文の区切りは、空白行あるいは"-"(半角のマイナス)で始まるになります。本文の終わりはファイルの終わりになります。

添付ファイルをつけて送信するときは、
X-Mailer: xqsmail.mac ver.0.9.9 / xqsmapi.dll ver.1.0.0
X-AttachmentFile: C:\WINNT\Profiles\09512.000\デスクトップ\コーディング規約.doc
Subject: 
To: 
Cc: 
Bcc: 
---
増田 です。

-- 
*--*--*--*--*--*--*--*--*--*--*--*--*
 増田@セック
 mailto:masuda@sec.co.jp
*--*--*--*--*--*--*--*--*--*--*--*--*
のように、X-AttachmentFile フィールドで指定します。(送信時にこのフィールドは削除されて送信されます)

また、送信ファイルのメモ機能として、
X-Mailer: xqsmail.mac ver.0.9.9 / xqsmapi.dll ver.1.0.0
X-xqs-Account: 2 SMTP:sun08 稀Jr 
Subject: 
To: 
Cc: 
Bcc: 
---
増田 です。

-- 
*--*--*--*--*--*--*--*--*--*--*--*--*
 増田@セック
 mailto:masuda@sec.co.jp
*--*--*--*--*--*--*--*--*--*--*--*--*
のように先頭が X-xqs- のフィールドを付加することができます。これは送信時に削除されるので、メールファイルとプログラムとの連携に使うことができます。


RecvMailAll メソッド

すべてのメールを受信します。

RecvMailAll( listfile As String, maildir As String, dupfile As String, mailbox As String ) As Long

引数

listfile 受信したリストファイル
maildir 受信フォルダ名
dupfile 重複チェックファイル
mailbox 一括受信ファイル

戻り値

0 受信メール無し
1 以上 受信メール数
-1 以下 エラー発生

解説

すべてのメールを受信します。受信中には経過ダイアログを表示しキャンセルボタンを押下することによって中止が可能です。
受信メールはデフォルトで SJIS に変換し、From, Subject, Cc に日本語がある場合はエンコードされます。
一括受信ファイルを指定した場合、このファイルに受信したメールを追加していきます。


SendMailDummy メソッド

送信テスト用のメソッドです。

SendMailDummy( mailfile As String, attachfile As String, dummyfile As String ) As Long

引数

mailfile 送信メールファイル
attachfile 添付ファイル
dummyfile SMTP 送信メールファイル

戻り値

0 以外 送信成功
0 送信失敗

解説

メールファイルを指定して送信テストを行います。内部動作は SendMail と全く同じです。ただし、実際に SMTP サーバに送信する代わりに dummyfile に送信ファイルを書き出します。


RecvMailDummy メソッド

受信テスト用のメソッドです。

RecvMailDummy( mailfile As String, dummyfile As String ) As Long

引数

mailfile 受信テスト用のファイル
dummyfile エンコード済みのファイル

戻り値

0 受信メール無し
1 以上 受信メール数
-1 以下 エラー発生

解説

メールファイルを指定して受信テストを行います。内部動作は RecvMailAll と全く同じです。ただし、実際に POP3 サーバから受信する代わりに、受信テスト用ファイルを渡し、エンコードされたファイルを取り出します。主にテスト用に使います。


MailBiff メソッド

POP3 サーバの受信チェックをします。

MailBiff( ) As Long

引数

なし

戻り値

0 受信メール無し
1 以上 受信メール数

解説

POP サーバの受信チェックをします。サーバに残っているメールの数を返します。ただし、重複チェックをしていないので、サーバにメールを残す(DELE プロパティ参照)場合でも新着数を返します。


DialogAttach メソッド

添付ファイル取り出しのダイアログを開きます。

DialogAttach( filename as String ) as Long

引数

filename メールファイル

戻り値

1 成功
0 失敗

解説

受信したメールファイル(wmlファイル)を指定して、添付ファイルの取り出し用ダイアログを開きます。ダイアログのリストから、添付ファイル名を指定して保存します。


Version プロパティ

Xqsmapi クラスのバージョンを返します

Version As long

引数

なし

戻り値

バージョン番号

解説

Xqsmapi クラスのバージョンを返します。ver.1.0 の場合は 0x100 で返します。


ErrDiscription プロパティ

エラー時の文字列を返します。

ErrDiscription As String

引数

なし

戻り値

エラー文字列

解説

Xqsmapi クラス内でエラーが発生した時に、文字列を返します。


ErrNumber プロパティ

エラー時の番号を返します。

ErrNumber As Long

引数

なし

戻り値

エラー番号

解説

Xqsmapi クラス内でエラーが発生した時に、番号を返します。


hWndParent プロパティ

親ウィンドウハンドルを設定/取得します。

hWndParent As Long

引数

親ウィンドウハンドル

戻り値

親ウィンドウハンドル

解説

親ウィンドウハンドルの設定/取得を行います。経過ダイアログや添付ファイル取り出しダイアログの親ウィンドウを指定できます。


POP_BEFORE_SMTP プロパティ

POP3 Before SMTP を設定/取得します。

POP_BEFORE_SMTP As Long

引数

0 送信時に POP認証を行わない(デフォルト)
1 送信時に POP認証を行う

戻り値

現状の POP Before SMTP

解説

メール送信時に POP認証(POP3 Before SMTP)を行うか行わないかを設定します。


POP_DELE プロパティ

受信時のPOP3サーバからメールを削除するかどうかを設定/取得します。

POP_DELE As Long

引数

0 受信時にサーバからメールを削除しない(デフォルト)
1 受信時にサーバからメールを削除する

戻り値

現在の設定

解説

メール受信時にサーバからメールを削除するかどうかを設定します。


POP_ExecuteType プロパティ

受信時の経過ダイアログのタイプを設定/取得します。

POP_ExecuteType As Long

引数

0 デフォルトの経過ダイアログを使う
1 大きめの経過ダイアログ
2 プログレスバー付きのダイアログ

戻り値

現在の設定

解説

受信時の経過ダイアログのタイプを設定します。0 を指定すると最新のダイアログが選択されます。


POP_SILENT プロパティ

受信時の経過ダイアログを表示するかどうかを設定/取得します。

POP_SILENT As Long

引数

0 経過ダイアログを表示しない(デフォルト)
1 経過ダイアログを表示する

戻り値

現在の設定

解説

受信時に経過ダイアログを表示するかどうか設定します。


APOP プロパティ

受信時に APOP 認証をつかうかどうかを設定/取得します。

APOP As Long

引数

0 APOP 認証を使わない(デフォルト)
1 APOP 認証を使う

戻り値

現在の設定

解説

受信時に APOP 認証を使うかどうかを設定/取得します。